Skip to content

Environment variable reference #542

Description

@codebestia

Write docs/environment-variables.md: one table of every environment variable across all four apps — name, which app reads it, required vs optional, default, and what breaks if it is wrong. Source it from apps/backend/src/config.ts, .env.example, apps/backend/src/config/rateLimits.ts, the NEXT_PUBLIC_* vars in apps/web, and the AI agent's settings.

Acceptance criteria:

  • Every variable in .env.example appears, plus any read directly via process.env that .env.example omits
  • Marks which variables are validated at boot by config.ts (crash on start) vs. read lazily (silent misbehaviour)
  • Flags secrets explicitly and states they must never be committed
  • Notes which NEXT_PUBLIC_* values are compiled into the client bundle and therefore public

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

Stellar WaveIssues in the Stellar wave programdocumentationImprovements or additions to documentationdx

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions