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 diff --git a/docs/features/plugin/tools/index.mdx b/docs/features/plugin/tools/index.mdx index 4087bf8..db1a80c 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: @@ -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 diff --git a/docs/getting-started/env-configuration.md b/docs/getting-started/env-configuration.md index b808316..dad4771 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` @@ -2206,3 +2212,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.