From eb358e67d2d5cb4b7571ab432bed3f1c2af37bd6 Mon Sep 17 00:00:00 2001 From: clawbot Date: Tue, 29 Sep 2026 00:54:48 +0000 Subject: [PATCH] List every setting upaas reads in the README Configuration table (closes #229) The table left out UPAAS_MAINTENANCE_MODE, UPAAS_SESSION_SECRET and UPAAS_CORS_ORIGINS, and several rows gave the wrong default or effect. Each row now matches internal/config/config.go and the code that uses the value: UPAAS_PORT is also read and wins over PORT, UPAAS_HOST_DATA_DIR falls back to UPAAS_DATA_DIR and must be absolute, UPAAS_DEBUG also drops the session cookie's Secure flag, UPAAS_SENTRY_DSN is not used, and /metrics exists only when UPAAS_METRICS_USERNAME is set. A sentence under the table names the standard Docker client variables. TODO.md records the step. Model: opus-5-5 --- README.md | 29 ++++++++++++++++++----------- TODO.md | 7 +++++++ 2 files changed, 25 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 6deef47..b2c98df 100644 --- a/README.md +++ b/README.md @@ -191,17 +191,24 @@ 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 `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 | "" | +| Variable | Description | Default | +| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------- | +| `PORT` | HTTP listen port. `UPAAS_PORT` is also read and wins when both are set. | 8080 | +| `UPAAS_DATA_DIR` | Directory for the SQLite database, session key, builds and deployment logs | `./data` (the Docker image sets `/var/lib/upaas`) | +| `UPAAS_HOST_DATA_DIR` | Host path of `UPAAS_DATA_DIR`, needed when upaas runs in a container so the bind mounts it passes to Docker point at the right host directory. Must be absolute, or upaas refuses to start. | the value of `UPAAS_DATA_DIR` | +| `UPAAS_DOCKER_HOST` | Docker daemon address | 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. Also sends the session cookie without the `Secure` flag. | false | +| `UPAAS_SENTRY_DSN` | Read but not used: upaas sends nothing to Sentry | "" | +| `UPAAS_METRICS_USERNAME` | When set, `/metrics` is served behind basic auth with this username. When unset, there is no `/metrics`. | "" | +| `UPAAS_METRICS_PASSWORD` | Basic auth password for `/metrics` | "" | +| `UPAAS_MAINTENANCE_MODE` | Only shown as `maintenanceMode` in the `/health` response; it blocks nothing | false | +| `UPAAS_SESSION_SECRET` | Key that signs the session and CSRF cookies. When unset, a random key is generated once and kept in `$UPAAS_DATA_DIR/session.key`. | "" | +| `UPAAS_CORS_ORIGINS` | Comma-separated origins allowed to make cross-origin requests with cookies. When unset, no CORS headers are sent. | "" | + +The Docker client also reads the standard `DOCKER_API_VERSION`, +`DOCKER_CERT_PATH` and `DOCKER_TLS_VERIFY` variables; `UPAAS_DOCKER_HOST`, which +has a default, always overrides `DOCKER_HOST`. ## Running with Docker diff --git a/TODO.md b/TODO.md index 0fabf94..da459cb 100644 --- a/TODO.md +++ b/TODO.md @@ -20,6 +20,13 @@ regress. # Completed Steps +- 2026-09-29: The README Configuration table now lists every setting upaas + reads, adding `UPAAS_MAINTENANCE_MODE`, `UPAAS_SESSION_SECRET` and + `UPAAS_CORS_ORIGINS`, and gives the real default and effect of each: + `UPAAS_PORT` wins over `PORT`, `UPAAS_HOST_DATA_DIR` falls back to + `UPAAS_DATA_DIR`, `UPAAS_DEBUG` drops the session cookie's `Secure` flag, and + `UPAAS_SENTRY_DSN` is not used (#229). + - 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