From 6da02f72cea4508e33f5d6eec2ff2420dba96e5e Mon Sep 17 00:00:00 2001 From: DrMelone <27028174+Classic298@users.noreply.github.com> Date: Tue, 8 Apr 2025 17:48:45 +0200 Subject: [PATCH] Update env-configuration.md --- docs/getting-started/env-configuration.md | 24 +++++++++++++++++++++++ 1 file changed, 24 insertions(+) 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`