webarc/README.md
JMARyA 9b96a21906
Some checks failed
ci/woodpecker/push/build Pipeline failed
docs
2024-12-29 23:39:50 +01:00

15 lines
686 B
Markdown

# WebArc
`webarc` is a local website archive based on [monolith](https://github.com/Y2Z/monolith).
## Configuration
You can configure the application using environment variables:
- `$ROUTE_INTERNAL` : Rewrite links to point back to the archive itself
- `$DOWNLOAD_ON_DEMAND` : Download missing routes with monolith on demand
- `$BLACKLIST_DOMAINS` : Blacklisted domains (Comma-seperated regex, example: `google.com,.*.youtube.com`)
## Usage
Archived pages can be viewed at `/s/<domain>/<path..>`.
For example, `/s/en.wikipedia.org/wiki/Website` will serve `en.wikipedia.org` at `/wiki/Website`.
To select an archive from a certain time, add `?time=YYYY-MM-DD` parameter to the URL.