Skip to content

Commit 0e3f050

Browse files
author
Zaid Marji
committed
docs: document OAUTH_AUTO_REDIRECT
Add the OAUTH_AUTO_REDIRECT environment variable to the env-variable reference (`docs/reference/env-configuration.mdx`) and the SSO configuration overview (`docs/features/authentication-access/auth/sso`). Covers the auto-redirect behavior, the single-provider requirement, and the `/auth?form=true` escape hatch.
1 parent 8dd1e81 commit 0e3f050

2 files changed

Lines changed: 14 additions & 0 deletions

File tree

docs/features/authentication-access/auth/sso/index.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ You cannot have Microsoft **and** Google as OIDC providers simultaneously.
3131
| `WEBUI_URL` || **Required.** Your public WebUI address, e.g., `http://localhost:8080`. |
3232
| `ENABLE_OAUTH_PERSISTENT_CONFIG` | `true` | Persist OAuth config to the database; set to `false` for stateless/containerized environments. |
3333
| `ENABLE_OAUTH_SIGNUP` | `false` | Allows account creation upon OAuth login (separate from `ENABLE_SIGNUP`). |
34+
| `OAUTH_AUTO_REDIRECT` | `false` | When `true` and the deployment is SSO-only — exactly one OAuth provider, `ENABLE_LOGIN_FORM=false`, `ENABLE_LDAP=false` — sends unauthenticated users from `/auth` straight to the provider, skipping the "Continue with" screen. Visit `/auth?form=true` to reach the local login form. |
3435
| `OAUTH_MERGE_ACCOUNTS_BY_EMAIL` | `false` | Merge OAuth logins based on matching email (caution: can be insecure if provider doesn't verify emails). |
3536
| `OAUTH_UPDATE_PICTURE_ON_LOGIN` | `false` | Update user profile pictures from OAuth provider with each login. |
3637
| `OAUTH_PICTURE_CLAIM` | `picture` | Field in the claim containing the profile picture. Set to empty string to disable picture updates (users receive default icon).|

docs/reference/env-configuration.mdx

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5050,6 +5050,19 @@ You can only configure one OAUTH provider at a time. You cannot have two or more
50505050

50515051
:::
50525052

5053+
#### `OAUTH_AUTO_REDIRECT`
5054+
5055+
- Type: `bool`
5056+
- Default: `False`
5057+
- Description: When `True` and the deployment is configured for SSO-only sign-in — exactly one OAuth provider configured, `ENABLE_LOGIN_FORM=false`, and `ENABLE_LDAP=false` — an unauthenticated visit to the `/auth` page is redirected straight to that provider's login, skipping the intermediate `Continue with <provider>` button. The redirect is suppressed when the local login form is explicitly requested (`/auth?form=true`), after a failed sign-in (`/auth?error=...`), for an already-authenticated session, during initial onboarding, and when trusted-header authentication is enabled. Has no effect when zero or multiple OAuth providers are configured, when the local login form or LDAP is enabled, or when the variable is set in a deployment that doesn't satisfy all of the above.
5058+
- Persistence: This environment variable is a `PersistentConfig` variable.
5059+
5060+
:::tip
5061+
5062+
Visit `/auth?form=true` to reach the local login form when `OAUTH_AUTO_REDIRECT` is enabled — useful for administrators who need password access if the OAuth provider is unavailable.
5063+
5064+
:::
5065+
50535066
#### `ENABLE_OAUTH_PERSISTENT_CONFIG`
50545067

50555068
- Type: `bool`

0 commit comments

Comments
 (0)