Skip to content

Commit ca9ab27

Browse files
committed
refac: sso
1 parent 66a17e4 commit ca9ab27

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

docs/features/sso/index.mdx

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -28,17 +28,17 @@ You cannot have Microsoft **and** Google as providers simultaneously.
2828

2929
:::
3030

31-
## OAuth
32-
33-
There are several global configuration options for OAuth in general:
34-
35-
1. `ENABLE_OAUTH_SIGNUP` - if `true`, allows accounts to be created when logging in with OAuth. Distinct from `ENABLE_SIGNUP`.
36-
1. `OAUTH_MERGE_ACCOUNTS_BY_EMAIL` - allows logging into an account that matches the email address provided by the OAuth provider.
37-
- This is considered insecure as not all OAuth providers verify email addresses, and may allow accounts to be hijacked.
38-
1. `OAUTH_UPDATE_PICTURE_ON_LOGIN` - if `true`, users will have OAuth-provided profile pictures updated on login.
39-
- If the OAuth picture claim is disabled by setting `OAUTH_PICTURE_CLAIM` to the empty string, this configuration will be ignored.
40-
1. `OAUTH_PICTURE_CLAIM` - can be used to customize or disable profile picture storage. The default, `picture`, will work for most providers; if set to the empty string, all users will receive the default person profile picture.
41-
1. `WEBUI_AUTH_SIGNOUT_REDIRECT_URI` - can be set to optionally forward the user to a specific URI after logging out.
31+
## OAuth Configuration Overview
32+
33+
| Environment Variable | Default | Description |
34+
|---------------------------------------|-----------|-----------------------------------------------------------------------------------------------------------------------------------------|
35+
| `WEBUI_URL` || **Required.** Your public WebUI address, e.g., `http://localhost:8080`. |
36+
| `ENABLE_OAUTH_PERSISTENT_CONFIG` | `true` | Persist OAuth config to the database; set to `false` for stateless/containerized environments. |
37+
| `ENABLE_OAUTH_SIGNUP` | `false` | Allows account creation upon OAuth login (separate from `ENABLE_SIGNUP`). |
38+
| `OAUTH_MERGE_ACCOUNTS_BY_EMAIL` | `false` | Merge OAuth logins based on matching email (⚠️ caution: can be insecure if provider doesn't verify emails). |
39+
| `OAUTH_UPDATE_PICTURE_ON_LOGIN` | `true` | Update user profile pictures from OAuth provider with each login. |
40+
| `OAUTH_PICTURE_CLAIM` | `picture` | Field in the claim containing the profile picture. Set to empty string to disable picture updates (users receive default icon). |
41+
| `WEBUI_AUTH_SIGNOUT_REDIRECT_URI` | *empty* | Redirect users to this URL after signout. E.g., `https://your-company.com/logout-success` |
4242

4343
### Google
4444

0 commit comments

Comments
 (0)