From 4146c1d673a7003498e585bd5f079a6182fec08f Mon Sep 17 00:00:00 2001 From: Nick Sweeting Date: Tue, 23 Jan 2024 18:22:36 -0800 Subject: [PATCH] Update README.md --- README.md | 22 ++++++++++++---------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index bd097c2d..aa7a92b8 100644 --- a/README.md +++ b/README.md @@ -426,16 +426,6 @@ 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 server in Docker Compose, and run one-off commands on the host at the same time with `pip`-installed ArchiveBox. - -```bash -# e.g. archivebox add --depth=1 'https://news.ycombinator.com' -# or docker compose run archivebox --depth=1 'https://news.ycombinator.com' -# or docker run -it -v $PWD:/data archivebox/archivebox add --depth=1 'https://news.ycombinator.com' -``` - #### Bare Metal Usage (`pip`/`apt`/`brew`/etc.) ```bash archivebox init --setup # safe to run init multiple times (also how you update versions) @@ -464,6 +454,18 @@ 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. + +```bash +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