This commit is contained in:
DrMelone
2026-02-14 01:19:41 +01:00
parent 380196a2b9
commit 583d65e13b
153 changed files with 388 additions and 513 deletions

View File

@@ -1,5 +1,4 @@
---
slug: /getting-started/api-endpoints
sidebar_position: 400
title: "API Endpoints"
---
@@ -216,7 +215,7 @@ The `outlet()` function only runs when the WebUI calls `/api/chat/completed` aft
```
:::tip
For more details on writing filters that work with API requests, see the [Filter Function documentation](/features/plugin/functions/filter#-filter-behavior-with-api-requests).
For more details on writing filters that work with API requests, see the [Filter Function documentation](/features/extensibility/plugin/functions/filter#-filter-behavior-with-api-requests).
:::
### 🦙 Ollama API Proxy Support

View File

@@ -1,5 +1,4 @@
---
slug: /getting-started/env-configuration
sidebar_position: 1
title: "Environment Variable Configuration"
---
@@ -159,7 +158,7 @@ After the admin account is created, sign-up is automatically disabled for securi
:::danger
This should **only** ever be set to `False` when [ENABLE_OAUTH_SIGNUP](https://docs.openwebui.com/getting-started/env-configuration/#enable_oauth_signup)
This should **only** ever be set to `False` when [ENABLE_OAUTH_SIGNUP](https://docs.openwebui.com/reference/env-configuration/#enable_oauth_signup)
is also being used and set to `True`. **Never disable this if OAUTH/SSO is not being used.** Failure to do so will result in the inability to login.
:::
@@ -250,7 +249,7 @@ is also being used and set to `True`. **Never disable this if OAUTH/SSO is not b
- Type: `bool`
- Default: `True`
- Description: Enables or disables the [memory feature](/features/memory), allowing models to store and retrieve long-term information about users.
- Description: Enables or disables the [memory feature](/features/chat-conversations/memory), allowing models to store and retrieve long-term information about users.
- Persistence: This environment variable is a `PersistentConfig` variable.
#### `WEBHOOK_URL`
@@ -1238,7 +1237,7 @@ For API Key creation (and the API keys themselves) to work, you need **both**:
1. Enable API keys globally using this setting (`ENABLE_API_KEYS`)
2. Grant the "API Keys" permission to users via Default Permissions or User Groups
**Note:** Administrators are not exempt—they must also be granted the permission via a User Group to use API keys. See the [Authentication Setup for API Key](/getting-started/advanced-topics/monitoring#authentication-setup-for-api-key-) guide for detailed setup instructions.
**Note:** Administrators are not exempt—they must also be granted the permission via a User Group to use API keys. See the [Authentication Setup for API Key](/reference/monitoring#authentication-setup-for-api-key-) guide for detailed setup instructions.
:::
@@ -1360,7 +1359,7 @@ If enabled, the following headers are forwarded:
- `X-OpenWebUI-Chat-Id`
- `X-OpenWebUI-Message-Id`
This enables per-user authorization, auditing, rate limiting, and request tracing on external services. The chat and message ID headers are also required for [external tool event emitting](/features/plugin/development/events#-external-tool-events).
This enables per-user authorization, auditing, rate limiting, and request tracing on external services. The chat and message ID headers are also required for [external tool event emitting](/features/extensibility/plugin/development/events#-external-tool-events).
#### `FORWARD_USER_INFO_HEADER_USER_NAME`
@@ -1396,7 +1395,7 @@ This enables per-user authorization, auditing, rate limiting, and request tracin
- Type: `str`
- Default: `X-OpenWebUI-Message-Id`
- Description: Customizes the header name used to forward the current message ID. This header is required for [external tool event emitting](/features/plugin/development/events#-external-tool-events).
- Description: Customizes the header name used to forward the current message ID. This header is required for [external tool event emitting](/features/extensibility/plugin/development/events#-external-tool-events).
:::tip Custom Header Prefix
Use these variables when integrating with services that require specific header naming conventions. For example, AWS Bedrock AgentCore requires headers prefixed with `X-Amzn-Bedrock-AgentCore-Runtime-Custom-`:
@@ -1608,7 +1607,7 @@ If `OFFLINE_MODE` is enabled, this `ENABLE_VERSION_UPDATE_CHECK` flag is always
- OAuth authentication providers
- Web search and RAG with external APIs
Read more about `offline mode` in the [offline mode guide](/tutorials/offline-mode).
Read more about `offline mode` in the [offline mode guide](/tutorials/maintenance/offline-mode).
:::
@@ -2752,7 +2751,7 @@ Provide a clear and direct response to the user's query, including inline citati
- Type: `int`
- Default: `0`
- Description: Chunks smaller than this threshold will be intelligently merged with neighboring chunks when possible. This helps prevent tiny, low-quality fragments that can hurt retrieval performance and waste embedding resources. This feature only works when `ENABLE_MARKDOWN_HEADER_TEXT_SPLITTER` is enabled. Set to `0` to disable merging. For more information on the benefits and configuration, see the [RAG guide](/features/rag#chunking-configuration).
- Description: Chunks smaller than this threshold will be intelligently merged with neighboring chunks when possible. This helps prevent tiny, low-quality fragments that can hurt retrieval performance and waste embedding resources. This feature only works when `ENABLE_MARKDOWN_HEADER_TEXT_SPLITTER` is enabled. Set to `0` to disable merging. For more information on the benefits and configuration, see the [RAG guide](/features/chat-conversations/rag#chunking-configuration).
- Persistence: This environment variable is a `PersistentConfig` variable.
#### `RAG_TEXT_SPLITTER`
@@ -3402,7 +3401,7 @@ the search query. Example: `http://searxng.local/search?q=<query>`
:::info
Brave's free tier enforces a rate limit of 1 request per second. Open WebUI automatically retries requests that receive HTTP 429 rate limit errors after a 1-second delay. For free tier users, set `WEB_SEARCH_CONCURRENT_REQUESTS` to `1` to ensure sequential request processing. See the [Brave web search documentation](/features/web-search/brave) for more details.
Brave's free tier enforces a rate limit of 1 request per second. Open WebUI automatically retries requests that receive HTTP 429 rate limit errors after a 1-second delay. For free tier users, set `WEB_SEARCH_CONCURRENT_REQUESTS` to `1` to ensure sequential request processing. See the [Brave web search documentation](/features/chat-conversations/web-search/providers/brave) for more details.
:::
@@ -4240,7 +4239,7 @@ Strictly return in JSON format:
:::tip
For a detailed setup guide and example configuration, please refer to the [Gemini Image Generation Guide](/features/image-generation-and-editing/gemini).
For a detailed setup guide and example configuration, please refer to the [Gemini Image Generation Guide](/features/media-generation/image-generation-and-editing/gemini).
:::
@@ -4615,18 +4614,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/auth/sso).
- Description: Defines the trusted request header for authentication. See [SSO docs](/features/access-security/auth/sso).
#### `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/auth/sso).
`WEBUI_AUTH_TRUSTED_EMAIL_HEADER` header. See [SSO docs](/features/access-security/auth/sso).
#### `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/auth/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/access-security/auth/sso).
### Google
@@ -5247,7 +5246,7 @@ This is useful when you need a JWT access token for downstream validation or whe
- Type: `str`
- Default: `True`
- Description: Enables or disables user permission to use the [memory feature](/features/memory).
- Description: Enables or disables user permission to use the [memory feature](/features/chat-conversations/memory).
- Persistence: This environment variable is a `PersistentConfig` variable.
#### `USER_PERMISSIONS_FEATURES_FOLDERS`
@@ -5284,7 +5283,7 @@ For API Key creation (and the API keys themselves) to work, you need **both**:
1. Grant the "API Keys" permission to users via this setting or User Groups
2. Enable API keys globally using `ENABLE_API_KEYS`
**Note:** Administrators are not exempt—they must also be granted the permission via a User Group to use API keys. See the [Authentication Setup for API Key](/getting-started/advanced-topics/monitoring#authentication-setup-for-api-key-) guide for detailed setup instructions.
**Note:** Administrators are not exempt—they must also be granted the permission via a User Group to use API keys. See the [Authentication Setup for API Key](/reference/monitoring#authentication-setup-for-api-key-) guide for detailed setup instructions.
:::

View File

@@ -1,5 +1,4 @@
---
slug: /getting-started/advanced-topics/https-encryption
sidebar_position: 6
title: "Enabling HTTPS Encryption"
---

View File

@@ -1,5 +1,4 @@
---
slug: /getting-started/advanced-topics/monitoring
sidebar_position: 6
title: "API Keys & Monitoring"
---
@@ -70,7 +69,7 @@ To go beyond basic availability, you can monitor the `/api/models` endpoint. Thi
**API Endpoint Details:**
See the [Open WebUI API documentation](https://docs.openwebui.com/getting-started/api-endpoints/#-retrieve-all-models) for full details about the `/api/models` endpoint and its response structure.
See the [Open WebUI API documentation](https://docs.openwebui.com/reference/api-endpoints/#-retrieve-all-models) for full details about the `/api/models` endpoint and its response structure.
**How to Test with `curl` (Authenticated):**
@@ -181,8 +180,8 @@ This approach limits the potential impact if the monitoring API key is compromis
If you don't see the API key generation option in your account settings:
- **Check global setting**: Verify that an administrator has enabled API keys globally under **Admin Panel** > **Settings** > **General** > **Enable API Keys**. See [`ENABLE_API_KEYS`](/getting-started/env-configuration#enable_api_keys).
- **Check your permissions**: Verify that your user account or group has been granted the "API Keys" feature permission under **Features Permissions**. See [`USER_PERMISSIONS_FEATURES_API_KEYS`](/getting-started/env-configuration#user_permissions_features_api_keys).
- **Check global setting**: Verify that an administrator has enabled API keys globally under **Admin Panel** > **Settings** > **General** > **Enable API Keys**. See [`ENABLE_API_KEYS`](/reference/env-configuration#enable_api_keys).
- **Check your permissions**: Verify that your user account or group has been granted the "API Keys" feature permission under **Features Permissions**. See [`USER_PERMISSIONS_FEATURES_API_KEYS`](/reference/env-configuration#user_permissions_features_api_keys).
### Using Uptime Kuma for Model Connectivity Monitoring 🐻

View File

@@ -1,5 +1,4 @@
---
slug: /getting-started/advanced-topics/monitoring/opentelemetry
sidebar_position: 7
title: "OpenTelemetry"
---

View File

@@ -1,5 +1,4 @@
---
slug: /getting-started/advanced-topics/network-diagrams
sidebar_position: 3
title: "Network Diagrams"
---