diff --git a/docs/getting-started/env-configuration.md b/docs/getting-started/env-configuration.md index e99ffae..4ae0c2c 100644 --- a/docs/getting-started/env-configuration.md +++ b/docs/getting-started/env-configuration.md @@ -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` diff --git a/docs/getting-started/quick-start/tab-kubernetes/Helm.md b/docs/getting-started/quick-start/tab-kubernetes/Helm.md index 61a0e98..f4b6b2f 100644 --- a/docs/getting-started/quick-start/tab-kubernetes/Helm.md +++ b/docs/getting-started/quick-start/tab-kubernetes/Helm.md @@ -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. diff --git a/docs/getting-started/quick-start/tab-kubernetes/Kustomize.md b/docs/getting-started/quick-start/tab-kubernetes/Kustomize.md index c8579b4..62b3e2b 100644 --- a/docs/getting-started/quick-start/tab-kubernetes/Kustomize.md +++ b/docs/getting-started/quick-start/tab-kubernetes/Kustomize.md @@ -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.