Skip to content

docs: correct OAuth persistent config defaults#1276

Closed
zuyua9 wants to merge 2 commits into
open-webui:devfrom
zuyua9:docs/sso-oauth-persistent-config-zuyua9
Closed

docs: correct OAuth persistent config defaults#1276
zuyua9 wants to merge 2 commits into
open-webui:devfrom
zuyua9:docs/sso-oauth-persistent-config-zuyua9

Conversation

@zuyua9
Copy link
Copy Markdown
Contributor

@zuyua9 zuyua9 commented May 31, 2026

Summary

  • Correct ENABLE_OAUTH_PERSISTENT_CONFIG in the SSO troubleshooting guide to match the env configuration reference and SSO guide default (true).
  • Clarify when OAuth values come from the database vs environment variables.
  • Update the Docker Compose note and troubleshooting summary so false is presented as an explicit env-only choice, not the default.

Why

The troubleshooting page currently says ENABLE_OAUTH_PERSISTENT_CONFIG defaults to false, while both the environment configuration reference and SSO guide document the default as true. This can make operators choose the wrong source of truth when debugging OAuth settings that were previously saved through the Admin Panel.

Checks

  • npx prettier --check docs/troubleshooting/sso.mdx

@Classic298 Classic298 changed the base branch from main to dev May 31, 2026 20:56
@Classic298
Copy link
Copy Markdown
Collaborator

Thanks for catching the mismatch between this guide and the env-configuration reference.

It can't go in as-is, though, because it aligns both pages on the wrong value. ENABLE_OAUTH_PERSISTENT_CONFIG defaults to false, not true:

ENABLE_OAUTH_PERSISTENT_CONFIG = os.getenv('ENABLE_OAUTH_PERSISTENT_CONFIG', 'False').lower() == 'true'

With the default false, oauth.-prefixed settings are read from environment variables and are not loaded from the database, even when ENABLE_PERSISTENT_CONFIG is true. So env vars stay authoritative for OAuth by default, which is what this page already says. Flipping it to "the database wins by default" would point people debugging OAuth in the wrong direction.

The page that was actually wrong is the env-configuration reference (it listed the default as True); that has been corrected, so both pages now agree on false and the mismatch that prompted this PR is resolved.

Closing for that reason. The comparison table was a good idea, though, feel free to resubmit it with false marked as the default row and we'll take it. Thanks again!

@Classic298 Classic298 closed this May 31, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants