From d9ba4f7923d72a5f1ffa07e7a7181a7b7391b3ef Mon Sep 17 00:00:00 2001 From: Jan Kessler Date: Mon, 24 Mar 2025 20:50:19 +0100 Subject: [PATCH 1/4] clarify different Redis URLs + add docs for Sentinel envs --- docs/getting-started/env-configuration.md | 31 +++++++++++++++++++++-- 1 file changed, 29 insertions(+), 2 deletions(-) diff --git a/docs/getting-started/env-configuration.md b/docs/getting-started/env-configuration.md index d337147..52d0948 100644 --- a/docs/getting-started/env-configuration.md +++ b/docs/getting-started/env-configuration.md @@ -2238,11 +2238,38 @@ More information about this setting can be found [here](https://docs.sqlalchemy. - Default: `redis` - Description: Specifies the websocket manager to use (in this case, Redis). -#### `WEBSOCKET_REDIS_URL` (`REDIS_URL` exists for potential future use cases. In practice, it is recommended to set both.) +#### `WEBSOCKET_REDIS_URL` - Type: `str` - Default: `redis://localhost:6379/0` -- Description: Specifies the URL of the Redis instance for websocket communication. +- 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. + +#### `WEBSOCKET_SENTINEL_HOSTS` + +- Type: `str` +- Description: Comma-separated list of Redis Sentinels for websocket. If specified, the "hostname" in `WEBSOCKET_REDIS_URL` will be interpreted as the Sentinel service name. + +#### `WEBSOCKET_SENTINEL_PORT` + +- Type: `int` +- Default: `26379` +- Description: Sentinel port for websocket Redis. + +#### `REDIS_URL` + +- Type: `str` +- Description: Specifies the URL of the Redis instance for app state. + +#### `SENTINEL_HOSTS` + +- Type: `str` +- Description: Comma-separated list of Redis Sentinels for app state. If specified, the "hostname" in `REDIS_URL` will be interpreted as the Sentinel service name. + +#### `SENTINEL_PORT` + +- Type: `int` +- Default: `26379` +- Description: Sentinel port for app state Redis. ### Proxy Settings From 9a8557270607d3e291f4544d6dfe1350e055a3d0 Mon Sep 17 00:00:00 2001 From: Jan Kessler Date: Mon, 24 Mar 2025 21:01:10 +0100 Subject: [PATCH 2/4] update REDIS_URL default --- docs/getting-started/env-configuration.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/getting-started/env-configuration.md b/docs/getting-started/env-configuration.md index 52d0948..02d17f7 100644 --- a/docs/getting-started/env-configuration.md +++ b/docs/getting-started/env-configuration.md @@ -2241,7 +2241,7 @@ More information about this setting can be found [here](https://docs.sqlalchemy. #### `WEBSOCKET_REDIS_URL` - Type: `str` -- Default: `redis://localhost:6379/0` +- 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. #### `WEBSOCKET_SENTINEL_HOSTS` From a4baa1516942aa979fbfdf46df0cf27ebcdbf45b Mon Sep 17 00:00:00 2001 From: Jan Kessler Date: Mon, 24 Mar 2025 21:03:31 +0100 Subject: [PATCH 3/4] add previous (WEBSOCKET_)REDIS_URL default als example --- docs/getting-started/env-configuration.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/getting-started/env-configuration.md b/docs/getting-started/env-configuration.md index 02d17f7..ecb8ed1 100644 --- a/docs/getting-started/env-configuration.md +++ b/docs/getting-started/env-configuration.md @@ -2258,6 +2258,7 @@ More information about this setting can be found [here](https://docs.sqlalchemy. #### `REDIS_URL` - Type: `str` +- Example: `redis://localhost:6379/0` - Description: Specifies the URL of the Redis instance for app state. #### `SENTINEL_HOSTS` From c1df745adf615eea3345d3b001f8b929c5dff2e3 Mon Sep 17 00:00:00 2001 From: Jan Kessler Date: Thu, 27 Mar 2025 11:43:19 +0100 Subject: [PATCH 4/4] update for renamed envs --- docs/getting-started/env-configuration.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/getting-started/env-configuration.md b/docs/getting-started/env-configuration.md index ecb8ed1..04135ae 100644 --- a/docs/getting-started/env-configuration.md +++ b/docs/getting-started/env-configuration.md @@ -2261,12 +2261,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. -#### `SENTINEL_HOSTS` +#### `REDIS_SENTINEL_HOSTS` - Type: `str` - Description: Comma-separated list of Redis Sentinels for app state. If specified, the "hostname" in `REDIS_URL` will be interpreted as the Sentinel service name. -#### `SENTINEL_PORT` +#### `REDIS_SENTINEL_PORT` - Type: `int` - Default: `26379`