mirrors/ArchiveBox
1
0
Fork 0
mirror of https://github.com/ArchiveBox/ArchiveBox.git synced 2025-05-24 03:36:55 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source
This commit is contained in:
Nick Sweeting 2021-05-07 09:11:24 -04:00 • committed by GitHub
parent 595839d887
commit 5d37063313
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -376,6 +376,8 @@ ls ./archive/*/index.html # or inspect snapshots on the filesystem
## Input Formats ## Input Formats
<img src="https://i.imgur.com/zM4z1aU.png" width="330px" align="right">
ArchiveBox supports many input formats for URLs, including Pocket & Pinboard exports, Browser bookmarks, Browser history, plain text, HTML, markdown, and more! ArchiveBox supports many input formats for URLs, including Pocket & Pinboard exports, Browser bookmarks, Browser history, plain text, HTML, markdown, and more!
@ -407,6 +409,8 @@ It also includes a built-in scheduled import feature with `archivebox schedule`
## Output Formats ## Output Formats
<img src="https://i.imgur.com/xHvQfon.png" width="330px" align="right">
Inside each Snapshot folder, ArchiveBox save these different types of extractor outputs as plain files: Inside each Snapshot folder, ArchiveBox save these different types of extractor outputs as plain files:
`./archive/<timestamp>/*` `./archive/<timestamp>/*`
@ -431,6 +435,8 @@ It does everything out-of-the-box by default, but you can disable or tweak [indi
## Configuration ## Configuration
<img src="https://i.imgur.com/H08eaia.png" width="330px" align="right">
ArchiveBox can be configured via environment variables, by using the `archivebox config` CLI, or by editing the `ArchiveBox.conf` config file directly. ArchiveBox can be configured via environment variables, by using the `archivebox config` CLI, or by editing the `ArchiveBox.conf` config file directly.
```bash ```bash
@ -469,6 +475,8 @@ PUBLIC_ADD_VIEW=False # default: False whether anon users can add new URLs
## Dependencies ## Dependencies
<img src="https://i.imgur.com/5vSBO2R.png" width="330px" align="right">
For better security, easier updating, and to avoid polluting your host system with extra dependencies, **it is strongly recommended to use the official [Docker image](https://github.com/ArchiveBox/ArchiveBox/wiki/Docker)** with everything preinstalled for the best experience. For better security, easier updating, and to avoid polluting your host system with extra dependencies, **it is strongly recommended to use the official [Docker image](https://github.com/ArchiveBox/ArchiveBox/wiki/Docker)** with everything preinstalled for the best experience.
To achieve high fidelity archives in as many situations as possible, ArchiveBox depends on a variety of 3rd-party tools and libraries that specialize in extracting different types of content. These optional dependencies used for archiving sites include: To achieve high fidelity archives in as many situations as possible, ArchiveBox depends on a variety of 3rd-party tools and libraries that specialize in extracting different types of content. These optional dependencies used for archiving sites include: