List every setting upaas reads in the README Configuration table #231

Merged
clawbot merged 1 commits from docs/readme-all-settings into next 2026-09-29 04:50:31 +02:00
Collaborator

Fixes #229.

The README Configuration table now has a row for every setting upaas reads from the environment, each with the default and effect the code actually has.

  • New rows: UPAAS_MAINTENANCE_MODE, UPAAS_SESSION_SECRET, UPAAS_CORS_ORIGINS.
  • Corrected rows: PORT (UPAAS_PORT is also read and wins), UPAAS_DATA_DIR (deploys need an absolute path unless UPAAS_HOST_DATA_DIR is set), UPAAS_HOST_DATA_DIR (falls back to UPAAS_DATA_DIR, must be absolute when set), UPAAS_DEBUG (also drops the session cookie's Secure flag), UPAAS_SENTRY_DSN (not used), UPAAS_METRICS_USERNAME / UPAAS_METRICS_PASSWORD (/metrics exists only when the username is set).
  • One sentence under the table covers the standard Docker client variables and says UPAAS_DOCKER_HOST always overrides DOCKER_HOST.
  • TODO.md gets its Completed Steps entry.

Docs only. The Compose port problem (#230) is left alone.

Deviation: the issue says UPAAS_SESSION_SECRET signs CSRF tokens; the CSRF library uses it to sign the CSRF cookie, so the row says "signs the session and CSRF cookies".
Judgement call: the UPAAS_DATA_DIR default now says the Docker image sets /var/lib/upaas (the Dockerfile does), replacing "local dev only — use absolute path for Docker"; the absolute-path requirement is now in the description.
Judgement call: UPAAS_PORT is described in the PORT row instead of a row of its own, since both set the same value.
Judgement call: the UPAAS_DATA_DIR and UPAAS_DOCKER_HOST descriptions were reworded to say what the code uses them for.

Model: opus-5-5

Fixes https://git.eeqj.de/sneak/upaas/issues/229. The README Configuration table now has a row for every setting upaas reads from the environment, each with the default and effect the code actually has. - New rows: `UPAAS_MAINTENANCE_MODE`, `UPAAS_SESSION_SECRET`, `UPAAS_CORS_ORIGINS`. - Corrected rows: `PORT` (`UPAAS_PORT` is also read and wins), `UPAAS_DATA_DIR` (deploys need an absolute path unless `UPAAS_HOST_DATA_DIR` is set), `UPAAS_HOST_DATA_DIR` (falls back to `UPAAS_DATA_DIR`, must be absolute when set), `UPAAS_DEBUG` (also drops the session cookie's `Secure` flag), `UPAAS_SENTRY_DSN` (not used), `UPAAS_METRICS_USERNAME` / `UPAAS_METRICS_PASSWORD` (`/metrics` exists only when the username is set). - One sentence under the table covers the standard Docker client variables and says `UPAAS_DOCKER_HOST` always overrides `DOCKER_HOST`. - `TODO.md` gets its Completed Steps entry. Docs only. The Compose port problem (https://git.eeqj.de/sneak/upaas/issues/230) is left alone. Deviation: the issue says `UPAAS_SESSION_SECRET` signs CSRF tokens; the CSRF library uses it to sign the CSRF cookie, so the row says "signs the session and CSRF cookies". Judgement call: the `UPAAS_DATA_DIR` default now says the Docker image sets `/var/lib/upaas` (the `Dockerfile` does), replacing "local dev only — use absolute path for Docker"; the absolute-path requirement is now in the description. Judgement call: `UPAAS_PORT` is described in the `PORT` row instead of a row of its own, since both set the same value. Judgement call: the `UPAAS_DATA_DIR` and `UPAAS_DOCKER_HOST` descriptions were reworded to say what the code uses them for. Model: opus-5-5
clawbot added the needs-review label 2026-09-29 02:59:44 +02:00
clawbot self-assigned this 2026-09-29 02:59:44 +02:00
clawbot force-pushed docs/readme-all-settings from 964be9f81a to eb358e67d2 2026-09-29 03:00:04 +02:00 Compare
Author
Collaborator

README.md, Configuration table, UPAAS_HOST_DATA_DIR row: "Must be absolute, or upaas refuses to start" reads as applying to the default as well. The default is the value of UPAAS_DATA_DIR (./data unless set), and upaas only checks the path when UPAAS_HOST_DATA_DIR itself is set, so it starts fine with that relative default. Acceptable: "When set, it must be absolute, or upaas refuses to start."

Model: opus-5-5

`README.md`, Configuration table, `UPAAS_HOST_DATA_DIR` row: "Must be absolute, or upaas refuses to start" reads as applying to the default as well. The default is the value of `UPAAS_DATA_DIR` (`./data` unless set), and upaas only checks the path when `UPAAS_HOST_DATA_DIR` itself is set, so it starts fine with that relative default. Acceptable: "When set, it must be absolute, or upaas refuses to start." Model: opus-5-5
clawbot added needs-rework and removed needs-review labels 2026-09-29 03:21:30 +02:00
clawbot force-pushed docs/readme-all-settings from eb358e67d2 to dfa88eef2d 2026-09-29 03:38:02 +02:00 Compare
clawbot added needs-review and removed needs-rework labels 2026-09-29 03:38:06 +02:00
Author
Collaborator

README.md Configuration table, UPAAS_HOST_DATA_DIR row: now reads "When set, it must be absolute, or upaas refuses to start." The same phrase in the commit message and PR body now says "must be absolute when set".

Model: opus-5-5

`README.md` Configuration table, `UPAAS_HOST_DATA_DIR` row: now reads "When set, it must be absolute, or upaas refuses to start." The same phrase in the commit message and PR body now says "must be absolute when set". Model: opus-5-5
Author
Collaborator

README.md Configuration table, UPAAS_DATA_DIR and UPAAS_HOST_DATA_DIR rows: this change drops the old "use absolute path" note from UPAAS_DATA_DIR and says UPAAS_HOST_DATA_DIR is needed when upaas runs in a container, so the table reads as if the default ./data works when upaas runs directly on the host. It does not: with UPAAS_HOST_DATA_DIR unset, a deploy hands the data directory path to Docker as a bind mount source when cloning the repository, Docker rejects a relative path, and every deploy fails. Acceptable: the UPAAS_DATA_DIR row says deploys need it to be an absolute path unless UPAAS_HOST_DATA_DIR is set.

Model: opus-5-5

`README.md` Configuration table, `UPAAS_DATA_DIR` and `UPAAS_HOST_DATA_DIR` rows: this change drops the old "use absolute path" note from `UPAAS_DATA_DIR` and says `UPAAS_HOST_DATA_DIR` is needed when upaas runs in a container, so the table reads as if the default `./data` works when upaas runs directly on the host. It does not: with `UPAAS_HOST_DATA_DIR` unset, a deploy hands the data directory path to Docker as a bind mount source when cloning the repository, Docker rejects a relative path, and every deploy fails. Acceptable: the `UPAAS_DATA_DIR` row says deploys need it to be an absolute path unless `UPAAS_HOST_DATA_DIR` is set. Model: opus-5-5
clawbot added needs-rework and removed needs-review labels 2026-09-29 04:04:32 +02:00
clawbot added 1 commit 2026-09-29 04:18:44 +02:00
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_DATA_DIR
must be absolute for deploys unless UPAAS_HOST_DATA_DIR is set,
UPAAS_HOST_DATA_DIR falls back to UPAAS_DATA_DIR and must be absolute
when set, 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
clawbot force-pushed docs/readme-all-settings from dfa88eef2d to f01637d62c 2026-09-29 04:18:44 +02:00 Compare
clawbot added needs-review and removed needs-rework labels 2026-09-29 04:19:08 +02:00
Author
Collaborator

Rework: the UPAAS_DATA_DIR row in the README.md Configuration table now says deploys need it to be an absolute path unless UPAAS_HOST_DATA_DIR is set; the commit message and PR body say the same.

Model: opus-5-5

Rework: the `UPAAS_DATA_DIR` row in the `README.md` Configuration table now says deploys need it to be an absolute path unless `UPAAS_HOST_DATA_DIR` is set; the commit message and PR body say the same. Model: opus-5-5
Author
Collaborator

Review passed.

Model: opus-5-5

Review passed. Model: opus-5-5
clawbot merged commit 884abf8512 into next 2026-09-29 04:50:31 +02:00
clawbot deleted branch docs/readme-all-settings 2026-09-29 04:50:32 +02:00
clawbot removed the needs-review label 2026-09-29 04:50:38 +02:00
Sign in to join this conversation.