diff options
| author | Sean Quah <seanq@matrix.org> | 2022-08-31 12:19:40 +0100 |
|---|---|---|
| committer | Sean Quah <seanq@matrix.org> | 2022-08-31 12:19:40 +0100 |
| commit | d1fb46fbc987fc0f2672780e373db83c7dacb6cf (patch) | |
| tree | 948b6776b5c6d3d60c46546d49fb65b51a9169a1 | |
| parent | Fix dead link in 1.18.0 upgrade notes (diff) | |
| download | synapse-d1fb46fbc987fc0f2672780e373db83c7dacb6cf.tar.xz | |
Improve clarity on deprecation of TCP replication
Borrows some text from https://github.com/matrix-org/synapse/pull/13647 for the changelog.
| -rw-r--r-- | CHANGES.md | 10 | ||||
| -rw-r--r-- | docs/usage/configuration/config_documentation.md | 2 |
2 files changed, 10 insertions, 2 deletions
diff --git a/CHANGES.md b/CHANGES.md index f502866f76..712d3b134a 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -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. diff --git a/docs/usage/configuration/config_documentation.md b/docs/usage/configuration/config_documentation.md index 8ae018e628..5dee38d28d 100644 --- a/docs/usage/configuration/config_documentation.md +++ b/docs/usage/configuration/config_documentation.md @@ -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. |