diff --git a/README.md b/README.md index 3fa90b5e..f1adfe3f 100644 --- a/README.md +++ b/README.md @@ -111,7 +111,7 @@ ls ./archive/*/index.json # or browse directly via the filesyste #### ⬇️  Initial Setup -Docker Compose is the recommended way to run ArchiveBox because it includes all the extractor dependencies and full-text search out-of-the-box, and it's the easiest way to keep those dependencies up-to-date and securely isolated from the rest of your system. +docker-compose is the recommended way to run ArchiveBox because it includes all the extractor dependencies + full-text search out-of-the-box, and it's the easiest way to keep those dependencies up-to-date and securely isolated from the rest of your system.
@@ -120,17 +120,20 @@ Docker Compose is the recommended way to run ArchiveBox because it includes a
Get ArchiveBox with docker-compose on macOS/Linux/Windows ✨ (highly recommended)
-First make sure you have Docker and Docker Compose installed on your system. - -Download the docker-compose.yml file into a new empty directory and run the initial setup. +
    +
  1. First make sure you have Docker and Docker Compose installed on your system.
    2. +
  2. Download the docker-compose.yml file into a new empty directory somewhere. 
    curl -O 'https://raw.githubusercontent.com/ArchiveBox/ArchiveBox/master/docker-compose.yml'
 docker-compose run archivebox init --setup
-
    - -Optional: Start the server and open the web UI http://127.0.0.1:8000. +
    3. +
  3. Run the initial setup. +
    docker-compose run archivebox init --setup
+
    4. +
  4. Optional: Start the server then open the web UI http://127.0.0.1:8000. 
    
 docker-compose up
-
    +
    5. +
See below for more usage examples using the CLI, Web UI, and filesystem/SQL/Python to add URLs and manage your archive.

@@ -146,7 +149,7 @@ mkdir ~/archivebox && cd ~/archivebox docker run -v $PWD:/data -it archivebox/archivebox init --setup -Optional: Start the server and open the web UI http://127.0.0.1:8000. +Optional: Start the server then open the web UI http://127.0.0.1:8000. 
docker run -v $PWD:/data -p 8000:8000 archivebox/archivebox
@@ -164,7 +167,7 @@ sudo add-apt-repository -u ppa:archivebox/archivebox On Ubuntu <= 19.10, or other Debian-style systems add the apt sources manually: -
echo "deb http://ppa.launchpad.net/archivebox/archivebox/ubuntu focal main" | sudo tee -a /etc/apt/sources.list.d/archivebox.list
+
echo "deb http://ppa.launchpad.net/archivebox/archivebox/ubuntu focal main" | sudo tee /etc/apt/sources.list.d/archivebox.list
 sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys C258F79DCC02E369
 sudo apt update
 

@@ -177,8 +180,8 @@ mkdir ~/archivebox && cd ~/archivebox
 archivebox init --setup           # if any problems, install with pip instead
-Optional: Start the server and open the web UI http://127.0.0.1:8000. -
archivebox server
+Optional: Start the server then open the web UI http://127.0.0.1:8000.
+
archivebox server 0.0.0.0:8000
 

 
 See below for more usage examples using the CLI, Web UI, and filesystem/SQL/Python to add URLs and manage your archive.
@@ -198,7 +201,7 @@ mkdir ~/archivebox && cd ~/archivebox
 archivebox init --setup         # if any problems, install with pip instead
-Optional: Start the server and open the web UI http://127.0.0.1:8000. +Optional: Start the server then open the web UI http://127.0.0.1:8000. 
archivebox server 0.0.0.0:8000
@@ -209,7 +212,7 @@ See below for more usage examples using the C
Get ArchiveBox with pip on any other platforms (some extras must be installed manually)
-First make sure you have [Python >= v3.7](https://realpython.com/installing-python/) and [Node >= v14](https://nodejs.org/en/download/package-manager/) installed. +First make sure you have Python >= v3.7 and Node >= v14 installed. 
# install the archivebox package using pip3
 pip3 install archivebox
@@ -220,7 +223,7 @@ archivebox init --setup
 # Install any missing extras like wget/git/ripgrep/etc. manually as needed
-Optional: Start the server and open the web UI http://127.0.0.1:8000. +Optional: Start the server then open the web UI http://127.0.0.1:8000. 
archivebox server 0.0.0.0:8000
@@ -283,11 +286,8 @@ archivebox add < ~/Downloads/bookmarks.html ```bash archivebox manage createsuperuser -archivebox server 0.0.0.0:8000 -``` -Then open http://127.0.0.1:8000 to view the UI. +archivebox server 0.0.0.0:8000 # open http://127.0.0.1:8000 to view it -```bash # you can also configure whether or not login is required for most features archivebox config --set PUBLIC_INDEX=False archivebox config --set PUBLIC_SNAPSHOTS=False