From 0e1f61eebc0b4692c0db94a549a3da9f85ba5559 Mon Sep 17 00:00:00 2001 From: Nick Sweeting Date: Fri, 23 Apr 2021 18:49:24 -0400 Subject: [PATCH] note server is completely optional --- README.md | 21 +++++++++++++-------- 1 file changed, 13 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 5fc5dfa9..9e8a3dc4 100644 --- a/README.md +++ b/README.md @@ -122,13 +122,14 @@ ls ./archive/*/index.json # or browse directly via the filesyste
  1. Install Docker and Docker Compose on your system (if not already installed).
    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'
+
  3. Download the docker-compose.yml file into a new empty directory (can be anywhere).
+
    mkdir ~/archivebox && cd ~/archivebox
+curl -O 'https://raw.githubusercontent.com/ArchiveBox/ArchiveBox/master/docker-compose.yml'
 
    4. 
 
  4. Run the initial setup and create an admin user.
 
    docker-compose run archivebox init --setup
 
    5. 
-
  5. Optional: start the server web then open login to adminUI http://127.0.0.1:8000.
+
  6. Optional: start the server web then login to the http://127.0.0.1:8000 ⇢ Admin UI.
 
    
 docker-compose up
 
    7. 
@@ -148,7 +149,7 @@ See below for more usage examples using the C
 docker run -v $PWD:/data -it archivebox/archivebox init --setup
    7. -
  7. Optional: Start the web server then login to the http://127.0.0.1:8000 ➡ Admin UI. +
  8. Optional: Start the web server then login to the http://127.0.0.1:8000 ⇢ Admin UI. 
    docker run -v $PWD:/data -p 8000:8000 archivebox/archivebox
    9. @@ -183,9 +184,11 @@ sudo apt update archivebox init --setup # if any problems, install with pip instead -
  9. Optional: Start the web server then login to the http://127.0.0.1:8000 ➡ Admin UI. +
  10. Optional: Start the web server then login to the http://127.0.0.1:8000 ⇢ Admin UI. 
    archivebox server 0.0.0.0:8000
-
    11. +# completely optional, the CLI can also be used without running a server + +
See below for more usage examples using the CLI, Web UI, or filesystem/SQL/Python manage your archive. @@ -206,8 +209,9 @@ See below for more usage examples using the C archivebox init --setup # if any problems, install with pip instead -
  • Optional: Start the web server then login to the http://127.0.0.1:8000 ➡ Admin UI. +
  • Optional: Start the web server then login to the http://127.0.0.1:8000 ⇢ Admin UI. 
    archivebox server 0.0.0.0:8000
+# completely optional, the CLI can also be used without running a server
    • @@ -230,8 +234,9 @@ See below for more usage examples using the C archivebox init --setup # install any missing extras like wget/ripgrep/etc. manually -
  • Optional: Start the web server then login to the http://127.0.0.1:8000 ➡ Admin UI. +
  • Optional: Start the web server then login to the http://127.0.0.1:8000 ⇢ Admin UI. 
    archivebox server 0.0.0.0:8000
+# completely optional, the CLI can also be used without running a server