From ec7b0fefbd4b91f04a43165a7a81253e01849f17 Mon Sep 17 00:00:00 2001 From: Ken Geis Date: Thu, 6 Mar 2025 16:11:42 -0800 Subject: [PATCH 1/8] =?UTF-8?q?fix=20tools=20typo=20(withing=E2=86=92withi?= =?UTF-8?q?n)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/features/plugin/tools/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/features/plugin/tools/index.mdx b/docs/features/plugin/tools/index.mdx index 3b63016..2ee0e14 100644 --- a/docs/features/plugin/tools/index.mdx +++ b/docs/features/plugin/tools/index.mdx @@ -68,7 +68,7 @@ licence: MIT ### Tools Class -Tools have to be defined as methods withing a class called `Tools`, with optional subclasses called `Valves` and `UserValves`, for example: +Tools have to be defined as methods within a class called `Tools`, with optional subclasses called `Valves` and `UserValves`, for example: ```python class Tools: From 55580e3d96e7819f52af858bee7581fc4dfe9ef1 Mon Sep 17 00:00:00 2001 From: Ken Geis Date: Thu, 6 Mar 2025 16:14:30 -0800 Subject: [PATCH 2/8] =?UTF-8?q?fix=20typo(numberical=E2=86=92numerical)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/features/plugin/functions/tab-shared/Common.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/features/plugin/functions/tab-shared/Common.md b/docs/features/plugin/functions/tab-shared/Common.md index 2679e6d..7769fa6 100644 --- a/docs/features/plugin/functions/tab-shared/Common.md +++ b/docs/features/plugin/functions/tab-shared/Common.md @@ -16,7 +16,7 @@ Valves are configurable by admins alone and UserValves are configurable by any u default=0, description="Priority level for the filter operations." ) test_valve: int = Field( - default=4, description="A valve controlling a numberical value" + default=4, description="A valve controlling a numerical value" ) pass From 20cf658bd9f713ca0bcf0a4054927cfd8577fd92 Mon Sep 17 00:00:00 2001 From: Ken Geis Date: Thu, 6 Mar 2025 16:15:08 -0800 Subject: [PATCH 3/8] =?UTF-8?q?fix=20typo(numberical=E2=86=92numerical)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/features/plugin/tools/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/features/plugin/tools/index.mdx b/docs/features/plugin/tools/index.mdx index 3b63016..4f58b42 100644 --- a/docs/features/plugin/tools/index.mdx +++ b/docs/features/plugin/tools/index.mdx @@ -109,7 +109,7 @@ Valves are configurable by admins alone and UserValves are configurable by any u default=0, description="Priority level for the filter operations." ) test_valve: int = Field( - default=4, description="A valve controlling a numberical value" + default=4, description="A valve controlling a numerical value" ) pass From b26a4cb818ade03a937c2d30637ecfc5d4bd7f12 Mon Sep 17 00:00:00 2001 From: Nikes Date: Wed, 12 Mar 2025 23:24:43 +0200 Subject: [PATCH 4/8] feat: pip options in tools/functions install requirements --- docs/getting-started/env-configuration.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/docs/getting-started/env-configuration.md b/docs/getting-started/env-configuration.md index 9dd2fe5..c486dff 100644 --- a/docs/getting-started/env-configuration.md +++ b/docs/getting-started/env-configuration.md @@ -2199,3 +2199,17 @@ Open WebUI uses the following environment variables: - Description: Lists domain extensions (or IP addresses) for which the proxy should not be used, separated by commas. For example, setting no_proxy to '.mit.edu' ensures that the proxy is bypassed when accessing documents from MIT. + +### Install required packages + +Open WebUI provides environment variables to customize the pip installation process. Below are the environment variables used by Open WebUI for adjusting package installation behavior: + +#### `PIP_OPTIONS` + +- Type: `str` +- Description: Specifies additional command-line options that pip should use when installing packages. For example, you can include flags such as `--upgrade`, `--user`, or `--no-cache-dir` to control the installation process. + +#### `PIP_PACKAGE_INDEX_OPTIONS` + +- Type: `str` +- Description: Defines custom package index behavior for pip. This can include specifying additional or alternate index URLs (e.g., `--extra-index-url`), authentication credentials, or other parameters to manage how packages are retrieved from different locations. From 108d01c73dd96259caf45fe2739c60b0b871d55c Mon Sep 17 00:00:00 2001 From: Taylor Wilsdon Date: Fri, 14 Mar 2025 15:34:15 -0400 Subject: [PATCH 5/8] Add information about WEBUI_SECRET_KEY and multi-node deployments --- docs/getting-started/env-configuration.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/getting-started/env-configuration.md b/docs/getting-started/env-configuration.md index b808316..c32b206 100644 --- a/docs/getting-started/env-configuration.md +++ b/docs/getting-started/env-configuration.md @@ -682,6 +682,12 @@ directly. Ensure that no users are present in the database, if you intend to tur - Docker Default: Randomly generated on first start - Description: Overrides the randomly generated string used for JSON Web Token. +:::info + +When deploying Open-WebUI in a multiple node cluster with a load balancer, you must ensure that the WEBUI_SECRET_KEY value is the same across all instances in order to enable users to continue working if a node is recycled or their session is transferred to a different node. Without it, they will need to sign in again each time the underlying node changes. + +::: + #### `OFFLINE_MODE` - Type: `bool` From 0f6e6fcb9623f52c3e06ad3a1e5011fb044925a9 Mon Sep 17 00:00:00 2001 From: Taylor Wilsdon Date: Fri, 14 Mar 2025 15:36:56 -0400 Subject: [PATCH 6/8] Update .gitignore --- .gitignore | 1 - 1 file changed, 1 deletion(-) diff --git a/.gitignore b/.gitignore index 72dfb77..b2d6de3 100644 --- a/.gitignore +++ b/.gitignore @@ -18,4 +18,3 @@ npm-debug.log* yarn-debug.log* yarn-error.log* -.aider* From 3f64a57f1dbb02e95ab5a3abbe9762d0527744ab Mon Sep 17 00:00:00 2001 From: Taylor Wilsdon Date: Fri, 14 Mar 2025 15:37:33 -0400 Subject: [PATCH 7/8] Update permissions.md --- docs/features/workspace/permissions.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/features/workspace/permissions.md b/docs/features/workspace/permissions.md index 4e86b57..ad1f4e4 100644 --- a/docs/features/workspace/permissions.md +++ b/docs/features/workspace/permissions.md @@ -13,7 +13,6 @@ Workspace permissions control access to core components of the Open WebUI platfo * **Knowledge Access**: Toggle to allow users to access and manage knowledge bases. (Environment variable: `USER_PERMISSIONS_WORKSPACE_KNOWLEDGE_ACCESS`) * **Prompts Access**: Toggle to allow users to access and manage saved prompts. (Environment variable: `USER_PERMISSIONS_WORKSPACE_PROMPTS_ACCESS`) * **Tools Access**: Toggle to allow users to access and manage tools. (Environment variable: `USER_PERMISSIONS_WORKSPACE_TOOLS_ACCESS`) *Note: Enabling this gives users the ability to upload arbitrary code to the server.* -* **Public Sharing**: Toggle to allow users to share content publicly from their workspace. (Environment variable: `USER_PERMISSIONS_WORKSPACE_PUBLIC_SHARING`) ## Chat Permissions @@ -42,7 +41,6 @@ By default, Open WebUI applies the following permission settings: - Knowledge Access: Disabled (`USER_PERMISSIONS_WORKSPACE_KNOWLEDGE_ACCESS=False`) - Prompts Access: Disabled (`USER_PERMISSIONS_WORKSPACE_PROMPTS_ACCESS=False`) - Tools Access: Disabled (`USER_PERMISSIONS_WORKSPACE_TOOLS_ACCESS=False`) -- Public Sharing: Enabled(`USER_PERMISSIONS_WORKSPACE_TOOLS_ACCESS=True`) **Chat Permissions**: - Allow Chat Controls: Enabled From 46ac71771c27593dbedad78d4fb7c21a021dcfdc Mon Sep 17 00:00:00 2001 From: Taylor Wilsdon Date: Fri, 14 Mar 2025 15:37:50 -0400 Subject: [PATCH 8/8] Update env-configuration.md --- docs/getting-started/env-configuration.md | 7 ------- 1 file changed, 7 deletions(-) diff --git a/docs/getting-started/env-configuration.md b/docs/getting-started/env-configuration.md index c32b206..49d9ee4 100644 --- a/docs/getting-started/env-configuration.md +++ b/docs/getting-started/env-configuration.md @@ -2013,13 +2013,6 @@ See https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/authorizing-o - Description: Enables or disables user permission to access workspace tools. - Persistence: This environment variable is a `PersistentConfig` variable. -#### `USER_PERMISSIONS_WORKSPACE_PUBLIC_SHARING` - -- Type: `bool` -- Default: `True` -- Description: Enables or disables user ability to share created knowledge, tools, models and prompts publicly (if disabled, can only share to specific users and groups). -- Persistence: This environment variable is a `PersistentConfig` variable. - ## Chat Permissions #### `USER_PERMISSIONS_CHAT_FILE_UPLOAD`