OpenWebUI/docs
1
0
Fork 0
mirror of https://github.com/open-webui/docs synced 2025-05-20 19:26:22 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Update SSO environment for Github OAuth

Browse Source
This commit is contained in:
Tryanks 2025-02-11 13:05:19 +08:00
parent fa81465a73
commit cc3c38b8a8
2 changed files with 41 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
docs/features/sso.md
View File

@ -10,6 +10,7 @@ Open WebUI supports several forms of federated authentication:
1. OAuth2 1. OAuth2
1. Google 1. Google
1. Microsoft 1. Microsoft
1. Github
1. OIDC 1. OIDC
1. Trusted Header 1. Trusted Header
@ -44,6 +45,16 @@ The following environment variables are required:
1. `MICROSOFT_CLIENT_SECRET` - Microsoft OAuth client secret 1. `MICROSOFT_CLIENT_SECRET` - Microsoft OAuth client secret
1. `MICROSOFT_CLIENT_TENANT_ID` - Microsoft tenant ID - use `9188040d-6c67-4c5b-b112-36a304b66dad` for personal accounts 1. `MICROSOFT_CLIENT_TENANT_ID` - Microsoft tenant ID - use `9188040d-6c67-4c5b-b112-36a304b66dad` for personal accounts
### Github
To configure a Github OAuth Client, please refer to [Github's documentation](https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps) on how to create a OAuth App or Github App for a **web application**.
The allowed redirect URI should include `<open-webui>/oauth/github/callback`.
The following environment variables are required:
1. `GITHUB_CLIENT_ID` - Github OAuth App Client ID
1. `GITHUB_CLIENT_SECRET` - Github OAuth App Client Secret
### OIDC ### OIDC
Any authentication provider that supports OIDC can be configured. Any authentication provider that supports OIDC can be configured.

30
docs/getting-started/env-configuration.md
View File

@ -1815,6 +1815,36 @@ See https://learn.microsoft.com/en-us/entra/identity-platform/quickstart-registe
- Description: Sets the redirect URI for Microsoft OAuth - Description: Sets the redirect URI for Microsoft OAuth
- Persistence: This environment variable is a `PersistentConfig` variable. - Persistence: This environment variable is a `PersistentConfig` variable.
### Github
See https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps
#### `GITHUB_CLIENT_ID`
- Type: `str`
- Description: Sets the client ID for Github OAuth
- Persistence: This environment variable is a `PersistentConfig` variable.
#### `GITHUB_CLIENT_SECRET`
- Type: `str`
- Description: Sets the client secret for Github OAuth
- Persistence: This environment variable is a `PersistentConfig` variable.
#### `GITHUB_OAUTH_SCOPE`
- Type: `str`
- Default: `user:email`
- Description: Sets the scope for Github OAuth authentication.
- Persistence: This environment variable is a `PersistentConfig` variable.
#### `GITHUB_CLIENT_REDIRECT_URI`
- Type: `str`
- Default: `<backend>/oauth/github/callback`
- Description: Sets the redirect URI for Github OAuth
- Persistence: This environment variable is a `PersistentConfig` variable.
### OpenID (OIDC) ### OpenID (OIDC)
#### `OAUTH_CLIENT_ID` #### `OAUTH_CLIENT_ID`