Missing documentation redis

[cmcrothers]

In setting up flipt with redis for the authentication session storage, following the documentation I receive the following error.

Error: failed to create redis client: invalid redis cache mode:

Looking into the source code there is a mode configuration for the redis mode being single and cluster, this is not part of the docs, and looking at flipt-io/flipt#4212 the default empty "" should be supported

[dosubot]

Hi @cmcrothers! I'm Dosu and I’m helping the flipt team.

The Redis mode parameter in Flipt must be set to either single or cluster—these are the only accepted values. If you leave mode empty or set it to anything else, you'll get the error failed to create redis client: invalid redis cache mode:. The documentation currently does not mention this requirement, which is why it's easy to run into this issue. The default should be single if omitted, but in practice, an empty string is not accepted as valid in the current implementation, so you need to explicitly set mode: single or mode: cluster in your configuration for Redis session storage to work as expected. This gap in the docs has been noted and is planned to be addressed in a future update. You can see more details and config examples in this issue.

To reply, just mention @dosu.

---

^{How did I do? Good | Irrelevant | Incorrect | Verbose | Hallucination | Report 🐛 | Other}    

[erka]

Hey @cmcrothers

Thank you for raising this up.

It should be single by default. I suspect there might be a bug in how the default config value is set.

[markphelps]

@claude can you update the v2 documentation for redis to fix this

[claude]

Claude finished @markphelps's task —— View job • claude/issue-375-20251029-2300 • Create PR ➔

---

Todo List

• Find existing v2 Redis documentation
• Review current Redis configuration examples
• Update documentation to include required mode parameter
• Add examples showing single and cluster modes
• Commit and push changes
• Create PR

Changes Made

✅ Fixed missing Redis mode parameter documentation

1. authentication.mdx: Added required mode parameter to Redis example with clear explanation
2. overview.mdx: Added mode parameter to Redis properties table
3. Documented that mode must be either single or cluster
4. Added both single and cluster configuration examples

Summary

The v2 Redis documentation has been updated to include the missing mode parameter that was causing the "invalid redis cache mode" error. Users will now see:

• The mode parameter is required
• It must be set to either single (most common) or cluster
• Clear examples for both configurations
• Complete properties table with the mode parameter included

---