Skip to content

docs: use the SPRING_DATA_REDIS_* variables for the message broker #225

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
joshiste merged 1 commit into from
Oct 12, 2026
Merged

docs: use the SPRING_DATA_REDIS_* variables for the message broker #225

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 10 additions & 8 deletions install-and-configure/install-on-prem-platform/advanced-configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,14 +147,16 @@ You can also configure additional wrapper plugins for Aurora (e.g. `initialConne

A Redis message broker is required to run the platform with multiple instances.

| Environment Variable | Required | Description |
|-------------------------------------------------------------------------------------|----------|--------------------------------------------------------------------------------------|
| `SPRING_REDIS_HOST` | yes | <p>Redis server host<br><strong>Example:</strong> <code>redis</code></p> |
| `SPRING_REDIS_PORT` | | <p>Redis server port<br><strong>Default:</strong> <code>6379</code></p> |
| `SPRING_REDIS_USERNAME` | | Redis Username |
| `SPRING_REDIS_PASSWORD` | | Redis Password |
| platform <= 1.0.96 `SPRING_REDIS_SSL`, platform > 1.0.96 `SPRING_REDIS_SSL_ENABLED` | | <p>Whether to enable SSL support.<br><strong>Default:</strong> <code>false</code></p>|
| `SPRING_REDIS_CLIENT_NAME` | | Client name to be set on connections with CLIENT SETNAME. |
| Environment Variable | Required | Description |
|-----------------------------------|----------|--------------------------------------------------------------------------------------|
| `SPRING_DATA_REDIS_HOST` | yes | <p>Redis server host<br><strong>Example:</strong> <code>redis</code></p> |
| `SPRING_DATA_REDIS_PORT` | | <p>Redis server port<br><strong>Default:</strong> <code>6379</code></p> |
| `SPRING_DATA_REDIS_USERNAME` | | Redis Username |
| `SPRING_DATA_REDIS_PASSWORD` | | Redis Password |
| `SPRING_DATA_REDIS_SSL_ENABLED` | | <p>Whether to enable SSL support.<br><strong>Default:</strong> <code>false</code></p>|
| `SPRING_DATA_REDIS_CLIENT_NAME` | | Client name to be set on connections with CLIENT SETNAME. |

**Note**: The platform only uses Redis if `SPRING_DATA_REDIS_HOST` is set. Variables named `SPRING_REDIS_*`, as listed here previously, are ignored: with them, every instance runs without Redis, and experiments fail whenever an agent is connected to a different instance.

## Tenant Configuration

Expand Down
Loading