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 pull request #481 from Classic298/main

Browse Source 
add: Info/Warning for setting up multi-instance setups
This commit is contained in:
Tim Jaeryang Baek 2025-04-08 12:35:40 -07:00 committed by GitHub
commit ec0bc31a38
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 38 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -2238,18 +2238,36 @@ More information about this setting can be found [here](https://docs.sqlalchemy.
- Default: `False`
- Description: Enables websocket support in Open WebUI (used with Redis).
:::INFO
When deploying Open-WebUI in a multi-node/worker cluster, you must ensure that the ENABLE_WEBSOCKET_SUPPORT value is set. Without it, websocket consistency and persistency issues will occur.
:::
#### `WEBSOCKET_MANAGER`
- Type: `str`
- Default: `redis`
- Description: Specifies the websocket manager to use (in this case, Redis).
:::INFO
When deploying Open-WebUI in a multi-node/worker cluster, you must ensure that the WEBSOCKET_MANAGER value is set and a key-value NoSQL database like Redis is used. Without it, websocket consistency and persistency issues will occur.
:::
#### `WEBSOCKET_REDIS_URL`
- Type: `str`
- Default: `${REDIS_URL}`
- Description: Specifies the URL of the Redis instance for websocket communication. It is distinct from `REDIS_URL` and in practice it is recommend to set both.
:::INFO
When deploying Open-WebUI in a multi-node/worker cluster, you must ensure that the WEBSOCKET_REDIS_URL value is set and a key-value NoSQL database like Redis is used. Without it, websocket consistency and persistency issues will occur.
:::
#### `WEBSOCKET_SENTINEL_HOSTS`
- Type: `str`
@ -2267,6 +2285,12 @@ More information about this setting can be found [here](https://docs.sqlalchemy.
- Example: `redis://localhost:6379/0`
- Description: Specifies the URL of the Redis instance for app state.
:::INFO
When deploying Open-WebUI in a multi-node/worker cluster, you must ensure that the REDIS_URL value is set. Without it, session, persistency and consistency issues in the app-state will occur as the workers would be unable to communicate.
:::
#### `REDIS_SENTINEL_HOSTS`
- Type: `str`

7
docs/getting-started/quick-start/tab-kubernetes/Helm.md
View File

@ -29,6 +29,13 @@ Helm helps you manage Kubernetes applications.
kubectl get pods
```
:::warning
If you intend to scale Open WebUI using multiple nodes/pods/workers in a clustered environment, you need to setup a NoSQL key-value database.
There are some [environment variables](https://docs.openwebui.com/getting-started/env-configuration/) that need to be set to the same value for all service-instances, otherwise consistency problems, faulty sessions and other issues will occur!
:::
## Access the WebUI
Set up port forwarding or load balancing to access Open WebUI from outside the cluster.

7
docs/getting-started/quick-start/tab-kubernetes/Kustomize.md
View File

@ -29,6 +29,13 @@ Kustomize allows you to customize Kubernetes YAML configurations.
kubectl get pods
```
:::warning
If you intend to scale Open WebUI using multiple nodes/pods/workers in a clustered environment, you need to setup a NoSQL key-value database.
There are some [environment variables](https://docs.openwebui.com/getting-started/env-configuration/) that need to be set to the same value for all service-instances, otherwise consistency problems, faulty sessions and other issues will occur!
:::
## Access the WebUI
Set up port forwarding or load balancing to access Open WebUI from outside the cluster.