From b2d693451a30afdb92d860b42fece26ca4078459 Mon Sep 17 00:00:00 2001 From: Nick Sweeting Date: Fri, 23 Apr 2021 17:50:14 -0400 Subject: [PATCH] simplify quickstart instructions --- README.md | 132 +++++++++++++++++++++--------------------------------- 1 file changed, 52 insertions(+), 80 deletions(-) diff --git a/README.md b/README.md index 227803bd..8f1f380e 100644 --- a/README.md +++ b/README.md @@ -116,61 +116,42 @@ ls ./archive/*/index.json # or browse directly via the filesyste
Get ArchiveBox with docker-compose on macOS/Linux/Windows ✨ (highly recommended) -First make sure you have [Docker](https://docs.docker.com/get-docker/) and [Docker Compose](https://docs.docker.com/compose/install/#install-using-pip) installed on your system. +First make sure you have Docker and Docker Compose installed on your system. -Download the [`docker-compose.yml`](https://raw.githubusercontent.com/ArchiveBox/ArchiveBox/master/docker-compose.yml) file into a new empty directory. -

-curl -O 'https://raw.githubusercontent.com/ArchiveBox/ArchiveBox/master/docker-compose.yml'
+Download the docker-compose.yml file into a new empty directory.
+
curl -O 'https://raw.githubusercontent.com/ArchiveBox/ArchiveBox/master/docker-compose.yml'
 

 
-Start the server.
-

-docker-compose run archivebox init --setup
+Start the web UI server (optional).
+
docker-compose run archivebox init --setup
 docker-compose up
 

 
-Open [`http://127.0.0.1:8000`](http://127.0.0.1:8000).
+Open http://127.0.0.1:8000.
 
-

-# you can also add links and manage your archive via the CLI:
-docker-compose run archivebox add 'https://example.com'
-echo 'https://example.com' | docker-compose run archivebox -T add
-docker-compose run archivebox status
-docker-compose run archivebox help  # to see more options
-
-# when passing stdin/stdout via the cli, use the -T flag
-echo 'https://example.com' | docker-compose run -T archivebox add
-docker-compose run -T archivebox list --html --with-headers > index.html
-

+See below for more usage examples using the CLI, Web UI, and filesystem/SQL/Python to add URLs and manage your archive.
 
 This is the recommended way to run ArchiveBox because it includes all the extractors like:

-chrome, wget, youtube-dl, git, etc., full-text search w/ sonic, and many other great features.
-
+chrome, wget, youtube-dl, git, etc., full-text search w/ sonic, and provides the easiest way to keep those dependencies up-to-date and securely isolated from the rest of your system.
+
Get ArchiveBox with docker on macOS/Linux/Windows -First make sure you have [Docker](https://docs.docker.com/get-docker/) installed on your system. +First make sure you have Docker installed on your system. -

-# create a new empty directory and initalize your collection (can be anywhere)
+
# create a new empty directory and initalize your collection (can be anywhere)
 mkdir ~/archivebox && cd ~/archivebox
 docker run -v $PWD:/data -it archivebox/archivebox init --setup
-
-# start the webserver and open the UI (optional)
-docker run -v $PWD:/data -p 8000:8000 archivebox/archivebox server 0.0.0.0:8000
-open http://127.0.0.1:8000
-
-# you can also add links and manage your archive via the CLI:
-docker run -v $PWD:/data -it archivebox/archivebox add 'https://example.com'
-docker run -v $PWD:/data -it archivebox/archivebox status
-docker run -v $PWD:/data -it archivebox/archivebox help  # to see more options
-
-# when passing stdin/stdout via the cli, use only -i (not -it)
-echo 'https://example.com' | docker run -v $PWD:/data -i archivebox/archivebox add
-docker run -v $PWD:/data -i archivebox/archivebox list --html --with-headers > index.html
 

+Start the server.
+
docker run -v $PWD:/data -p 8000:8000 archivebox/archivebox
+

+
+Open http://127.0.0.1:8000.
+
+See below for more usage examples using the CLI, Web UI, and filesystem/SQL/Python to add URLs and manage your archive.
@@ -193,19 +174,16 @@ sudo apt install archivebox # create a new empty directory and initalize your collection (can be anywhere) mkdir ~/archivebox && cd ~/archivebox archivebox init --setup - -# start the webserver and open the web UI (optional) -archivebox server 0.0.0.0:8000 -open http://127.0.0.1:8000 - -# you can also add URLs and manage the archive via the CLI and filesystem: -archivebox add 'https://example.com' -archivebox status -archivebox list --html --with-headers > index.html -archivebox list --json --with-headers > index.json -archivebox help # to see more options +Start the web UI server (optional). +
archivebox server
+
+ +Open http://127.0.0.1:8000. + +See below for more usage examples using the CLI, Web UI, and filesystem/SQL/Python to add URLs and manage your archive. + ♰ On other Ubuntu/Debian-based systems add these sources directly to /etc/apt/sources.list: 

@@ -214,8 +192,6 @@ echo "deb-src http://ppa.launchpad.net/archivebox/archivebox/ubuntu focal main"
 sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys C258F79DCC02E369
 sudo apt update
 sudo apt install archivebox
-archivebox setup
-archivebox --version
 # then scroll back up and continue the initalization instructions above
@@ -226,7 +202,7 @@ archivebox --version
Get ArchiveBox with brew on macOS -First make sure you have Homebrew installed: https://brew.sh/#install +First make sure you have Homebrew installed on your system. 

 # install the archivebox package using homebrew
@@ -235,19 +211,16 @@ brew install archivebox/archivebox/archivebox
 # create a new empty directory and initalize your collection (can be anywhere)
 mkdir ~/archivebox && cd ~/archivebox
 archivebox init --setup
-
-# start the webserver and open the web UI (optional)
-archivebox server 0.0.0.0:8000
-open http://127.0.0.1:8000
-
-# you can also add URLs and manage the archive via the CLI and filesystem:
-archivebox add 'https://example.com'
-archivebox status
-archivebox list --html --with-headers > index.html
-archivebox list --json --with-headers > index.json
-archivebox help  # to see more options
+Start the web UI server (optional). +
archivebox server 0.0.0.0:8000
+
+ +Open http://127.0.0.1:8000. + +See below for more usage examples using the CLI, Web UI, and filesystem/SQL/Python to add URLs and manage your archive. +
@@ -263,19 +236,16 @@ pip3 install archivebox mkdir ~/archivebox && cd ~/archivebox archivebox init --setup # Install any missing extras like wget/git/ripgrep/etc. manually as needed - -# start the webserver and open the web UI (optional) -archivebox server 0.0.0.0:8000 -open http://127.0.0.1:8000 - -# you can also add URLs and manage the archive via the CLI and filesystem: -archivebox add 'https://example.com' -archivebox status -archivebox list --html --with-headers > index.html -archivebox list --json --with-headers > index.json -archivebox help # to see more options +Start the web UI server (optional). +
archivebox server 0.0.0.0:8000
+
+ +Open http://127.0.0.1:8000. + +See below for more usage examples using the CLI, Web UI, and filesystem/SQL/Python to add URLs and manage your archive. +
@@ -318,6 +288,9 @@ For more discussion on managed and paid hosting options see here: