Name the UPAAS_-prefixed settings in the README Configuration table (closes #224) #227

Merged
clawbot merged 1 commits from docs/readme-upaas-prefix into next 2026-09-29 02:24:41 +02:00
Collaborator

Fixes #224.

upaas reads its settings with the UPAAS_ prefix (viper.SetEnvPrefix("UPAAS") in internal/config/config.go); only PORT is also read without it. The Configuration table in README.md listed four settings without the prefix, so setting them as written, in .env or with -e, did nothing.

  • DEBUG, SENTRY_DSN, METRICS_USERNAME and METRICS_PASSWORD now read UPAAS_DEBUG, UPAAS_SENTRY_DSN, UPAAS_METRICS_USERNAME and UPAAS_METRICS_PASSWORD.
  • The UPAAS_HOST_DATA_DIR description names UPAAS_DATA_DIR instead of DATA_DIR.
  • TODO.md gets a Completed Steps entry.

No other setting name in README.md differs from what the code reads. HOST_DATA_DIR in the Compose section stays unprefixed on purpose: it is a Compose variable in .env that docker-compose.yml passes to upaas as UPAAS_HOST_DATA_DIR.

Most of the table diff is prettier re-aligning the columns for the longer names; only the five cells above changed.

Out of scope: the table still leaves out UPAAS_MAINTENANCE_MODE, UPAAS_SESSION_SECRET and UPAAS_CORS_ORIGINS.

Model: opus-5-5

Fixes https://git.eeqj.de/sneak/upaas/issues/224. upaas reads its settings with the `UPAAS_` prefix (`viper.SetEnvPrefix("UPAAS")` in `internal/config/config.go`); only `PORT` is also read without it. The Configuration table in `README.md` listed four settings without the prefix, so setting them as written, in `.env` or with `-e`, did nothing. - `DEBUG`, `SENTRY_DSN`, `METRICS_USERNAME` and `METRICS_PASSWORD` now read `UPAAS_DEBUG`, `UPAAS_SENTRY_DSN`, `UPAAS_METRICS_USERNAME` and `UPAAS_METRICS_PASSWORD`. - The `UPAAS_HOST_DATA_DIR` description names `UPAAS_DATA_DIR` instead of `DATA_DIR`. - `TODO.md` gets a Completed Steps entry. No other setting name in `README.md` differs from what the code reads. `HOST_DATA_DIR` in the Compose section stays unprefixed on purpose: it is a Compose variable in `.env` that `docker-compose.yml` passes to upaas as `UPAAS_HOST_DATA_DIR`. Most of the table diff is prettier re-aligning the columns for the longer names; only the five cells above changed. Out of scope: the table still leaves out `UPAAS_MAINTENANCE_MODE`, `UPAAS_SESSION_SECRET` and `UPAAS_CORS_ORIGINS`. Model: opus-5-5
clawbot added the needs-review label 2026-09-29 02:03:41 +02:00
clawbot self-assigned this 2026-09-29 02:03:41 +02:00
clawbot added 1 commit 2026-09-29 02:03:42 +02:00
upaas reads its settings with the UPAAS_ prefix (only PORT is also read
without it), so the table's DEBUG, SENTRY_DSN, METRICS_USERNAME and
METRICS_PASSWORD were silently ignored when set as written. The rows now
read UPAAS_DEBUG, UPAAS_SENTRY_DSN, UPAAS_METRICS_USERNAME and
UPAAS_METRICS_PASSWORD, and the UPAAS_HOST_DATA_DIR description refers to
UPAAS_DATA_DIR. TODO.md records the step.

Model: opus-5-5
Author
Collaborator

Review passed.

Model: opus-5-5

Review passed. Model: opus-5-5
clawbot merged commit bdd1c5b1cf into next 2026-09-29 02:24:41 +02:00
clawbot deleted branch docs/readme-upaas-prefix 2026-09-29 02:24:41 +02:00
clawbot removed the needs-review label 2026-09-29 02:24:54 +02:00
Sign in to join this conversation.