docs: Add docs for specifying env vars for google client secret and firebase service account key #298
Conversation
…irebase service account key
📝 WalkthroughWalkthroughThe documentation for Google and Firebase authentication providers was updated to describe an alternative way to provide credential JSON files: users can now supply the JSON contents via specific environment variables, in addition to placing files in the server's config directory. The secrets configuration documentation was expanded to include these new environment variables for authentication. Minor formatting improvements were also made to code examples. Changes
Possibly related PRs
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/11-authentication/04-providers/02-google.md (1)
43-43: Clarify multiline JSON handling for env varSetting a raw JSON string via
SERVERPOD_PASSWORD_serverpod_auth_googleClientSecretmay require escaping newlines or using base64 encoding. Consider adding guidance and an example for exporting the variable in common shells to ensure users can set it correctly.Would you like sample export commands for bash/zsh and Windows PowerShell?
docs/06-concepts/11-authentication/04-providers/05-firebase.md (1)
19-19: Clarify multiline JSON handling for env varAs with the Google provider, supplying raw JSON via
SERVERPOD_PASSWORD_serverpod_auth_firebaseServiceAccountKeymay require escaping newlines or using base64. Suggest adding notes or examples on exporting this env var (e.g.,export SERVERPOD_PASSWORD_…="$(cat file.json)"or PowerShell equivalents) to help users.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs/06-concepts/11-authentication/04-providers/02-google.md(1 hunks)docs/06-concepts/11-authentication/04-providers/05-firebase.md(2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Test build
🔇 Additional comments (1)
docs/06-concepts/11-authentication/04-providers/05-firebase.md (1)
92-93: Formatting update looks goodTrailing whitespace removal on these lines improves consistency and readability of the Dart snippet.
…bles for Serverpod Auth Server
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
docs/06-concepts/07-configuration.md (1)
88-96: Clarify JSON content expectation for auth secrets
It's helpful to specify that these environment variables should contain the full JSON credentials, not just a path or token.Consider updating the table rows as follows:
-| SERVERPOD_PASSWORD_serverpod_auth_googleClientSecret | serverpod_auth_googleClientSecret | - | The client secret for Google authentication for serverpod_auth_server | -| SERVERPOD_PASSWORD_serverpod_auth_firebaseServiceAccountKey | serverpod_auth_firebaseServiceAccountKey | - | The service account key for Firebase authentication for serverpod_auth_server | +| SERVERPOD_PASSWORD_serverpod_auth_googleClientSecret | serverpod_auth_googleClientSecret | - | The full JSON content of the Google OAuth client secret for serverpod_auth_server | +| SERVERPOD_PASSWORD_serverpod_auth_firebaseServiceAccountKey | serverpod_auth_firebaseServiceAccountKey | - | The full JSON service account key for Firebase authentication for serverpod_auth_server |
📜 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
🔇 Additional comments (2)
docs/06-concepts/07-configuration.md (2)
86-87: Approve new auth server package listing
The addition ofserverpod_auth_serverto the first-party packages list looks accurate and informative.
94-95: Verify related auth provider docs include new env vars
Ensure that the authentication provider-specific docs have been updated to reference these new environment variables.#!/bin/bash # Verify Google and Firebase provider docs mention the new env vars rg -n "SERVERPOD_PASSWORD_serverpod_auth_googleClientSecret" docs/06-concepts/11-authentication/04-providers/02-google.md rg -n "SERVERPOD_PASSWORD_serverpod_auth_firebaseServiceAccountKey" docs/06-concepts/11-authentication/04-providers/05-firebase.md
Related to serverpod/serverpod#3664
This PR aims to add documentation about the environment variables now available to define the Google Secret Client and Firebase Service Account Key
Summary by CodeRabbit