From 0d26538a4bea3671e3e2b7c202b1ebd72b564561 Mon Sep 17 00:00:00 2001 From: Nick Sweeting Date: Tue, 13 Jun 2023 17:46:32 -0700 Subject: [PATCH] Update README.md example commands to use new docker compose format --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 640aaa49..93268bfb 100644 --- a/README.md +++ b/README.md @@ -124,12 +124,12 @@ ls ./archive/*/index.json # or browse directly via the filesyste curl -O 'https://raw.githubusercontent.com/ArchiveBox/ArchiveBox/master/docker-compose.yml'
  • Run the initial setup and create an admin user. -
    docker-compose run archivebox init --setup
    +
    docker compose run archivebox init --setup
     
  • Optional: Start the server then login to the Web UI http://127.0.0.1:8000 ⇢ Admin. -
    docker-compose up
    +
    docker compose up
     # completely optional, CLI can always be used without running a server
    -# docker-compose run [-T] archivebox [subcommand] [--args]
    +# docker compose run [-T] archivebox [subcommand] [--args]
     
  • @@ -442,10 +442,10 @@ archivebox add --depth=1 'https://news.ycombinator.com#2020-12-12' echo 'http://example.com' | archivebox add echo 'any_text_with [urls](https://example.com) in it' | archivebox add -# if using docker add -i when piping stdin: +# if using Docker, add -i when piping stdin: # echo 'https://example.com' | docker run -v $PWD:/data -i archivebox/archivebox add -# if using docker-compose add -T when piping stdin / stdout: -# echo 'https://example.com' | docker-compose run -T archivebox add +# if using Docker Compose, add -T when piping stdin / stdout: +# echo 'https://example.com' | docker compose run -T archivebox add ``` See the [Usage: CLI](https://github.com/ArchiveBox/ArchiveBox/wiki/Usage#CLI-Usage) page for documentation and examples. @@ -596,8 +596,8 @@ archivebox list --html --with-headers > index.html # export to static html t archivebox list --json --with-headers > index.json # export to json blob archivebox list --csv=timestamp,url,title > index.csv # export to csv spreadsheet -# (if using docker-compose, add the -T flag when piping) -# docker-compose run -T archivebox list --html --filter-type=search snozzberries > index.json +# (if using Docker Compose, add the -T flag when piping) +# docker compose run -T archivebox list --html --filter-type=search snozzberries > index.json ``` The paths in the static exports are relative, make sure to keep them next to your `./archive` folder when backing them up or viewing them.