docs: Clarify secret access, production storage, and Cloud secrets#663
Merged
Conversation
Zfinix
reviewed
Jun 30, 2026
Zfinix
reviewed
Jun 30, 2026
Zfinix
approved these changes
Jul 1, 2026
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.
Closes #653.
The configuration docs explained how to declare secrets but not how to read them, which left a few recurring questions unanswered (the most common: "can I use
getPasswordin my Flutter app?"). This adds three subsections to the Secrets section of07-configuration.md:session.passwords['name']/session.serverpod.getPassword('name')inside endpoints, orpod.getPassword('name')at startup. ThestripeApiKeyexample threads through from where it's declared above.config/passwords.yamland credential files are gitignored by default; in production, set secrets viaSERVERPOD_PASSWORD_*env vars or your host's secret manager.scloud password set(with--from-filefor JSON credentials), linking to the Cloud passwords/secrets reference for the full story.Scope is deliberately the configuration page plus a cross-link; the Cloud side is already covered in the Cloud docs, so this doesn't duplicate it.
Verification
getPassword/session.passwordsagainst framework source (serverpod.dart,session.dart); confirmed nogetPasswordinserverpod_client(server-side only)..gitignoreentries forpasswords.yamlandfirebase_service_account_key.jsonagainst the starter template.scloud password set/--from-fileround-trip run against a live Cloud project (set, listed asSET (User), encrypted).