From 194390b61f1647f34d622c02178fa2698202f1f0 Mon Sep 17 00:00:00 2001 From: clawbot <35+clawbot@noreply.example.org> Date: Tue, 29 Sep 2026 02:58:45 +0200 Subject: [PATCH] Merge next into main: UPAAS_ setting names in the README (#228) On `next`: the README's Configuration table now names the settings upaas actually reads, `UPAAS_DEBUG`, `UPAAS_SENTRY_DSN`, `UPAAS_METRICS_USERNAME` and `UPAAS_METRICS_PASSWORD`, instead of the unprefixed names it ignores (https://git.eeqj.de/sneak/upaas/issues/224). Docs only; no code changes. For deploying: nothing changes. Anyone who set `DEBUG`, `SENTRY_DSN` or `METRICS_USERNAME`/`METRICS_PASSWORD` as the old table said got no effect and needs the `UPAAS_` names. The table still leaves out `UPAAS_MAINTENANCE_MODE`, `UPAAS_SESSION_SECRET` and `UPAAS_CORS_ORIGINS`, which upaas also reads. Model: opus-5-5 Reviewed-on: https://git.eeqj.de/sneak/upaas/pulls/228 Co-authored-by: clawbot <35+clawbot@noreply.example.org> --- README.md | 22 +++++++++++----------- TODO.md | 5 +++++ 2 files changed, 16 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 4ef45f9..6deef47 100644 --- a/README.md +++ b/README.md @@ -191,17 +191,17 @@ This ensures the main branch always contains clean, tested, working code. Environment variables: -| Variable | Description | Default | -| ---------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------- | -| `PORT` | HTTP listen port | 8080 | -| `UPAAS_DATA_DIR` | Data directory for SQLite and keys | `./data` (local dev only — use absolute path for Docker) | -| `UPAAS_HOST_DATA_DIR` | Host path for DATA_DIR (when running in container) | _(none — must be set to an absolute path)_ | -| `UPAAS_DOCKER_HOST` | Docker socket path | unix:///var/run/docker.sock | -| `UPAAS_PLAINTEXT_HTTP` | Set when µPaaS is reached over plain HTTP (no TLS-terminating proxy in front) so CSRF origin checks use `http://`. Leave unset behind a TLS-terminating reverse proxy. | false | -| `DEBUG` | Enable debug logging | false | -| `SENTRY_DSN` | Sentry error reporting DSN | "" | -| `METRICS_USERNAME` | Basic auth for /metrics | "" | -| `METRICS_PASSWORD` | Basic auth for /metrics | "" | +| Variable | Description | Default | +| ------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------- | +| `PORT` | HTTP listen port | 8080 | +| `UPAAS_DATA_DIR` | Data directory for SQLite and keys | `./data` (local dev only — use absolute path for Docker) | +| `UPAAS_HOST_DATA_DIR` | Host path for `UPAAS_DATA_DIR` (when running in container) | _(none — must be set to an absolute path)_ | +| `UPAAS_DOCKER_HOST` | Docker socket path | unix:///var/run/docker.sock | +| `UPAAS_PLAINTEXT_HTTP` | Set when µPaaS is reached over plain HTTP (no TLS-terminating proxy in front) so CSRF origin checks use `http://`. Leave unset behind a TLS-terminating reverse proxy. | false | +| `UPAAS_DEBUG` | Enable debug logging | false | +| `UPAAS_SENTRY_DSN` | Sentry error reporting DSN | "" | +| `UPAAS_METRICS_USERNAME` | Basic auth for /metrics | "" | +| `UPAAS_METRICS_PASSWORD` | Basic auth for /metrics | "" | ## Running with Docker diff --git a/TODO.md b/TODO.md index 50e289f..0fabf94 100644 --- a/TODO.md +++ b/TODO.md @@ -20,6 +20,11 @@ regress. # Completed Steps +- 2026-09-28: The README Configuration table now names `UPAAS_DEBUG`, + `UPAAS_SENTRY_DSN`, `UPAAS_METRICS_USERNAME` and `UPAAS_METRICS_PASSWORD`, the + names upaas actually reads (the unprefixed names it listed were ignored), and + the `UPAAS_HOST_DATA_DIR` row refers to `UPAAS_DATA_DIR` (#224). + - 2026-09-28: Added `docker-compose.yml` for deploying upaas: settings from `.env`, the port published on `127.0.0.1` only for a TLS proxy in front, and a healthcheck against `/health`; the README's plain-HTTP Compose example is