forks/archivebox
1
0
Fork 0
Code Releases Activity

Update README.md

Browse source
This commit is contained in:
Nick Sweeting 2021-01-20 21:38:19 -05:00 committed by GitHub
parent 03f389b6a1
commit 444edc22b7
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
README.md
View file

@ -34,23 +34,26 @@ ArchiveBox is a powerful self-hosted internet archiving solution written in Pyth
#### 🔢  Overview
First Get ArchiveBox via Docker, Apt, Brew, Pip, etc. ([see below](#Quickstart)).
Get ArchiveBox via [Docker Compose (recommended)](#Quickstart), Docker, Apt, Brew, Pip, etc. ([see below](#Quickstart)).
```bash
apt/brew/pip3 install archivebox
```
Then use the `archivebox` CLI to set up your archive and start the web UI.
Then use the `archivebox` CLI to set up your archive and add URLs.
```bash
archivebox init # run this in an empty folder
archivebox add 'https://example.com' # start adding URLs to archive
archivebox schedule --every=day --depth=1 https://example.com/rss.xml
```
For each URL added, ArchiveBox saves several types of HTML snapshot (wget, Chrome headless, singlefile), a PDF, a screenshot, a WARC archive, any git repositories, images, audio, video, subtitles, article text, [and more...](#output-formats).
```bash
archivebox server 0.0.0.0:8000 # run the admin UI webserver
archivebox server 0.0.0.0:8000 # run the admin UI webserver
open http://127.0.0.1:8000/admin/
ls ./archive/*/index.json # or browse via the filesystem
```