From 68b1c8342a2d4ba1f3b8b4256678e5cfd7746866 Mon Sep 17 00:00:00 2001 From: Nick Sweeting Date: Sat, 31 Oct 2020 07:16:10 -0400 Subject: [PATCH] Update README.md --- README.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index b052d25a..805f1dec 100644 --- a/README.md +++ b/README.md @@ -32,15 +32,6 @@ Once installed, URLs can be added via the command line `archivebox add` or the b The main index is a self-contained `data/index.sqlite3` file, and each snapshot is stored as a folder `data/archive//`, with an easy-to-read `index.html` and `index.json` within. For each page, ArchiveBox auto-extracts many types of assets/media and saves them in standard formats, with out-of-the-box support for: 3 types of HTML snapshots (wget, Chrome headless, singlefile), a PDF snapshot, a screenshot, a WARC archive, git repositories, images, audio, video, subtitles, article text, and more. The snapshots are browseable and managable offline through the filesystem, the built-in webserver, or the Python API. -All three ways of running ArchiveBox are equivalent and interchangeable: - -- `docker-compose run archivebox [subcommand] [...args]` - *Using the official Docker image w/ Docker Compose* -- `archivebox run -it -v $PWD:/data nikisweeting/archivebox [subcommand] [...args]` - *Using the official Docker image* -- `archivebox [subcommand] [...args]` - *Using the PyPI package via `pip install archivebox`* - #### Quickstart @@ -78,6 +69,15 @@ open http://127.0.0.1:8000 The CLI is considered "stable", and the ArchiveBox Python API and REST APIs are in "beta". +All three ways of running ArchiveBox are equivalent and interchangeable: + +- `docker-compose run archivebox [subcommand] [...args]` + *Using the official Docker image w/ Docker Compose (recommended)* +- `archivebox run -it -v $PWD:/data nikisweeting/archivebox [subcommand] [...args]` + *Using the official Docker image* +- `archivebox [subcommand] [...args]` + *Using the PyPI package via `pip install archivebox`* + At the end of the day, the goal is to sleep soundly knowing that the part of the internet you care about will be automatically preserved in multiple, durable long-term formats that will be accessible for decades (or longer). You can also self-host your archivebox server on a public domain to provide archive.org-style public access to your site snapshots.