forks/archivebox
1
0
Fork 0
Code Releases Activity

simpler server instructions

Browse source
This commit is contained in:
Nick Sweeting 2021-04-23 18:18:24 -04:00
parent 04b2413f78
commit 8839877e8b
1 changed files with 11 additions and 23 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

34
README.md
View file

@ -127,13 +127,11 @@ Download the <a href="https://raw.githubusercontent.com/ArchiveBox/ArchiveBox/ma
docker-compose run archivebox init --setup docker-compose run archivebox init --setup
</code></pre> </code></pre>
Start the web UI server (optional). Optional: Start the server and open the web UI <a href="http://127.0.0.1:8000">http://127.0.0.1:8000</a>.
<pre lang="bash"><code style="white-space: pre-line"> <pre lang="bash"><code style="white-space: pre-line">
docker-compose up docker-compose up
</code></pre> </code></pre>
Then open <a href="http://127.0.0.1:8000">http://127.0.0.1:8000</a> to start using it.
See <a href="#%EF%B8%8F-cli-usage">below</a> for more usage examples using the CLI, Web UI, and filesystem/SQL/Python to add URLs and manage your archive. See <a href="#%EF%B8%8F-cli-usage">below</a> for more usage examples using the CLI, Web UI, and filesystem/SQL/Python to add URLs and manage your archive.
<br/><br/> <br/><br/>
</details> </details>
@ -148,12 +146,10 @@ mkdir ~/archivebox && cd ~/archivebox
docker run -v $PWD:/data -it archivebox/archivebox init --setup docker run -v $PWD:/data -it archivebox/archivebox init --setup
</code></pre> </code></pre>
Start the web UI server (optional). Optional: Start the server and open the web UI <a href="http://127.0.0.1:8000">http://127.0.0.1:8000</a>.
<pre lang="bash"><code style="white-space: pre-line">docker run -v $PWD:/data -p 8000:8000 archivebox/archivebox <pre lang="bash"><code style="white-space: pre-line">docker run -v $PWD:/data -p 8000:8000 archivebox/archivebox
</code></pre> </code></pre>
Then open <a href="http://127.0.0.1:8000">http://127.0.0.1:8000</a> to start using it.
See <a href="#%EF%B8%8F-cli-usage">below</a> for more usage examples using the CLI, Web UI, and filesystem/SQL/Python to add URLs and manage your archive. See <a href="#%EF%B8%8F-cli-usage">below</a> for more usage examples using the CLI, Web UI, and filesystem/SQL/Python to add URLs and manage your archive.
<br/><br/> <br/><br/>
</details> </details>
@ -162,33 +158,29 @@ See <a href="#%EF%B8%8F-cli-usage">below</a> for more usage examples using the C
<summary><b>Get ArchiveBox with <code>apt</code> on Ubuntu/Debian</b></summary> <summary><b>Get ArchiveBox with <code>apt</code> on Ubuntu/Debian</b></summary>
<br/> <br/>
<b>On Ubuntu >= 20.04:</b> <b>On Ubuntu >= 20.04</b>, add the <code>apt</code> sources automatically:
<pre lang="bash"><code style="white-space: pre-line"># add the apt sources using automatically <pre lang="bash"><code style="white-space: pre-line">sudo apt install software-properties-common
sudo apt install software-properties-common
sudo add-apt-repository -u ppa:archivebox/archivebox sudo add-apt-repository -u ppa:archivebox/archivebox
</code></pre> </code></pre>
<b>On Ubuntu <= 19.10, Debian >= 10, or other Debian-based systems:</b> <b>On Ubuntu <= 19.10, or other Debian-style systems</b> add the <code>apt</code> sources manually:
<pre lang="bash"><code style="white-space: pre-line"># add the apt sources manually <pre lang="bash"><code style="white-space: pre-line">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" > /etc/apt/sources.list.d/archivebox.list
sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys C258F79DCC02E369 sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys C258F79DCC02E369
sudo apt update sudo apt update
</code></pre> </code></pre>
<pre lang="bash"><code style="white-space: pre-line"># install the archivebox package using apt <b>Then install the <code>apt</code> package and continue the setup:</b>
sudo apt install archivebox <pre lang="bash"><code style="white-space: pre-line">sudo apt install archivebox
# 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 mkdir ~/archivebox && cd ~/archivebox
archivebox init --setup # if any problems, install with pip instead archivebox init --setup # if any problems, install with pip instead
</code></pre> </code></pre>
Start the web UI server (optional). Optional: Start the server and open the web UI <a href="http://127.0.0.1:8000">http://127.0.0.1:8000</a>.
<pre lang="bash"><code style="white-space: pre-line">archivebox server <pre lang="bash"><code style="white-space: pre-line">archivebox server
</code></pre> </code></pre>
Then open <a href="http://127.0.0.1:8000">http://127.0.0.1:8000</a> to start using it.
See <a href="#%EF%B8%8F-cli-usage">below</a> for more usage examples using the CLI, Web UI, and filesystem/SQL/Python to add URLs and manage your archive. See <a href="#%EF%B8%8F-cli-usage">below</a> for more usage examples using the CLI, Web UI, and filesystem/SQL/Python to add URLs and manage your archive.
<br/><br/> <br/><br/>
</details> </details>
@ -206,12 +198,10 @@ mkdir ~/archivebox && cd ~/archivebox
archivebox init --setup # if any problems, install with pip instead archivebox init --setup # if any problems, install with pip instead
</code></pre> </code></pre>
Start the web UI server (optional). Optional: Start the server and open the web UI <a href="http://127.0.0.1:8000">http://127.0.0.1:8000</a>.
<pre lang="bash"><code style="white-space: pre-line">archivebox server 0.0.0.0:8000 <pre lang="bash"><code style="white-space: pre-line">archivebox server 0.0.0.0:8000
</code></pre> </code></pre>
Then open <a href="http://127.0.0.1:8000">http://127.0.0.1:8000</a> to start using it.
See <a href="#%EF%B8%8F-cli-usage">below</a> for more usage examples using the CLI, Web UI, and filesystem/SQL/Python to add URLs and manage your archive. See <a href="#%EF%B8%8F-cli-usage">below</a> for more usage examples using the CLI, Web UI, and filesystem/SQL/Python to add URLs and manage your archive.
<br/><br/> <br/><br/>
</details> </details>
@ -230,12 +220,10 @@ archivebox init --setup
# Install any missing extras like wget/git/ripgrep/etc. manually as needed # Install any missing extras like wget/git/ripgrep/etc. manually as needed
</code></pre> </code></pre>
Start the web UI server (optional). Optional: Start the server and open the web UI <a href="http://127.0.0.1:8000">http://127.0.0.1:8000</a>.
<pre lang="bash"><code style="white-space: pre-line">archivebox server 0.0.0.0:8000 <pre lang="bash"><code style="white-space: pre-line">archivebox server 0.0.0.0:8000
</code></pre> </code></pre>
Then open <a href="http://127.0.0.1:8000">http://127.0.0.1:8000</a> to start using it.
See <a href="#%EF%B8%8F-cli-usage">below</a> for more usage examples using the CLI, Web UI, and filesystem/SQL/Python to add URLs and manage your archive. See <a href="#%EF%B8%8F-cli-usage">below</a> for more usage examples using the CLI, Web UI, and filesystem/SQL/Python to add URLs and manage your archive.
<br/><br/> <br/><br/>
</details> </details>