Skip to content

Commit

Permalink
Document SSL options for Redis
Browse files Browse the repository at this point in the history
  • Loading branch information
tarjei committed Aug 5, 2024
1 parent f094dca commit cd93d6c
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions messenger.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1675,13 +1675,41 @@ timeout Connection timeout. Float, value in ``0``
seconds default indicates unlimited
sentinel_master String, if null or empty Sentinel null
redis_sentinel support is disabled
ssl Map of TLS options. null

======================= ===================================== =================================

SSL options
-----------

The SSL options can be used change requirements for the TLS channel:

.. configuration-block::

.. code-block:: yaml

Check failure on line 1689 in messenger.rst

View workflow job for this annotation

GitHub Actions / Lint (DOCtor-RST)

Please add a blank line after " .. code-block:: yaml
# config/packages/test/messenger.yaml
messenger:
transports:
redis:
dsn: "rediss://localhost"

Check failure on line 1694 in messenger.rst

View workflow job for this annotation

GitHub Actions / Lint (DOCtor-RST)

Please remove trailing whitespace
options:
ssl:
allow_self_signed: true
capture_peer_cert: true
capture_peer_cert_chain: true
disable_compression: true
SNI_enabled: true
verify_peer: true
verify_peer_name: true
.. versionadded:: 7.1

The option `redis_sentinel` as an alias for `sentinel_master` was introduced
in Symfony 7.1.

.. versionadded:: 6.4

Check failure on line 1710 in messenger.rst

View workflow job for this annotation

GitHub Actions / Lint (DOCtor-RST)

Please add a blank line after ".. versionadded:: 6.4

Check failure on line 1710 in messenger.rst

View workflow job for this annotation

GitHub Actions / Lint (DOCtor-RST)

You are not allowed to use version "6.4". Only major version "7" is allowed.

Check failure on line 1710 in messenger.rst

View workflow job for this annotation

GitHub Actions / Lint (DOCtor-RST)

Please only provide ".. versionadded::" if the version is greater/equal "7.0"
The SSL options were added in 6.4.

.. caution::

There should never be more than one ``messenger:consume`` command running with the same
Expand Down

0 comments on commit cd93d6c

Please sign in to comment.