edufeed/nocabs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions

docs(readme): note BLOCKED_NPUBS runtime env var

Browse source
This commit is contained in:
@s.roertgen 2026-04-23 15:51:34 +02:00
commit eed6987faa
1 changed files with 15 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

18
README.md
View file

@ -58,9 +58,21 @@ docker run --rm -p 8080:80 git.edufeed.org/edufeed/nocabs:latest
# open http://localhost:8080
```
The image is `caddy:2-alpine` serving the built static assets on port `80`. No env
vars are needed. For TLS, put it behind any reverse proxy (Traefik, Caddy, nginx,
Cloudflare) terminating HTTPS upstream.
The image is `caddy:2-alpine` serving the built static assets on port `80`. For
TLS, put it behind any reverse proxy (Traefik, Caddy, nginx, Cloudflare)
terminating HTTPS upstream.
### Runtime configuration
The entrypoint renders `/srv/config.json` from environment variables at
container start (no image rebuild required). Currently supported:
- `BLOCKED_NPUBS` — comma-separated npubs and/or 64-char hex pubkeys whose
content is hidden from this deployment. Events from these authors never
enter the EventStore; direct URLs such as `/vocab/<blocked-npub>[/<d>]`
return a 404. Unset or empty means no operator-level blocking.
Change the value and restart the container to take effect.
## Deploy behind your own reverse proxy