ArchiveBox/etc
github-actions[bot] f80e6cea2b
Some checks failed
CodeQL / Analyze (${{ matrix.language }}) (none, python) (push) Has been cancelled
Build Docker image / build ${{ matrix.platform }} (digest-linux-amd64, docker-amd64, linux/amd64, ubuntu-24.04) (push) Has been cancelled
Build Docker image / build ${{ matrix.platform }} (digest-linux-arm64, docker-arm64, linux/arm64, ubuntu-24.04-arm) (push) Has been cancelled
Run linters / lint (push) Has been cancelled
Build Pip package / build (push) Has been cancelled
Release State / release-state (push) Has been cancelled
Parallel Tests / Discover test files (push) Has been cancelled
Run tests / python_tests (ubuntu-22.04, 3.13) (push) Has been cancelled
Run tests / docker_tests (push) Has been cancelled
Update downstream packages / dispatch (push) Has been cancelled
Build Docker image / publish multiarch tags (push) Has been cancelled
Parallel Tests / ${{ matrix.test.name }} (push) Has been cancelled
Parallel Tests / ${{ matrix.plugin.name }} (push) Has been cancelled
release: v0.9.35rc103
2026-07-15 18:29:42 +00:00
..
archivebox.service Update WorkingDirectory and ExecStart in service file 2026-06-08 07:32:33 -04:00
fly.toml cleanup config files 2021-04-23 22:58:44 -04:00
nginx.conf wip 2026-03-23 03:58:32 -07:00
package.json release: v0.9.35rc103 2026-07-15 18:29:42 +00:00
README.md Add bundled HTTPS ingress compose profiles 2026-06-07 12:36:51 -07:00
sonic.cfg lower default sonic log level 2024-02-22 04:50:22 -08:00
uwsgi.ini rename OUTPUT_DIR to DATA_DIR 2024-09-30 17:44:18 -07:00

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