diff options
| author | Jason Little <realtyem@gmail.com> | 2023-05-26 14:28:39 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-05-26 15:28:39 -0400 |
| commit | c835befd10ae0087c3c54a36989ba347313b68af (patch) | |
| tree | ed898f1379a6e93a0351aad64023a9b073f7a48a /docs | |
| parent | Add `MSC3820opt2` as a known room version (#15678) (diff) | |
| download | synapse-c835befd10ae0087c3c54a36989ba347313b68af.tar.xz | |
Add Unix socket support for Redis connections (#15644)
Adds a new configuration setting to connect to Redis via a Unix socket instead of over TCP. Disabled by default.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/usage/configuration/config_documentation.md | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/docs/usage/configuration/config_documentation.md b/docs/usage/configuration/config_documentation.md index 93b132b6e4..5ede6d0a82 100644 --- a/docs/usage/configuration/config_documentation.md +++ b/docs/usage/configuration/config_documentation.md @@ -3979,6 +3979,8 @@ This setting has the following sub-options: * `enabled`: whether to use Redis support. Defaults to false. * `host` and `port`: Optional host and port to use to connect to redis. Defaults to localhost and 6379 +* `path`: The full path to a local Unix socket file. **If this is used, `host` and + `port` are ignored.** Defaults to `/tmp/redis.sock' * `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. @@ -3991,6 +3993,8 @@ This setting has the following sub-options: _Changed in Synapse 1.84.0: Added use\_tls, certificate\_file, private\_key\_file, ca\_file and ca\_path attributes_ + _Changed in Synapse 1.85.0: Added path option to use a local Unix socket_ + Example configuration: ```yaml redis: |