From 2e2a07b649a8377437ec9cd35c7cacb28a3f3bd6 Mon Sep 17 00:00:00 2001 From: Nick Sweeting Date: Fri, 23 Apr 2021 17:55:20 -0400 Subject: [PATCH] tweak styling --- README.md | 35 +++++++++++++++++++---------------- 1 file changed, 19 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 8f1f380e..cd989862 100644 --- a/README.md +++ b/README.md @@ -111,6 +111,8 @@ ls ./archive/*/index.json # or browse directly via the filesyste #### ⬇️  Initial Setup +Docker Compose is 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. + *(click to expand your preferred **► `distribution`** below for full setup instructions)*
@@ -118,21 +120,19 @@ ls ./archive/*/index.json # or browse directly via the filesyste First make sure you have Docker and Docker Compose installed on your system. -Download the docker-compose.yml file into a new empty directory. +Download the docker-compose.yml file into a new empty directory and run the initial setup. 
curl -O 'https://raw.githubusercontent.com/ArchiveBox/ArchiveBox/master/docker-compose.yml'
+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.
+Then open http://127.0.0.1:8000 to start using it.
 
-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 provides the easiest way to keep those dependencies up-to-date and securely isolated from the rest of your system.
+See below for more usage examples using the CLI, Web UI, and filesystem/SQL/Python to add URLs and manage your archive.
@@ -145,13 +145,14 @@ chrome, wget, youtube-dl, git, etc., full-text search w/ sonic, and provides the mkdir ~/archivebox && cd ~/archivebox docker run -v $PWD:/data -it archivebox/archivebox init --setup -Start the server. + +Start the web UI server (optional). 
docker run -v $PWD:/data -p 8000:8000 archivebox/archivebox
-Open http://127.0.0.1:8000. +Then open http://127.0.0.1:8000 to start using it. -See below for more usage examples using the CLI, Web UI, and filesystem/SQL/Python to add URLs and manage your archive. +See below for more usage examples using the CLI, Web UI, and filesystem/SQL/Python to add URLs and manage your archive. @@ -180,9 +181,9 @@ Start the web UI server (optional). 
archivebox server
-Open http://127.0.0.1:8000. +Then open http://127.0.0.1:8000 to start using it. -See below for more usage examples using the CLI, Web UI, and filesystem/SQL/Python to add URLs and manage your archive. +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: @@ -217,9 +218,9 @@ Start the web UI server (optional). 
archivebox server 0.0.0.0:8000
-Open http://127.0.0.1:8000. +Then open http://127.0.0.1:8000 to start using it. -See below for more usage examples using the CLI, Web UI, and filesystem/SQL/Python to add URLs and manage your archive. +See below for more usage examples using the CLI, Web UI, and filesystem/SQL/Python to add URLs and manage your archive. @@ -242,9 +243,9 @@ Start the web UI server (optional). 
archivebox server 0.0.0.0:8000
-Open http://127.0.0.1:8000. +Then open http://127.0.0.1:8000 to start using it. -See below for more usage examples using the CLI, Web UI, and filesystem/SQL/Python to add URLs and manage your archive. +See below for more usage examples using the CLI, Web UI, and filesystem/SQL/Python to add URLs and manage your archive. @@ -278,6 +279,8 @@ For more discussion on managed and paid hosting options see here: