OpenWebUI/docs
1
0
Fork 0
mirror of https://github.com/open-webui/docs synced 2025-05-19 18:58:41 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Merge branch 'open-webui:main' into webui_secret_key_multinode

Browse Source
This commit is contained in:
Taylor Wilsdon 2025-03-15 10:54:51 -04:00 committed by GitHub
commit 91d91062f9
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 17 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/features/plugin/functions/tab-shared/Common.md
View File

@ -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

4
docs/features/plugin/tools/index.mdx
View File

@ -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

14
docs/getting-started/env-configuration.md
View File

@ -2205,3 +2205,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.