docs: Document the Serverpod Cloud email identity provider default#707
Open
marcelomendoncasoares wants to merge 5 commits into
Open
docs: Document the Serverpod Cloud email identity provider default#707marcelomendoncasoares wants to merge 5 commits into
marcelomendoncasoares wants to merge 5 commits into
Conversation
Move the endpoint and migration step out of the custom provider branch, where a reader following the Serverpod Cloud path would never see it, and fold the parameter list back into the section it documents. Split the dense Cloud delivery paragraphs and drop the appDisplayName length limit, which the API already enforces.
The page read as if ServerpodCloudEmailIdpConfig pointed at a transactional email service that any server could use. It does not: the delivery is part of the Serverpod Cloud platform, and the key it authenticates with is injected into the deployed instance and is not obtainable anywhere else. Say so where a self-hosted reader would otherwise pick the wrong configuration and find out in production.
Cut the explanation block that had grown at the top of the page and the one under Server-side configuration. The generated configuration is now the single path through the page, followed by the endpoint and migration step, with the Cloud-only scope and the delivery failure behavior as short hooks where a reader runs into them. Move the custom provider to a variant section at the end, and leave the Cloud passwords page alone.
marcelomendoncasoares
force-pushed
the
docs/cloud-email-idp
branch
from
July 21, 2026 21:47
852082d to
51d00a0
Compare
marcelomendoncasoares
marked this pull request as ready for review
July 21, 2026 21:47
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
1 participant
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
Newly generated projects register
ServerpodCloudEmailIdpConfig, not theEmailIdpConfigthe setup page described. A reader following the page saw a configuration that does not match theirserver.dartand had nothing explaining where the emails actually come from.Changes
ServerpodCloudEmailIdpConfig:appDisplayName, codes logged indevelopmentandtest, and email sent instagingandproduction.scloudAuthEmailKeyinjection on deploy, and the lazy lookup that lets a self-hosted server start without it.EmailIdpConfigFromPasswordswith themailerexample, and move the pepper into the parameter list where it now comes from.scloudAuthEmailKey, linked to the setup page.Reference
🤖 Generated with Claude Code