Skip to content
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

Jump to bottom

Update documentation with sentinels authentication options #174

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update documentation with sentinels authentication options #174

Show file tree
Hide file tree
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
19 changes: 19 additions & 0 deletions README.pod
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -315,13 +315,32 @@ using the sentinels feature, the Redis client will wait at most that number of
seconds (can be fractional) before giving up when reading from a sentinel
server. B<Default>: 1

=head3 C<< username >>

If your Redis server requires authentication, you can optionally use the
C<< username >> attribute. After each established connection (at the start or
when reconnecting), the Redis C<< AUTH >> command will be send to the server.
If the username/password combination is wrong, an exception will be thrown and
reconnect will be disabled.

=head3 C<< sentinels_username >>

If your Redis sentinel server requires authentication, you can use the
C<< sentinels_username >> attribute to specify the optional username to
authenticate as.

=head3 C<< password >>

If your Redis server requires authentication, you can use the C<< password >>
attribute. After each established connection (at the start or when
reconnecting), the Redis C<< AUTH >> command will be send to the server. If the
password is wrong, an exception will be thrown and reconnect will be disabled.

=head3 C<< sentinels_password >>

If your Redis sentinel server requires authentication, you can use the
C<< sentinels_password >> attribute to specify the password.

=head3 C<< on_connect >>

You can also provide a code reference that will be immediately after each
Expand Down
19 changes: 19 additions & 0 deletions lib/Redis.pm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1373,13 +1373,32 @@ using the sentinels feature, the Redis client will wait at most that number of
seconds (can be fractional) before giving up when reading from a sentinel
server. B<Default>: 1

=head3 C<< username >>

If your Redis server requires authentication, you can optionally use the
C<< username >> attribute. After each established connection (at the start or
when reconnecting), the Redis C<< AUTH >> command will be send to the server.
If the username/password combination is wrong, an exception will be thrown and
reconnect will be disabled.

=head3 C<< sentinels_username >>

If your Redis sentinel server requires authentication, you can use the
C<< sentinels_username >> attribute to specify the optional username to
authenticate as.

=head3 C<< password >>

If your Redis server requires authentication, you can use the C<< password >>
attribute. After each established connection (at the start or when
reconnecting), the Redis C<< AUTH >> command will be send to the server. If the
password is wrong, an exception will be thrown and reconnect will be disabled.

=head3 C<< sentinels_password >>

If your Redis sentinel server requires authentication, you can use the
C<< sentinels_password >> attribute to specify the password.

=head3 C<< on_connect >>

You can also provide a code reference that will be immediately after each
Expand Down