khanh.pndc/open-webui-docs
1
0
Fork 0
mirror of https://github.com/open-webui/docs.git synced 2026-01-04 10:46:26 +07:00
Code Issues Packages Projects Releases Wiki Activity

enh: support for Redis in cluster mode

Browse Source
This commit is contained in:
Erhhung Yuan
2025-07-30 16:36:32 -07:00
parent 17b5623451
commit 62d87f92a8
1 changed files with 30 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -3332,9 +3332,11 @@ More information about this setting can be found [here](https://docs.sqlalchemy.
#### `REDIS_URL`
- Type: `str`
- Example: `redis://localhost:6379/0`
- Example with TLS: `rediss://localhost:6379/0`
- Description: Specifies the URL of the Redis instance for the app state.
- Description: Specifies the URL of the Redis instance or cluster host for storing application state.
- Examples:
- `redis://localhost:6379/0`
- `rediss://localhost:6379/0` _(with TLS)_
- `rediss://:password@redis-cluster.redis.svc.cluster.local:6379/0 ?ssl_cert_reqs=required&ssl_certfile=/tls/redis/tls.crt &ssl_keyfile=/tls/redis/tls.key&ssl_ca_certs=/tls/redis/ca.crt` _(with password and mTLS)_
:::info
@@ -3353,6 +3355,18 @@ 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_CLUSTER_MODE`
- Type: `bool`
- Default: `False`
- Description: Connect to Redis in Cluster Mode instead of to a single instance or using Redis Sentinels. If `True`, `REDIS_URL` must also be defined.
:::info
This option has no effect if `REDIS_SENTINEL_HOSTS` is defined.
:::
#### `REDIS_KEY_PREFIX`
- Type: `str`
@@ -3387,7 +3401,7 @@ When deploying Open WebUI in a multi-node/worker cluster with a load balancer, y
- 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 recommended to set both.
- Description: Specifies the URL of the Redis instance or cluster host for websocket communication. It is distinct from `REDIS_URL` and in practice, it is recommended to set both.
:::info
@@ -3406,6 +3420,18 @@ When deploying Open WebUI in a multi-node/worker cluster with a load balancer, y
- Default: `26379`
- Description: Sentinel port for websocket Redis.
#### `WEBSOCKET_REDIS_CLUSTER_MODE`
- Type: `bool`
- Default: `${REDIS_CLUSTER_MODE}`
- Description: Specifies that websocket should communicate with Redis in Cluster Mode instead of to a single instance or using Redis Sentinels. If `True`, `WEBSOCKET_REDIS_URL` and/or `REDIS_URL` must also be defined.
:::info
This option has no effect if `WEBSOCKET_SENTINEL_HOSTS` is defined.
:::
### Uvicorn Settings
#### `UVICORN_WORKERS`