Write the deployment guide and an example Caddy config (closes #89)
check / check (push) Failing after 2s
check / check (push) Failing after 2s
README.md gains a "Deployment" section: what the reverse proxy in front of pixa must do (terminate TLS, pass Host, Origin and Referer on unchanged, set X-Forwarded-For with trusted_proxies to match, wait at least downstream_timeout, optionally refuse /metrics) and what pixa does itself; that the state directory needs a persistent volume, what cache_max_bytes counts and why to set it; the health check for a load balancer; what SIGTERM does and the exit codes; and what running outside Docker needs. configs/Caddyfile is the example, as Caddy needs no settings beyond the host name and pixa's address. Model: opus-5-5
This commit was merged in pull request #182.
This commit is contained in:
@@ -29,6 +29,15 @@ P2: security: referer blacklist
|
||||
|
||||
# Completed Steps
|
||||
|
||||
- 2026-10-04 deployment guide and example Caddy config (closes #89):
|
||||
"Deployment" in `README.md` says what the reverse proxy in front of pixa must
|
||||
do (terminate TLS; pass `Host`, `Origin` and `Referer` on unchanged; set
|
||||
`X-Forwarded-For`, with `trusted_proxies` to match; wait at least
|
||||
`downstream_timeout`; optionally refuse `/metrics`) and what pixa does itself,
|
||||
that the state directory needs a persistent volume and what `cache_max_bytes`
|
||||
counts, the health check for a load balancer, what a stop does and its exit
|
||||
codes, and what running outside Docker needs; `configs/Caddyfile` is the
|
||||
example, checked with `caddy validate`.
|
||||
- 2026-10-04 the metrics basic auth, CORS preflight, request logging and
|
||||
metrics recording have tests (closes #79): `MetricsAuth` on its own answers
|
||||
401 with a challenge without credentials or with a wrong username or password
|
||||
@@ -485,6 +494,3 @@ P2: security: referer blacklist
|
||||
- Prometheus performance metrics
|
||||
- integration tests for the image proxy flow
|
||||
- load tests to verify the 1k to 5k req/s target
|
||||
- P2: documentation
|
||||
- deployment guide
|
||||
- example nginx or caddy reverse proxy config
|
||||
|
||||
Reference in New Issue
Block a user