Problem
README.md § Environment variables lists 9 env vars:
PORT, HOST, CORS_ORIGIN, DB_HOST, DB_PORT, DB_NAME, DB_USER,
DB_PASSWORD, PUBLIC_BASE_URL
The codebase actually consumes 19 (see grep -rhEo 'process\.env\.[A-Z_]+' app/ server.js | sort -u). Missing from the README:
| Var |
What an operator might tune it for |
NODE_ENV |
Hard-fail on empty DB_PASSWORD in production |
TRUST_PROXY |
Resolve real client IP behind nginx/caddy |
LOG_LEVEL / LOG_PRETTY |
Volume / format tuning |
DB_LOG_QUERIES |
SQL trace |
JSON_BODY_LIMIT |
Body-size DoS cap |
HELMET_CSP |
Re-enable CSP for HTML surfaces |
RATE_LIMIT_MAX / RATE_LIMIT_WINDOW_MS |
Per-key budget |
METRICS_BEARER_TOKEN |
/metrics auth |
SHUTDOWN_TIMEOUT_MS |
Drain window vs orchestrator SIGKILL |
TLS_DOMAIN / TLS_EMAIL |
Caddy reverse-proxy compose |
.env.example documents all of them, but the README is what operators
read first to size up the deployment surface. The 9-row table leaves
them with a misleadingly small mental model of what's configurable.
Fix
Resync the README table so it matches the full env surface, grouped
by concern (server / proxy / db / logging / body / security / rate-
limit / observability / lifecycle / tls). Keep .env.example cited as
the canonical artifact.
Acceptance
Proudly Made in Nebraska. Go Big Red! 🌽 https://xkcd.com/2347/
Problem
README.md§ Environment variables lists 9 env vars:The codebase actually consumes 19 (see
grep -rhEo 'process\.env\.[A-Z_]+' app/ server.js | sort -u). Missing from the README:NODE_ENVDB_PASSWORDin productionTRUST_PROXYLOG_LEVEL/LOG_PRETTYDB_LOG_QUERIESJSON_BODY_LIMITHELMET_CSPRATE_LIMIT_MAX/RATE_LIMIT_WINDOW_MSMETRICS_BEARER_TOKEN/metricsauthSHUTDOWN_TIMEOUT_MSTLS_DOMAIN/TLS_EMAIL.env.exampledocuments all of them, but the README is what operatorsread first to size up the deployment surface. The 9-row table leaves
them with a misleadingly small mental model of what's configurable.
Fix
Resync the README table so it matches the full env surface, grouped
by concern (server / proxy / db / logging / body / security / rate-
limit / observability / lifecycle / tls). Keep
.env.examplecited asthe canonical artifact.
Acceptance
.env.examplestill pointed to as canonical referenceProudly Made in Nebraska. Go Big Red! 🌽 https://xkcd.com/2347/