From bddea22dac705b429bae6d4cfb375169231d4a57 Mon Sep 17 00:00:00 2001 From: Nick Sweeting Date: Tue, 23 Jan 2024 18:31:44 -0800 Subject: [PATCH] Update README.md --- README.md | 33 ++++++++++++++++++++++----------- 1 file changed, 22 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 78c1de1e..625ca8d5 100644 --- a/README.md +++ b/README.md @@ -426,6 +426,25 @@ cd ~/archivebox/data # IMPORTANT: cd into the directory # archivebox [subcommand] [--args] ``` +> [!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. +> 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. + +
+Expand to show examples...
+ +

+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
+
+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 run -it -v $PWD:/data archivebox/archivebox list 'https://example.com'  # or w/ Docker, all equivalent
+
+ +
+
+ ##### Bare Metal Usage (`pip`/`apt`/`brew`/etc.)
@@ -440,6 +459,7 @@ archivebox add --depth=1 'https://news.ycombinator.com' +
##### Docker Compose Usage @@ -456,6 +476,7 @@ docker compose run archivebox add --depth=1 'https://news.ycombinator.com' +
##### Docker Usage @@ -470,6 +491,7 @@ docker run -v $PWD:/data -it archivebox/archivebox version +
#### Next Steps @@ -478,17 +500,6 @@ docker run -v $PWD:/data -it archivebox/archivebox version - `archivebox add/schedule/remove/update/list/shell/oneshot` to manage Snapshots in the archive - `archivebox schedule` to pull in fresh URLs regularly from [bookmarks/history/Pocket/Pinboard/RSS/etc.](#input-formats) -> [!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. -> 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. ->
Expand to show example...

-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
-
-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 run -it -v $PWD:/data archivebox/archivebox list 'https://example.com'  # or w/ Docker, all equivalent
-
#### 🖥  Web UI Usage