Document environment variables in README #37
Merged
Conversation
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
Co-authored-by: dillonu <dillonu@gmail.com>
Co-authored-by: dillonu <dillonu@gmail.com>
Co-authored-by: dillonu <dillonu@gmail.com>
Co-authored-by: dillonu <dillonu@gmail.com>
Co-authored-by: dillonu <dillonu@gmail.com>
There was a problem hiding this comment.
Pull Request Overview
This PR adds documentation for the project's environment variables in the README and removes a duplicate configuration entry from the config loader.
- Removed a duplicate environment variable check in src/config/index.ts
- Added a new "Environment Variables" documentation section in README.md with detailed tables
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| src/config/index.ts | Removed duplicate check for AUTH_FAILURE_LOCKOUT_THRESHOLD |
| README.md | Added a new Environment Variables section with formatted tables to document supported variables |
Comments suppressed due to low confidence (2)
README.md:162
- [nitpick] Consider renaming ALLOW_UNSECURE to ALLOW_INSECURE or ALLOW_INSECURE_CONNECTIONS to improve clarity.
| `ALLOW_UNSECURE` | Allow unsecure connections | |
README.md:158
- Consider specifying a default value or indicating that the field is optional for WSS_PORT to avoid potential confusion.
| `WSS_PORT` | WebSocket Secure server port | |
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.
This pull request contains changes generated by Cursor background composer.