khanh.pndc/open-webui-docs
1
0
Fork 0
mirror of https://github.com/open-webui/docs.git synced 2025-12-12 07:29:49 +07:00
Code Issues Packages Projects Releases Wiki Activity

refac

Browse Source
This commit is contained in:
Timothy Jaeryang Baek
2025-10-03 23:55:05 -05:00
parent e1d92740a9
commit e59b6fb02c
7 changed files with 9 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/features/auth/scim.mdx
View File

@@ -186,4 +186,4 @@ SCIM works best when combined with SSO (Single Sign-On). A typical setup include
This ensures users are automatically created and can immediately authenticate using their corporate credentials.
For SSO configuration, see the [SSO documentation](https://docs.openwebui.com/features/sso/).
For SSO configuration, see the [SSO documentation](https://docs.openwebui.com/features/auth/).

2
docs/features/index.mdx
View File

@@ -412,7 +412,7 @@ import { TopBanners } from "@site/src/components/TopBanners";
- 🔒 **Backend Reverse Proxy Support**: Bolster security through direct communication between Open WebUI's backend and Ollama. This key feature eliminates the need to expose Ollama over the local area network (LAN). Requests made to the `/ollama/api` route from Open WebUI are seamlessly redirected to Ollama from the backend, enhancing overall system security and providing an additional layer of protection.
- 🔒 **Authentication**: Please note that Open WebUI does not natively support federated authentication schemes such as SSO, OAuth, SAML, or OIDC. However, it can be configured to delegate authentication to an authenticating reverse proxy, effectively achieving a Single Sign-On (`SSO`) experience. This setup allows you to centralize user authentication and management, enhancing security and user convenience. By integrating Open WebUI with an authenticating reverse proxy, you can leverage existing authentication systems and streamline user access to Open WebUI. For more information on configuring this feature, please refer to the [Federated Authentication Support](https://docs.openwebui.com/features/sso).
- 🔒 **Authentication**: Please note that Open WebUI does not natively support federated authentication schemes such as SSO, OAuth, SAML, or OIDC. However, it can be configured to delegate authentication to an authenticating reverse proxy, effectively achieving a Single Sign-On (`SSO`) experience. This setup allows you to centralize user authentication and management, enhancing security and user convenience. By integrating Open WebUI with an authenticating reverse proxy, you can leverage existing authentication systems and streamline user access to Open WebUI. For more information on configuring this feature, please refer to the [Federated Authentication Support](https://docs.openwebui.com/features/auth).
- 🔓 **Optional Authentication**: Enjoy the flexibility of disabling authentication by setting `WEBUI_AUTH` to `False`. This is an ideal solution for fresh installations without existing users or can be useful for demonstration purposes.

2
docs/features/pipelines/valves.md
View File

@@ -5,7 +5,7 @@ title: "⚙️ Valves"
# Valves
`Valves` (see the dedicated [Valves & UserValves](../features/plugin/valves/index.mdx) page) can also be set for `Pipeline`. In short, `Valves` are input variables that are set per pipeline.
`Valves` (see the dedicated [Valves & UserValves](/features/plugin/valves) page) can also be set for `Pipeline`. In short, `Valves` are input variables that are set per pipeline.
`Valves` are set as a subclass of the `Pipeline` class, and initialized as part of the `__init__` method of the `Pipeline` class.

2
docs/features/plugin/tools/development.mdx
View File

@@ -67,7 +67,7 @@ Below is a list of optional arguments your tools can depend on:
- `__model__`: A dictionary with model information
- `__oauth_token__`: A dictionary containing the user's valid, automatically refreshed OAuth token payload. This is the **new, recommended, and secure** way to access user tokens for making authenticated API calls. The dictionary typically contains `access_token`, `id_token`, and other provider-specific data.
For more information about `__oauth_token__` and how to configure this token to be sent to tools, check out the OAuth section in the [environment variable docs page](https://docs.openwebui.com/getting-started/env-configuration/) and the [SSO documentation](https://docs.openwebui.com/features/sso/).
For more information about `__oauth_token__` and how to configure this token to be sent to tools, check out the OAuth section in the [environment variable docs page](https://docs.openwebui.com/getting-started/env-configuration/) and the [SSO documentation](https://docs.openwebui.com/features/auth/).
Just add them as argument to any method of your Tool class just like `__user__` in the example above.

6
docs/getting-started/env-configuration.mdx
View File

@@ -3070,18 +3070,18 @@ In any production environment running more than one instance of Open WebUI (e.g.
#### `WEBUI_AUTH_TRUSTED_EMAIL_HEADER`
- Type: `str`
- Description: Defines the trusted request header for authentication. See [SSO docs](/features/sso).
- Description: Defines the trusted request header for authentication. See [SSO docs](/features/auth).
#### `WEBUI_AUTH_TRUSTED_NAME_HEADER`
- Type: `str`
- Description: Defines the trusted request header for the username of anyone registering with the
`WEBUI_AUTH_TRUSTED_EMAIL_HEADER` header. See [SSO docs](/features/sso).
`WEBUI_AUTH_TRUSTED_EMAIL_HEADER` header. See [SSO docs](/features/auth).
#### `WEBUI_AUTH_TRUSTED_GROUPS_HEADER`
- Type: `str`
- Description: Defines the trusted request header containing a comma-separated list of group memberships for the user when using trusted header authentication. See [SSO docs](/features/sso).
- Description: Defines the trusted request header containing a comma-separated list of group memberships for the user when using trusted header authentication. See [SSO docs](/features/auth).
### Google

2
docs/tutorials/integrations/okta-oidc-sso.md
View File

@@ -180,5 +180,5 @@ Restart your Open WebUI instance after setting these environment variables.
* **Groups Not Syncing:** Verify that the `OAUTH_GROUP_CLAIM` environment variable matches the claim name configured in the Okta ID Token settings. Ensure the user has logged out and back in after group changes - a login flow is required to update OIDC. Remember admin groups are not synced.
* **Configuration Errors:** Review the Open WebUI server logs for detailed error messages related to OIDC configuration.
* Refer to the official [Open WebUI SSO Documentation](/features/sso).
* Refer to the official [Open WebUI SSO Documentation](/features/auth).
* Consult the [Okta Developer Documentation](https://developer.okta.com/docs/).

2
docs/tutorials/offline-mode.md
View File

@@ -70,7 +70,7 @@ The default local transformer can already handle the text-to-speech function. If
### I: Embedding Model
For various purposes, you will need an embedding model (e.g. [RAG](/docs/features/rag.md)). You will first have to download such a model of your choice (e.g. [Huggingface - sentence-transformers](https://huggingface.co/sentence-transformers)).
For various purposes, you will need an embedding model (e.g. [RAG](/features/rag.md)). You will first have to download such a model of your choice (e.g. [Huggingface - sentence-transformers](https://huggingface.co/sentence-transformers)).
```python
from huggingface_hub import snapshot_download