Allowlist no host in the example config (closes #249)
check / check (push) Waiting to run

configs/config.example.yml allowlisted github.com and
user-images.githubusercontent.com, where anyone can put an image, so a
deployment set up as Getting Started says served those images to anyone
without a signature. The example now leaves allowlist_hosts out, with
one commented entry under example.com. Getting Started and "Running
under upaas" in README.md say that every image on an allowlisted host
is served without a signature, so an allowlisted host must be one the
operator controls.

Model: opus-5-5
This commit is contained in:
2026-10-15 02:43:40 +00:00
parent ca6287ef1d
commit 11946cb653
3 changed files with 21 additions and 7 deletions
+8 -1
View File
@@ -26,6 +26,11 @@ make docker
docker run -p 8080:8080 -e PIXA_SIGNING_KEY="$(openssl rand -base64 32)" pixa:latest
```
The example config allowlists no host (`allowlist_hosts`), so pixa serves an
image only for a signed or encrypted URL. Every image on an allowlisted host is
served to anyone without a signature, at any size and in any format, so
allowlist only hosts you control, where nobody else can put images.
A container takes its settings from environment variables (see Configuration
below for the list). Only `PIXA_SIGNING_KEY` is required; if it is unset the
container exits at startup naming the variable. Everything else has a built-in
@@ -115,7 +120,9 @@ What the [upaas](https://git.eeqj.de/sneak/upaas) app for pixa needs:
- `PIXA_SIGNING_KEY` (required): secret for signed and encrypted URLs and
login, 32+ characters, for example from `openssl rand -base64 32`
- `PIXA_ALLOWLIST_HOSTS`: upstream hosts served without a signature,
comma-separated
comma-separated; default none. Every image on a listed host is served to
anyone without a signature, so list only hosts you control, where nobody
else can put images.
- `PIXA_CACHE_MAX_BYTES`: disk cache limit in bytes; `0` disables it;
default 75% of (free space + what the cache holds)
- the rest are in the table under Configuration below