mirrors/ArchiveBox
1
0
Fork 0
mirror of https://github.com/ArchiveBox/ArchiveBox.git synced 2025-05-14 07:04:27 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source
This commit is contained in:
Nick Sweeting 2024-01-23 18:29:41 -08:00 • committed by GitHub
parent 2cddb61877
commit e193e48aff
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 5 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -437,12 +437,13 @@ cd ~/archivebox/data # IMPORTANT: cd into the directory
archivebox init --setup # safe to run init multiple times (also how you update versions) archivebox init --setup # safe to run init multiple times (also how you update versions)
archivebox version # get archivebox version info and more archivebox version # get archivebox version info and more
archivebox add --depth=1 'https://news.ycombinator.com' archivebox add --depth=1 'https://news.ycombinator.com'
</code> </code></pre>
</details> </details>
##### Docker Compose Usage ##### Docker Compose Usage
<br/>
<details> <details>
<summary><i>Click to expand...</i></summary> <summary><i>Click to expand...</i></summary>
<br/> <br/>
@ -458,6 +459,7 @@ docker compose run archivebox add --depth=1 'https://news.ycombinator.com'
##### Docker Usage ##### Docker Usage
<br/>
<details> <details>
<summary><i>Click to expand...</i></summary> <summary><i>Click to expand...</i></summary>
<br/> <br/>
@ -479,22 +481,14 @@ docker run -v $PWD:/data -it archivebox/archivebox version
> [!TIP] > [!TIP]
> Whether in Docker or not, ArchiveBox commands all work the same way, and can be used in tandem to access the same data directory. > Whether in Docker or not, ArchiveBox commands all work the same way, and can be used in tandem to access the same data directory.
> For example, you can run the Web UI in Docker Compose, and run one-off commands on host with `pip`-installed ArchiveBox or in Docker interchangeably. > For example, you can run the Web UI in Docker Compose, and run one-off commands on host with `pip`-installed ArchiveBox or in Docker interchangeably.
> <details><summary><i>Expand to show example...</i></summary><br/><pre lang="bash"><code style="white-space: pre-line">
<br/>
<details>
<summary><i>Expand to show example...</i></summary>
<br/>
<pre lang="bash"><code style="white-space: pre-line">
docker compose up -d # start the Web UI server in the background docker compose up -d # start the Web UI server in the background
docker compose run archivebox add 'https://example.com' # add a test URL to snapshot w/ Docker Compose docker compose run archivebox add 'https://example.com' # add a test URL to snapshot w/ Docker Compose
archivebox list 'https://example.com' # fetch it with pip-installed archivebox on the host archivebox list 'https://example.com' # fetch it with pip-installed archivebox on the host
docker compose run archivebox list 'https://example.com' # or w/ Docker Compose docker compose run archivebox list 'https://example.com' # or w/ Docker Compose
docker run -it -v $PWD:/data archivebox/archivebox list 'https://example.com' # or w/ Docker, all equivalent docker run -it -v $PWD:/data archivebox/archivebox list 'https://example.com' # or w/ Docker, all equivalent
</code></pre> </code></pre></details>
</details>
#### 🖥&nbsp; Web UI Usage #### 🖥&nbsp; Web UI Usage