ArchiveBox/etc/README.md
2026-06-07 12:36:51 -07:00

26 lines
1.3 KiB
Markdown

# Example etc files for deploying ArchiveBox
In this folder are some example config files you can use for setting up ArchiveBox on your machine.
E.g. see `nginx.conf` for an example nginx config to serve your archive with SSL, or `fly.toml` for an example deployment to the Fly.io hosting platform.
For the recommended, batteries-included reverse proxy and TLS, you don't need a file
here at all — it's built into the main `../docker-compose.yml` as two opt-in, env-var
driven profiles (no extra files, Dockerfiles, or scripts) — set the documented env
vars in a `.env` next to `../docker-compose.yml`:
- `https` — a single Traefik container terminates TLS and fetches/auto-renews one
`*.<your-domain>` wildcard cert via DNS-01 (covering unlimited `snap-*` subdomains,
~100 DNS providers via its embedded lego, no per-provider code), serving Traefik's
default self-signed cert if no DNS provider is configured.
- `tunnel` — a Cloudflare Tunnel whose tunnel/DNS are auto-provisioned from your API
token, so Cloudflare's edge terminates TLS and routes `*.<your-domain>` through one
tunnel to ArchiveBox (Host-routed) — no public IP or wildcard cert needed locally.
Please contribute your etc files here! Example contributions
- supervisord config
- systemd config
- apache webserver config
- other init system, webservers, or scheduler configs