From 66fea50e81ff9e6b440a2fb972e10faa5f464534 Mon Sep 17 00:00:00 2001 From: archivebox Date: Thu, 4 Jun 2026 23:29:58 +0000 Subject: [PATCH] docs(etc): fix README refs to deleted proxy overlay files The reverse-proxy/TLS setup now lives entirely in the main docker-compose.yml as the env-driven https/tunnel profiles; update etc/README.md which still pointed at the removed docker-compose.proxy.yml, bin/proxy_lego.sh, and .env.proxy.example. --- etc/README.md | 18 +++++++++++------- 1 file changed, 11 insertions(+), 7 deletions(-) diff --git a/etc/README.md b/etc/README.md index c385e251..2a6368a5 100644 --- a/etc/README.md +++ b/etc/README.md @@ -4,13 +4,17 @@ In this folder are some example config files you can use for setting up ArchiveB 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, see `Caddyfile` — it's used by -the opt-in `docker-compose.proxy.yml` overlay to wildcard-route every dynamically -generated snapshot/role subdomain to ArchiveBox and terminate TLS. Locally it serves -`*.archivebox.localhost` via Caddy's internal CA; publicly it serves a single -`*.` wildcard cert obtained via DNS-01 by the `goacme/lego` sidecar -(`../bin/proxy_lego.sh`), which covers unlimited `snap-*` subdomains with one cert and -supports ~150 DNS providers without any per-provider code. See `../.env.proxy.example`. +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). See `../.env.example`: + +- `https` — Caddy + a `goacme/lego` DNS-01 sidecar fetch a single `*.` + wildcard cert (covering unlimited `snap-*` subdomains, ~150 DNS providers, no + per-provider code) and serve it, gracefully degrading to a self-signed cert if none + is available yet. +- `tunnel` — a Cloudflare Tunnel whose tunnel/DNS are auto-provisioned from your API + token, so Cloudflare's edge terminates TLS and routes `*.` through one + tunnel to ArchiveBox (Host-routed) — no public IP or wildcard cert needed locally. Please contribute your etc files here! Example contributions