docs: align studio SSO client-id with SOCIAL_AUTH_EDX_OAUTH2_KEY default#38760
Open
feanil wants to merge 1 commit into
Open
docs: align studio SSO client-id with SOCIAL_AUTH_EDX_OAUTH2_KEY default#38760feanil wants to merge 1 commit into
feanil wants to merge 1 commit into
Conversation
The README's CMS SSO setup section uses 'studio-sso-id' as the OAuth application client ID, but instructs operators to put that same value into SOCIAL_AUTH_EDX_OAUTH2_KEY. Rename to 'studio-sso-key' so the example value matches the setting it ends up in, removing the id-vs-key confusion for first-time bare-metal setups. Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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
Renames the example client ID in the README's CMS SSO setup section from
studio-sso-idtostudio-sso-key, so that the value matches the current default forSOCIAL_AUTH_EDX_OAUTH2_KEYincms/envs/devstack.py:277(SOCIAL_AUTH_EDX_OAUTH2_KEY = 'studio-sso-key').A first-time bare-metal operator following the README would have ended up with a client ID that doesn't match the CMS's default, so they would have to override
SOCIAL_AUTH_EDX_OAUTH2_KEYin their settings overrides. After this change, the README's example values work out-of-the-box with the CMS default.