From 452b5fd9a6111bccb17a1017e64981ec7ca42192 Mon Sep 17 00:00:00 2001 From: Classic298 <27028174+Classic298@users.noreply.github.com> Date: Tue, 25 Nov 2025 15:39:37 +0100 Subject: [PATCH 1/7] Update env-configuration.mdx --- docs/getting-started/env-configuration.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/getting-started/env-configuration.mdx b/docs/getting-started/env-configuration.mdx index 92203c4..785e02d 100644 --- a/docs/getting-started/env-configuration.mdx +++ b/docs/getting-started/env-configuration.mdx @@ -12,7 +12,7 @@ As new variables are introduced, this page will be updated to reflect the growin :::info -This page is up-to-date with Open WebUI release version [v0.6.39](https://github.com/open-webui/open-webui/releases/tag/v0.6.39), but is still a work in progress to later include more accurate descriptions, listing out options available for environment variables, defaults, and improving descriptions. +This page is up-to-date with Open WebUI release version [v0.6.41](https://github.com/open-webui/open-webui/releases/tag/v0.6.41), but is still a work in progress to later include more accurate descriptions, listing out options available for environment variables, defaults, and improving descriptions. ::: From 5c1b5fd2425fa72d5ec2fb644284eef59d215f0d Mon Sep 17 00:00:00 2001 From: gerhardj-b <110168424+gerhardj-b@users.noreply.github.com> Date: Wed, 26 Nov 2025 12:45:24 +0000 Subject: [PATCH 2/7] Update description of OAUTH_ROLES_SEPARATOR to reflect updated behavior --- docs/features/auth/sso/index.mdx | 2 +- docs/getting-started/env-configuration.mdx | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/features/auth/sso/index.mdx b/docs/features/auth/sso/index.mdx index 4c5075d..72395c7 100644 --- a/docs/features/auth/sso/index.mdx +++ b/docs/features/auth/sso/index.mdx @@ -139,7 +139,7 @@ You can configure the following environment variables to match the roles returne 1. `OAUTH_ROLES_CLAIM` - The claim that contains the roles. Defaults to `roles`. Can also be nested, for example `user.roles`. 1. `OAUTH_ALLOWED_ROLES` - A comma-separated list of roles that are allowed to log in (receive open webui role `user`). 1. `OAUTH_ADMIN_ROLES` - A comma-separated list of roles that are allowed to log in as an admin (receive open webui role `admin`). -1. `OAUTH_ROLES_SEPARATOR` - Allows specifying an alternative sparator for the `OAUTH_*_ROLES` variables. +1. `OAUTH_ROLES_SEPARATOR` - Allows specifying an alternative separator for the `OAUTH_*_ROLES` variables. If the claim is a string and it contains the separator, it will be also split by that separator. :::info diff --git a/docs/getting-started/env-configuration.mdx b/docs/getting-started/env-configuration.mdx index 785e02d..4df7e42 100644 --- a/docs/getting-started/env-configuration.mdx +++ b/docs/getting-started/env-configuration.mdx @@ -4251,7 +4251,7 @@ If `OAUTH_PICTURE_CLAIM` is set to `''` (empty string), then the OAuth picture c - Type: `str` - Default: `,` -- Description: Allows custom role separators for for splitting the `OAUTH_*_ROLES` variables. Meant for OAuth roles that contain commas; useful for roles specified in LDAP syntax or other systems where commas are part of role names. +- Description: Allows custom role separators for for splitting the `OAUTH_*_ROLES` variables. Meant for OAuth roles that contain commas; useful for roles specified in LDAP syntax or other systems where commas are part of role names. If the claim is a string and contains the separator, it will be also split by that separator. #### `OAUTH_GROUPS_SEPARATOR` From c935dc5b295da7d2d828c03a2dc8df044870e451 Mon Sep 17 00:00:00 2001 From: Classic298 <27028174+Classic298@users.noreply.github.com> Date: Thu, 27 Nov 2025 08:35:21 +0100 Subject: [PATCH 3/7] Update env-configuration.mdx --- docs/getting-started/env-configuration.mdx | 27 ++++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/docs/getting-started/env-configuration.mdx b/docs/getting-started/env-configuration.mdx index 4df7e42..adbb534 100644 --- a/docs/getting-started/env-configuration.mdx +++ b/docs/getting-started/env-configuration.mdx @@ -1055,6 +1055,12 @@ This variable replaces the deprecated `ENABLE_API_KEY` environment variable. ::: +:::info + +For API Key creation (and the API keys themselves) to work, you not only need to enable it globally, but also give specific user groups the permission for it + +::: + #### `ENABLE_API_KEYS_ENDPOINT_RESTRICTIONS` - Type: `bool` @@ -4547,11 +4553,32 @@ If `OAUTH_PICTURE_CLAIM` is set to `''` (empty string), then the OAuth picture c - Description: Enables or disables user permission to use code interpreter feature. - Persistence: This environment variable is a `PersistentConfig` variable. +#### `USER_PERMISSIONS_FEATURES_FOLDERS` + +- Type: `str` +- Default: `True` +- Description: Enables or disables the visibility of the Folders feature (chat sidebar) to users. +- Persistence: This environment variable is a `PersistentConfig` variable. + +#### `USER_PERMISSIONS_FEATURES_NOTES` + +- Type: `str` +- Default: `True` +- Description: Enables or disables the visibility of the Notes feature to users. +- Persistence: This environment variable is a `PersistentConfig` variable. + #### `USER_PERMISSIONS_FEATURES_API_KEYS` - Type: `bool` - Default: `False` - Description: Sets the permission for API key creation feature for users. When enabled, users will have the ability to create and manage API keys for programmatic access. +- Persistence: This environment variable is a `PersistentConfig` variable. + +:::info + +For API Key creation (and the API keys themselves) to work, you not only need to give specific user groups the permission for it, but also enable it globally using `ENABLE_API_KEYS` + +::: ### Workspace Permissions From 25cbeab93ea7fdfda3dc248bf0752c9881dde776 Mon Sep 17 00:00:00 2001 From: Classic298 <27028174+Classic298@users.noreply.github.com> Date: Sun, 30 Nov 2025 14:58:06 +0100 Subject: [PATCH 4/7] Update env-configuration.mdx --- docs/getting-started/env-configuration.mdx | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/getting-started/env-configuration.mdx b/docs/getting-started/env-configuration.mdx index adbb534..9468e42 100644 --- a/docs/getting-started/env-configuration.mdx +++ b/docs/getting-started/env-configuration.mdx @@ -4567,6 +4567,13 @@ If `OAUTH_PICTURE_CLAIM` is set to `''` (empty string), then the OAuth picture c - Description: Enables or disables the visibility of the Notes feature to users. - Persistence: This environment variable is a `PersistentConfig` variable. +#### `USER_PERMISSIONS_FEATURES_CHANNELS` + +- Type: `str` +- Default: `True` +- Description: Enables or disables the ability for users to create their own group channels. +- Persistence: This environment variable is a `PersistentConfig` variable. + #### `USER_PERMISSIONS_FEATURES_API_KEYS` - Type: `bool` From 5f47e7dd90a56825b0ec5d72bead71c0604492d6 Mon Sep 17 00:00:00 2001 From: Classic298 <27028174+Classic298@users.noreply.github.com> Date: Mon, 1 Dec 2025 12:59:25 +0100 Subject: [PATCH 5/7] Update perplexity_search.mdx --- docs/features/web-search/perplexity_search.mdx | 18 +++++++++++++++--- 1 file changed, 15 insertions(+), 3 deletions(-) diff --git a/docs/features/web-search/perplexity_search.mdx b/docs/features/web-search/perplexity_search.mdx index 571b607..a347afd 100644 --- a/docs/features/web-search/perplexity_search.mdx +++ b/docs/features/web-search/perplexity_search.mdx @@ -25,8 +25,20 @@ Perplexity Search API is just a search engine, as opposed to the Perplexity inte 4. Enter your Perplexity API key from [Perplexity API Key management](https://www.perplexity.ai/account/api/keys). 5. Press save -:::tip +### Using LiteLLM for Search -LiteLLM's `/search` endpoint uses the Perplexity Search API style - you can customize the API endpoint of Open WebUI's perplexity_search web search to point to your LiteLLM instance and use that for web searches! +You can use a [LiteLLM](https://docs.litellm.ai/) proxy instance as your search provider instead of connecting directly to Perplexity. LiteLLM's `/search` endpoint is compatible with the Perplexity Search API style used by Open WebUI. -::: +To configure this: + +1. Follow the setup steps above, selecting `perplexity_search` as the engine. +2. Under the **Perplexity Search API Base URL** field, replace the default URL with your LiteLLM endpoint. +3. The URL must follow this specific format: `http:///search/` - Ensurethe search provider name matches the provider name you configured in your LiteLLM setup. + +**Example:** + +If your LiteLLM instance is running on localhost and you want to use the `perplexity-search` provider defined in your LiteLLM config: + +``` +http://localhost:4000/search/perplexity-search +``` From d076d910179e237ebb013fae309949a524097ea7 Mon Sep 17 00:00:00 2001 From: Classic298 <27028174+Classic298@users.noreply.github.com> Date: Mon, 1 Dec 2025 13:01:19 +0100 Subject: [PATCH 6/7] Update env-configuration.mdx --- docs/getting-started/env-configuration.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/getting-started/env-configuration.mdx b/docs/getting-started/env-configuration.mdx index 9468e42..83ecf74 100644 --- a/docs/getting-started/env-configuration.mdx +++ b/docs/getting-started/env-configuration.mdx @@ -3104,8 +3104,8 @@ the search query. Example: `http://searxng.local/search?q=` - Type: `str` - Default: `https://api.perplexity.ai/search` -- Description: Configures the API endpoint for Perplexity Search. Allows using custom or self-hosted Perplexity-compatible API endpoints (such as LiteLLM's `/search` endpoint) instead of the hardcoded default. This enables flexibility in routing search requests to alternative providers or internal proxies. -- Example: `my-litellm-server.com/search` +- Description: Configures the API endpoint for Perplexity Search. Allows using custom or self-hosted Perplexity-compatible API endpoints (such as LiteLLM's `/search` endpoint) instead of the hardcoded default for the official Perplexity API. This enables flexibility in routing search requests to alternative providers or internal proxies. **Note: If using LiteLLM, append the specific provider name to the URL path.** +- Example: `http://my-litellm-server.com/search/perplexity-search` - Persistence: This environment variable is a `PersistentConfig` variable. #### `PERPLEXITY_MODEL` From 58901d0376ad0a3f45847b124301cd1cc2489fb8 Mon Sep 17 00:00:00 2001 From: Classic298 <27028174+Classic298@users.noreply.github.com> Date: Tue, 2 Dec 2025 09:45:48 +0100 Subject: [PATCH 7/7] Update env-configuration.mdx --- docs/getting-started/env-configuration.mdx | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/getting-started/env-configuration.mdx b/docs/getting-started/env-configuration.mdx index 83ecf74..5dec0df 100644 --- a/docs/getting-started/env-configuration.mdx +++ b/docs/getting-started/env-configuration.mdx @@ -2208,7 +2208,7 @@ The old individual environment variables (`DOCLING_OCR_ENGINE`, `DOCLING_OCR_LAN - `do_ocr` (bool): Enable OCR processing - `force_ocr` (bool): Force OCR even when text layer exists - `ocr_engine` (str): OCR engine to use (`tesseract`, `easyocr`, `ocrmac`, `rapidocr`, `tesserocr`) - - `ocr_lang` (str): OCR language codes (e.g., `eng,fra,deu,spa`) + - `ocr_lang` (list[str]): OCR language codes (e.g., `["en", "de", "fr"]`) - `pdf_backend` (str): PDF processing backend - `table_mode` (str): Table extraction mode - `pipeline` (str): Processing pipeline to use @@ -2223,8 +2223,10 @@ The old individual environment variables (`DOCLING_OCR_ENGINE`, `DOCLING_OCR_LAN { "do_ocr": true, "ocr_engine": "tesseract", - "ocr_lang": "eng,fra,deu,spa", + "ocr_lang": ["eng", "fra", "deu", "spa"], "force_ocr": false, + "pdf_backend": "dlparse_v4", + "table_mode": "accurate", "do_picture_description": true, "picture_description_mode": "api", "vlm_pipeline_model_api": "openai://gpt-4o"