diff options
| author | Roel ter Maat <roel.termaat@nedap.com> | 2023-05-11 14:02:51 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-05-11 13:02:51 +0100 |
| commit | 2611433b70fc30c436f6b9b950a3bcc533b3df5b (patch) | |
| tree | ae8d8e09b921582db255e303422f036ea615d4a9 /docs/usage | |
| parent | Require at least poetry-core v1.2.0 (#15566) (diff) | |
| download | synapse-2611433b70fc30c436f6b9b950a3bcc533b3df5b.tar.xz | |
Add redis SSL configuration options (#15312)
* Add SSL options to redis config * fix lint issues * Add documentation and changelog file * add missing . at the end of the changelog * Move client context factory to new file * Rename ssl to tls and fix typo * fix lint issues * Added when redis attributes were added
Diffstat (limited to 'docs/usage')
| -rw-r--r-- | docs/usage/configuration/config_documentation.md | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/docs/usage/configuration/config_documentation.md b/docs/usage/configuration/config_documentation.md index dc965b4119..93b132b6e4 100644 --- a/docs/usage/configuration/config_documentation.md +++ b/docs/usage/configuration/config_documentation.md @@ -3981,9 +3981,16 @@ This setting has the following sub-options: localhost and 6379 * `password`: Optional password if configured on the Redis instance. * `dbid`: Optional redis dbid if needs to connect to specific redis logical db. +* `use_tls`: Whether to use tls connection. Defaults to false. +* `certificate_file`: Optional path to the certificate file +* `private_key_file`: Optional path to the private key file +* `ca_file`: Optional path to the CA certificate file. Use this one or: +* `ca_path`: Optional path to the folder containing the CA certificate file _Added in Synapse 1.78.0._ + _Changed in Synapse 1.84.0: Added use\_tls, certificate\_file, private\_key\_file, ca\_file and ca\_path attributes_ + Example configuration: ```yaml redis: @@ -3992,6 +3999,10 @@ redis: port: 6379 password: <secret_password> dbid: <dbid> + #use_tls: True + #certificate_file: <path_to_the_certificate_file> + #private_key_file: <path_to_the_private_key_file> + #ca_file: <path_to_the_ca_certificate_file> ``` --- ## Individual worker configuration |