Skip to content

Commit bdf0c6e

Browse files
authored
Merge pull request #377 from flipt-io/claude/issue-375-20251029-2300
docs: add required Redis mode parameter to v2 authentication docs
2 parents 4474a4d + 4a2fa62 commit bdf0c6e

File tree

2 files changed

+25
-0
lines changed

2 files changed

+25
-0
lines changed

docs/v2/configuration/authentication.mdx

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -116,6 +116,30 @@ authentication:
116116
storage:
117117
type: redis
118118
redis:
119+
mode: single # Required: either "single" or "cluster"
120+
host: localhost
121+
port: 6379
122+
db: 0
123+
password: password
124+
```
125+
126+
The `mode` parameter is **required** and must be set to either:
127+
128+
- `single` - For standalone Redis instances (most common)
129+
- `cluster` - For Redis cluster setups
130+
131+
##### Redis Cluster Example
132+
133+
For Redis cluster configurations, use `mode: cluster`:
134+
135+
```yaml config.yaml
136+
authentication:
137+
required: true
138+
session:
139+
storage:
140+
type: redis
141+
redis:
142+
mode: cluster
119143
host: localhost
120144
port: 6379
121145
db: 0

docs/v2/configuration/overview.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -315,6 +315,7 @@ Authentication configuration controls how users and systems authenticate with Fl
315315

316316
| Property | Description | Default | Since |
317317
| ------------------------------------------------------- | ------------------------------------------------------------------- | --------- | ------ |
318+
| authentication.session.storage.redis.mode | **Required** Redis mode: `single` or `cluster` | single | v2.0.0 |
318319
| authentication.session.storage.redis.host | Host to access the Redis database | localhost | v2.0.0 |
319320
| authentication.session.storage.redis.port | Port to access the Redis database | 6379 | v2.0.0 |
320321
| authentication.session.storage.redis.db | Redis database to use | 0 | v2.0.0 |

0 commit comments

Comments
 (0)