README Configuration table lists four settings without the UPAAS_ prefix upaas reads #224

Open
opened 2026-09-28 11:29:03 +02:00 by clawbot · 1 comment
Collaborator

The Configuration table in README.md lists DEBUG, SENTRY_DSN, METRICS_USERNAME and METRICS_PASSWORD, but upaas reads them only with the UPAAS_ prefix: internal/config/config.go calls viper.SetEnvPrefix("UPAAS") and binds only PORT without it. So DEBUG=true or SENTRY_DSN=... in .env, as the table says, is silently ignored; UPAAS_DEBUG=true and UPAAS_SENTRY_DSN=... work.

Fix: correct those four names in the table.

Model: opus-5-5

The Configuration table in `README.md` lists `DEBUG`, `SENTRY_DSN`, `METRICS_USERNAME` and `METRICS_PASSWORD`, but upaas reads them only with the `UPAAS_` prefix: `internal/config/config.go` calls `viper.SetEnvPrefix("UPAAS")` and binds only `PORT` without it. So `DEBUG=true` or `SENTRY_DSN=...` in `.env`, as the table says, is silently ignored; `UPAAS_DEBUG=true` and `UPAAS_SENTRY_DSN=...` work. Fix: correct those four names in the table. Model: opus-5-5
Author
Collaborator

Plan: one small docs PR to next.

Definition of done:

  • In the Configuration table in README.md, the rows DEBUG, SENTRY_DSN, METRICS_USERNAME and METRICS_PASSWORD read UPAAS_DEBUG, UPAAS_SENTRY_DSN, UPAAS_METRICS_USERNAME and UPAAS_METRICS_PASSWORD.
  • The UPAAS_HOST_DATA_DIR row's description, "Host path for DATA_DIR", names UPAAS_DATA_DIR instead.
  • Every other setting name in README.md is checked against internal/config/config.go (viper.SetEnvPrefix("UPAAS") plus AutomaticEnv; only PORT is also read without the prefix) and against docker-compose.yml, and any further mismatch is corrected. Already correct: PORT, UPAAS_DATA_DIR, UPAAS_HOST_DATA_DIR, UPAAS_DOCKER_HOST, UPAAS_PLAINTEXT_HTTP, and HOST_DATA_DIR in the Compose section (a Compose variable in .env that docker-compose.yml passes to upaas as UPAAS_HOST_DATA_DIR).
  • TODO.md: one dated entry at the top of Completed Steps, in the style of the entries already there, ending (#224).
  • Out of scope: adding rows for settings the table leaves out (UPAAS_MAINTENANCE_MODE, UPAAS_SESSION_SECRET, UPAAS_CORS_ORIGINS), changing defaults or wording beyond setting names, and code. Put one line in the PR body saying the table still leaves those three out.

Model: opus-5-5

Plan: one small docs PR to `next`. Definition of done: - In the Configuration table in `README.md`, the rows `DEBUG`, `SENTRY_DSN`, `METRICS_USERNAME` and `METRICS_PASSWORD` read `UPAAS_DEBUG`, `UPAAS_SENTRY_DSN`, `UPAAS_METRICS_USERNAME` and `UPAAS_METRICS_PASSWORD`. - The `UPAAS_HOST_DATA_DIR` row's description, "Host path for DATA_DIR", names `UPAAS_DATA_DIR` instead. - Every other setting name in `README.md` is checked against `internal/config/config.go` (`viper.SetEnvPrefix("UPAAS")` plus `AutomaticEnv`; only `PORT` is also read without the prefix) and against `docker-compose.yml`, and any further mismatch is corrected. Already correct: `PORT`, `UPAAS_DATA_DIR`, `UPAAS_HOST_DATA_DIR`, `UPAAS_DOCKER_HOST`, `UPAAS_PLAINTEXT_HTTP`, and `HOST_DATA_DIR` in the Compose section (a Compose variable in `.env` that `docker-compose.yml` passes to upaas as `UPAAS_HOST_DATA_DIR`). - `TODO.md`: one dated entry at the top of Completed Steps, in the style of the entries already there, ending `(#224)`. - Out of scope: adding rows for settings the table leaves out (`UPAAS_MAINTENANCE_MODE`, `UPAAS_SESSION_SECRET`, `UPAAS_CORS_ORIGINS`), changing defaults or wording beyond setting names, and code. Put one line in the PR body saying the table still leaves those three out. Model: opus-5-5
clawbot self-assigned this 2026-09-29 01:41:17 +02:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: sneak/upaas#224