From 04b2413f7867abeae3ac8644881cfe13ba31d2dc Mon Sep 17 00:00:00 2001 From: Nick Sweeting Date: Fri, 23 Apr 2021 18:10:49 -0400 Subject: [PATCH] spacing --- README.md | 71 ++++++++++++++++++++++++------------------------------- 1 file changed, 31 insertions(+), 40 deletions(-) diff --git a/README.md b/README.md index cd989862..a830197d 100644 --- a/README.md +++ b/README.md @@ -111,13 +111,15 @@ 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. +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. + +
*(click to expand your preferred **► `distribution`** below for full setup instructions)*
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. @@ -133,12 +135,12 @@ docker-compose up 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. -
+

Get ArchiveBox with docker on macOS/Linux/Windows - +
First make sure you have Docker installed on your system. 
# create a new empty directory and initalize your collection (can be anywhere)
@@ -153,28 +155,32 @@ Start the web UI server (optional).
 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.
-
+
Get ArchiveBox with apt on Ubuntu/Debian +
-This method should work on all Ubuntu/Debian based systems, including x86, amd64, arm7, and arm8 CPUs (e.g. Raspberry Pis >=3). - -If you're on Ubuntu >= 20.04, add the `apt` repository with `add-apt-repository`: -(on other Ubuntu/Debian-based systems follow the ♰ instructions below) - -

-# add the repo to your sources and install the archivebox package using apt
+On Ubuntu >= 20.04:
+
# add the apt sources using automatically
 sudo apt install software-properties-common
 sudo add-apt-repository -u ppa:archivebox/archivebox
-sudo apt install archivebox
 

 
-

+On Ubuntu <= 19.10, Debian >= 10, or other Debian-based systems:
+
# add the apt sources manually
+echo "deb http://ppa.launchpad.net/archivebox/archivebox/ubuntu focal main" > /etc/apt/sources.list.d/archivebox.list
+sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys C258F79DCC02E369
+sudo apt update
+

+
+
# install the archivebox package using apt
+sudo apt install archivebox
+
 # create a new empty directory and initalize your collection (can be anywhere)
 mkdir ~/archivebox && cd ~/archivebox
-archivebox init --setup
+archivebox init --setup           # if any problems, install with pip instead
 

 
 Start the web UI server (optional).
@@ -184,34 +190,20 @@ Start the web UI server (optional).
 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.
-
-♰ On other Ubuntu/Debian-based systems add these sources directly to /etc/apt/sources.list:
-
-

-echo "deb http://ppa.launchpad.net/archivebox/archivebox/ubuntu focal main" > /etc/apt/sources.list.d/archivebox.list
-echo "deb-src http://ppa.launchpad.net/archivebox/archivebox/ubuntu focal main" >> /etc/apt/sources.list.d/archivebox.list
-sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys C258F79DCC02E369
-sudo apt update
-sudo apt install archivebox
-# then scroll back up and continue the initalization instructions above
-

-
-(you may need to install some other dependencies manually however)
-
+
Get ArchiveBox with brew on macOS - +
First make sure you have Homebrew installed on your system. -

-# install the archivebox package using homebrew
+
# install the archivebox package using homebrew
 brew install archivebox/archivebox/archivebox
 
 # create a new empty directory and initalize your collection (can be anywhere)
 mkdir ~/archivebox && cd ~/archivebox
-archivebox init --setup
+archivebox init --setup         # if any problems, install with pip instead
 

 
 Start the web UI server (optional).
@@ -221,16 +213,15 @@ Start the web UI server (optional).
 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.
-
+
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](https://realpython.com/installing-python/) and [Node >= v12](https://nodejs.org/en/download/package-manager/) installed. - -

-# install the archivebox package using pip3
+
# install the archivebox package using pip3
 pip3 install archivebox
 
 # create a new empty directory and initalize your collection (can be anywhere)
@@ -246,7 +237,7 @@ Start the web UI server (optional).
 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.
-
+
@@ -279,7 +270,7 @@ For more discussion on managed and paid hosting options see here: