mirror of
https://github.com/ArchiveBox/ArchiveBox.git
synced 2026-09-12 19:50:57 +05:00
52ed0eac5e
Some checks are pending
CodeQL / Analyze (${{ matrix.language }}) (none, python) (push) Waiting to run
Build Docker image / build ${{ matrix.platform }} (digest-linux-amd64, docker-amd64, linux/amd64, ubuntu-24.04) (push) Waiting to run
Build Docker image / build ${{ matrix.platform }} (digest-linux-arm64, docker-arm64, linux/arm64, ubuntu-24.04-arm) (push) Waiting to run
Build Docker image / publish multiarch tags (push) Blocked by required conditions
Run linters / lint (push) Waiting to run
Build Pip package / build (push) Waiting to run
Release State / release-state (push) Waiting to run
Parallel Tests / Discover test files (push) Waiting to run
Parallel Tests / ${{ matrix.test.name }} (push) Blocked by required conditions
Parallel Tests / ${{ matrix.plugin.name }} (push) Blocked by required conditions
Run tests / python_tests (ubuntu-24.04, 3.13) (push) Waiting to run
Run tests / docker_tests (push) Waiting to run
Update downstream packages / dispatch (push) Waiting to run
|
||
|---|---|---|
| .. | ||
| archivebox.service | ||
| fly.toml | ||
| nginx.conf | ||
| package.json | ||
| README.md | ||
| sonic.cfg | ||
| uwsgi.ini | ||
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 unlimitedsnap-*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