docs: Add docs for passwords available through env variables #297
Conversation
📝 WalkthroughWalkthroughThe documentation for Serverpod's configuration has been updated to describe support for custom passwords set via environment variables prefixed with Changes
Sequence Diagram(s)📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
⏰ Context from checks skipped due to timeout of 90000ms (1)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
docs/06-concepts/07-configuration.md (2)
82-87: Refine table formatting for code readabilityThe table entry currently escapes the underscore and doesn’t use inline code styling. To match the style of other tables and improve readability, wrap the pattern in backticks and drop the escape:
-| SERVERPOD_PASSWORD\_\* | Custom password that will be available in the Session.passwords map. The prefix `SERVERPOD_PASSWORD_` will be stripped from the key name. | +| `SERVERPOD_PASSWORD_*` | Custom password that will be available in the Session.passwords map. The prefix `SERVERPOD_PASSWORD_` will be stripped from the key name. |
84-84: Consider renaming column header for clarityThe header “Environment variable format” could be misleading. Using “Environment variable pattern” or simply “Environment variable” would better convey the wildcard usage.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/06-concepts/07-configuration.md(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Test build
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
docs/06-concepts/07-configuration.md (2)
128-134: Escape characters in table formatting
The entrySERVERPOD_PASSWORD\_\*includes backslashes to escape underscores, which is unnecessary inside code spans. Consider updating to:| `SERVERPOD_PASSWORD_*` | Custom password that will be available in the Session.passwords map. The prefix `SERVERPOD_PASSWORD_` will be stripped from the key name. |
211-223: Consolidate duplicated YAML examples
The samestripeApiKeyandtwilioApiKeyentries appear in both the "Via Passwords File" and the bottom "Passwords file example" sections. Consider merging or clarifying the purpose of each to reduce repetition and avoid reader confusion.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/06-concepts/07-configuration.md(3 hunks)
🔇 Additional comments (6)
docs/06-concepts/07-configuration.md (6)
76-80: Clarify custom secret introduction & built‐in scope
Good addition of the sentence explaining how to add custom secrets and the built-in secrets section. This clearly sets user expectations.
88-93: Document first-party package secrets
Nice to see a dedicated section for first-party package secrets. The header and bullet links are clear and helpful.
102-109: Add explicit "Custom Passwords" section
The new header and intro text effectively group the custom-secret docs. This resolves the missing section comment from earlier reviews.
110-113: Show YAML snippet for passwords file
The YAML example under "Via Passwords File" is well-formatted and highlights how to add keys undershared.
140-142: Provide environment variable export example
Clear and concise shell example showing how to set a custom password via env var.
144-154: Demonstrate accessing custom passwords in Dart
Good code snippet illustratingSession.passwordslookup. It directly ties back to the added env-var and YAML examples.
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
docs/06-concepts/07-configuration.md (2)
76-76: Refine phrasing for clarity
Consider removing the redundant “your own custom secrets” – e.g. simplify to:Define custom secrets in the passwords file by adding them to either the
sharedsection (available in all run modes) or to specific run mode sections.
216-216: Avoid duplicating YAML examples and ensure consistency
The bottom “Passwords file example” largely repeats the earlier “Via Passwords File” snippet but omits keys likestripeApiKey/myCustomSharedSecret. Consider removing this redundant block or merging it with the prior example to keep the docs DRY and consistent.Also applies to: 222-222
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/06-concepts/07-configuration.md(3 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Test build
🔇 Additional comments (1)
docs/06-concepts/07-configuration.md (1)
78-78: Built-in Secrets header level is correct
The new “#### Built-in Secrets” subsection properly nests under “### Secrets.”
Related to serverpod/serverpod#3656
This PR adds documentation for the new ability for passwords to be defined via environment variabled prefixed with
SERVERPOD_PASSWORD_Screenshot
Image
Summary by CodeRabbit
Summary by CodeRabbit