Skip to content
This repository was archived by the owner on Mar 26, 2024. It is now read-only.

Commit d1fb46f

Browse files
author
Sean Quah
committed
Improve clarity on deprecation of TCP replication
Borrows some text from matrix-org#13647 for the changelog.
1 parent 90c99fb commit d1fb46f

File tree

2 files changed

+10
-2
lines changed

2 files changed

+10
-2
lines changed

CHANGES.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,15 @@ No significant changes since 1.66.0rc2.
55

66
Deployments with multiple workers should note that the direct TCP replication
77
configuration was deprecated in Synapse v1.18.0 and will be removed in Synapse
8-
v1.67.0. See the [worker documentation](https://matrix-org.github.io/synapse/v1.66/workers.html)
8+
v1.67.0. In particular, the TCP `replication` listener and the
9+
`worker_replication_port` config option are deprecated.
10+
11+
To migrate to Redis, add the [`redis` config](https://matrix-org.github.io/synapse/v1.66/workers.html#shared-configuration)
12+
and remove the TCP `replication` listener from config of the master and
13+
`worker_replication_port` from worker config. Note that a HTTP listener with a
14+
`replication` resource is still required.
15+
16+
See the [worker documentation](https://matrix-org.github.io/synapse/v1.66/workers.html)
917
for more details.
1018

1119

docs/usage/configuration/config_documentation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -431,7 +431,7 @@ Sub-options for each listener include:
431431

432432
* `metrics`: (see the docs [here](../../metrics-howto.md)),
433433

434-
* `replication`: (see the docs [here](../../workers.md)).
434+
* `replication`: (deprecated as of Synapse 1.18, see the docs [here](../../workers.md)).
435435

436436
* `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.
437437

0 commit comments

Comments
 (0)