Skip to content

Cutiepoka sentinel docs#3189

Open
cutiepoka wants to merge 2 commits intoredis:masterfrom
cutiepoka:cutiepoka-sentinel-docs
Open

Cutiepoka sentinel docs#3189
cutiepoka wants to merge 2 commits intoredis:masterfrom
cutiepoka:cutiepoka-sentinel-docs

Conversation

@cutiepoka
Copy link

@cutiepoka cutiepoka commented Feb 27, 2026

Description

This is addressing the seeming lack of documentation for sentinel. I spent a week looking at different libraries specifically because I could not find support for sentinel in the first readme, and a number of tickets that were asking for support.
this fixes #2454 #302 #592


Checklist

  • [ x] Does npm test pass with this change (including linting)?
  • [ x] Is the new or changed code fully tested?
  • [x ] Is a documentation update included (if this change modifies existing APIs, or introduces new ones)?

This is a documentation only change.


Note

Low Risk
Documentation-only updates; no runtime or API behavior changes, with only minor risk of confusion if links/examples are incorrect.

Overview
Adds a new Sentinel section to README.md that points users to the dedicated docs/sentinel.md guide.

Expands docs/sentinel.md with a Client Config section showing how to pass standard client options (e.g., password) via nodeClientOptions when using Sentinel.

Written by Cursor Bugbot for commit b3a8fa0. This will update automatically on new commits. Configure here.

Added a section about Sentinel usage in the README.
Added section on Client Config for sentinel mode, including example code.
@jit-ci
Copy link

jit-ci bot commented Feb 27, 2026

Hi, I’m Jit, a friendly security platform designed to help developers build secure applications from day zero with an MVS (Minimal viable security) mindset.

In case there are security findings, they will be communicated to you as a comment inside the PR.

Hope you’ll enjoy using Jit.

Questions? Comments? Want to learn more? Get in touch with us.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Lack of sentinel support needs to be prominent

1 participant