Mirrors/ArchiveBox
2
0
Fork 0
mirror of https://github.com/ArchiveBox/ArchiveBox synced 2024-11-10 06:34:16 +00:00
Code Issues Projects Releases Packages Wiki Activity

Update README.md example commands to use new docker compose format

Browse source
This commit is contained in:
Nick Sweeting 2023-06-13 17:46:32 -07:00 committed by GitHub
parent 37d238cd31
commit 0d26538a4b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -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' curl -O 'https://raw.githubusercontent.com/ArchiveBox/ArchiveBox/master/docker-compose.yml'
</code></pre></li> </code></pre></li>
<li>Run the initial setup and create an admin user. <li>Run the initial setup and create an admin user.
<pre lang="bash"><code style="white-space: pre-line">docker-compose run archivebox init --setup <pre lang="bash"><code style="white-space: pre-line">docker compose run archivebox init --setup
</code></pre></li> </code></pre></li>
<li>Optional: Start the server then login to the Web UI <a href="http://127.0.0.1:8000">http://127.0.0.1:8000</a> ⇢ Admin. <li>Optional: Start the server then login to the Web UI <a href="http://127.0.0.1:8000">http://127.0.0.1:8000</a> ⇢ Admin.
<pre lang="bash"><code style="white-space: pre-line">docker-compose up <pre lang="bash"><code style="white-space: pre-line">docker compose up
# completely optional, CLI can always be used without running a server # 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]
</code></pre></li> </code></pre></li>
</ol> </ol>
@ -442,10 +442,10 @@ archivebox add --depth=1 'https://news.ycombinator.com#2020-12-12'
echo 'http://example.com' | archivebox add echo 'http://example.com' | archivebox add
echo 'any_text_with [urls](https://example.com) in it' | 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 # echo 'https://example.com' | docker run -v $PWD:/data -i archivebox/archivebox add
# if using docker-compose add -T when piping stdin / stdout: # if using Docker Compose, add -T when piping stdin / stdout:
# echo 'https://example.com' | docker-compose run -T archivebox add # 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. 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 --json --with-headers > index.json # export to json blob
archivebox list --csv=timestamp,url,title > index.csv # export to csv spreadsheet archivebox list --csv=timestamp,url,title > index.csv # export to csv spreadsheet
# (if using docker-compose, add the -T flag when piping) # (if using Docker Compose, add the -T flag when piping)
# docker-compose run -T archivebox list --html --filter-type=search snozzberries > index.json # 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. 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.