docs: add .env.example documenting backend environment variables - #302
Open
birme wants to merge 1 commit into
Open
docs: add .env.example documenting backend environment variables#302birme wants to merge 1 commit into
birme wants to merge 1 commit into
Conversation
Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
.env.exampleat the backend repo root documenting every environment variable the code actually reads (discovered viagrep process.envinsrc/).SMB_ADDRESS) and Optional (with defaults shown), each with a short comment and a placeholder example value — no real secrets.DB_CONNECTION_STRING/ legacyMONGODB_CONNECTION_STRING), server (PORT,PUBLIC_HOST,ENDPOINT_IDLE_TIMEOUT_S), SMB (SMB_APIKEY), ICE/CORS, WHIP lifecycle tuning, OSC integration, andDEBUG.!.env.examplenegation to.gitignoreso the example stays tracked while real.envremains ignored.Test plan
npm install && npm run lint— 0 errors (pre-existing warnings only).git statusconfirms.env.exampleis staged/tracked.package-lock.jsonchurn reverted.Closes #275