CodeMirror/ArchiveBox
1
0
Fork 0
mirror of synced 2024-06-01 10:09:49 +12:00
Code Issues Projects Releases Wiki Activity

Update README.md

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

10
README.md
View file

@ -38,11 +38,7 @@ Get ArchiveBox via [Docker Compose (recommended)](#Quickstart), Docker, Apt, Bre
```bash
apt/brew/pip3 install archivebox
```
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
@ -51,9 +47,7 @@ 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
open http://127.0.0.1:8000/admin/
archivebox server 0.0.0.0:8000 # open http://127.0.0.1:8000/
ls ./archive/*/index.json # or browse via the filesystem
```
@ -360,6 +354,8 @@ It does everything out-of-the-box by default, but you can disable or tweak [indi
---
<br/>
## Dependencies
You don't need to install all the dependencies, ArchiveBox will automatically enable the relevant modules based on whatever you have available, but it's recommended to use the official [Docker image](https://github.com/ArchiveBox/ArchiveBox/wiki/Docker) with everything preinstalled.