From 230ecbfd550ba8d38b567eec46da6d9648671bc8 Mon Sep 17 00:00:00 2001 From: Taylor Wilsdon Date: Sat, 28 Jun 2025 12:15:23 -0700 Subject: [PATCH] docs for REDIS_KEY_PREFIX --- docs/getting-started/env-configuration.md | 6 ++++++ docs/tutorials/integrations/redis.md | 4 +++- 2 files changed, 9 insertions(+), 1 deletion(-) diff --git a/docs/getting-started/env-configuration.md b/docs/getting-started/env-configuration.md index b3fdf33d..59db72de 100644 --- a/docs/getting-started/env-configuration.md +++ b/docs/getting-started/env-configuration.md @@ -3268,6 +3268,12 @@ When deploying Open WebUI in a multi-node/worker cluster with a load balancer, y - Default: `26379` - Description: Sentinel port for app state Redis. +#### `REDIS_KEY_PREFIX` + +- Type: `str` +- Default: `open-webui` +- Description: Customizes the Redis key prefix used for storing configuration values. This allows multiple Open WebUI instances to share the same Redis instance without key conflicts. When operating in Redis cluster mode, the prefix is formatted as `{prefix}:` (e.g., `{open-webui}:config:*`) to enable multi-key operations on configuration keys within the same hash slot. + #### `ENABLE_WEBSOCKET_SUPPORT` - Type: `bool` diff --git a/docs/tutorials/integrations/redis.md b/docs/tutorials/integrations/redis.md index 9e10c905..a2c944e4 100644 --- a/docs/tutorials/integrations/redis.md +++ b/docs/tutorials/integrations/redis.md @@ -85,9 +85,10 @@ To enable websocket support in Open WebUI, you will need to set the following en ENABLE_WEBSOCKET_SUPPORT="true" WEBSOCKET_MANAGER="redis" WEBSOCKET_REDIS_URL="redis://redis:6379/1" +REDIS_KEY_PREFIX="open-webui" ``` -These environment variables enable websocket support, specify Redis as the websocket manager, and define the Redis URL. Make sure to replace the `WEBSOCKET_REDIS_URL` value with the actual IP address of your Redis instance. +These environment variables enable websocket support, specify Redis as the websocket manager, define the Redis URL, and set a custom Redis key prefix. The `REDIS_KEY_PREFIX` allows multiple Open WebUI instances to share the same Redis instance without key conflicts. In Redis cluster mode, the prefix is formatted as `{prefix}:` (e.g., `{open-webui}:config:*`) to enable multi-key operations on configuration keys within the same hash slot. Make sure to replace the `WEBSOCKET_REDIS_URL` value with the actual IP address of your Redis instance. When running Open WebUI using Docker, you need to connect it to the same Docker network: @@ -99,6 +100,7 @@ docker run -d \ -e ENABLE_WEBSOCKET_SUPPORT="true" \ -e WEBSOCKET_MANAGER="redis" \ -e WEBSOCKET_REDIS_URL="redis://127.0.0.1:6379/1" \ + -e REDIS_KEY_PREFIX="open-webui" \ ghcr.io/open-webui/open-webui:main ```