From f9ad8e911b34da54c70055de9582a992e339dad2 Mon Sep 17 00:00:00 2001 From: Nick Sweeting Date: Sun, 18 Feb 2024 04:54:27 -0800 Subject: [PATCH] Update README.md --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 384d2aa7..71310809 100644 --- a/README.md +++ b/README.md @@ -501,6 +501,7 @@ archivebox version # get archivebox version info + check dependencies archivebox help # get list of archivebox subcommands that can be run archivebox add --depth=1 'https://news.ycombinator.com' +For more info, see our Usage: CLI Usage wiki. ➡️
@@ -518,6 +519,7 @@ docker compose run archivebox help docker compose run archivebox add --depth=1 'https://news.ycombinator.com' # to start webserver: docker compose up +For more info, see our Usage: Docker Compose CLI wiki. ➡️
@@ -535,6 +537,7 @@ docker run -v $PWD:/data -it archivebox/archivebox help docker run -v $PWD:/data -it archivebox/archivebox add --depth=1 'https://news.ycombinator.com' # to start webserver: docker run -v $PWD:/data -it -p 8000:8000 archivebox/archivebox +For more info, see our Usage: Docker CLI wiki. ➡️
@@ -546,6 +549,7 @@ archivebox shell # explore the Python library API in a REPL sqlite3 ./index.sqlite3 # run SQL queries directly on your index ls ./archive/*/index.html # or inspect snapshot data directly on the filesystem +For more info, see our Python Shell, SQL API, and Disk Layout wikis. ➡️ @@ -569,6 +573,8 @@ docker run -v $PWD:/data -it -p 8000:8000 archivebox/archivebox Open http://localhost:8000 to see your server's Web UI ➡️
+For more info, see our Usage: Web UI wiki. ➡️ +
Optional: Change permissions to allow non-logged-in users

@@ -598,6 +604,8 @@ docker compose run archivebox add --depth=1 'https://example.com'
 docker run -it -v $PWD:/data archivebox/archivebox add --depth=1 'https://example.com'  # or w/ Docker, all equivalent
 
+For more info, see our Docker wiki. ➡️ +