Mirrors
/
synapse
mirror of https://github.com/element-hq/synapse.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Improve clarity on deprecation of TCP replication 

Borrows some text from https://github.com/matrix-org/synapse/pull/13647
for the changelog.
This commit is contained in:
Sean Quah 2022-08-31 12:19:40 +01:00
parent 90c99fb3aa
commit d1fb46fbc9
2 changed files with 10 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
CHANGES.md
View File

@ -5,7 +5,15 @@ No significant changes since 1.66.0rc2.
Deployments with multiple workers should note that the direct TCP replication
configuration was deprecated in Synapse v1.18.0 and will be removed in Synapse
v1.67.0. See the [worker documentation](https://matrix-org.github.io/synapse/v1.66/workers.html)
v1.67.0. In particular, the TCP `replication` listener and the
`worker_replication_port` config option are deprecated.
To migrate to Redis, add the [`redis` config](https://matrix-org.github.io/synapse/v1.66/workers.html#shared-configuration)
and remove the TCP `replication` listener from config of the master and
`worker_replication_port` from worker config. Note that a HTTP listener with a
`replication` resource is still required.
See the [worker documentation](https://matrix-org.github.io/synapse/v1.66/workers.html)
for more details.

2
docs/usage/configuration/config_documentation.md
View File

@ -431,7 +431,7 @@ Sub-options for each listener include:
* `metrics`: (see the docs [here](../../metrics-howto.md)),
* `replication`: (see the docs [here](../../workers.md)).
* `replication`: (deprecated as of Synapse 1.18, see the docs [here](../../workers.md)).
* `tls`: set to true to enable TLS for this listener. Will use the TLS key/cert specified in tls_private_key_path / tls_certificate_path.