diff options
| author | Olivier Wilkinson (reivilibre) <oliverw@matrix.org> | 2023-05-23 13:27:31 +0100 |
|---|---|---|
| committer | Olivier Wilkinson (reivilibre) <oliverw@matrix.org> | 2023-05-23 13:27:31 +0100 |
| commit | 5b18a217ca2f31d06791f165570112f18f2a4ca4 (patch) | |
| tree | be762e03089a7f5ad1cbdde51b0a21508c0311f7 /docs/upgrade.md | |
| parent | Bump requests from 2.28.2 to 2.31.0 (#15651) (diff) | |
| parent | Tweak changelog and upgrade notes (diff) | |
| download | synapse-5b18a217ca2f31d06791f165570112f18f2a4ca4.tar.xz | |
Merge branch 'master' into develop
Diffstat (limited to 'docs/upgrade.md')
| -rw-r--r-- | docs/upgrade.md | 23 |
1 files changed, 17 insertions, 6 deletions
diff --git a/docs/upgrade.md b/docs/upgrade.md index 0625de8afb..af999dd91f 100644 --- a/docs/upgrade.md +++ b/docs/upgrade.md @@ -92,15 +92,22 @@ process, for example: ## Deprecation of `worker_replication_*` configuration settings -When using workers, +When using workers, + * `worker_replication_host` * `worker_replication_http_port` * `worker_replication_http_tls` -can now be removed from individual worker YAML configuration ***if*** you add the main process to the `instance_map` in the shared YAML configuration, -using the name `main`. +should now be removed from individual worker YAML configurations and the main process should instead be added to the `instance_map` +in the shared YAML configuration, using the name `main`. + +The old `worker_replication_*` settings are now considered deprecated and are expected to be removed in Synapse v1.88.0. + + +### Example change + +#### Before: -### Before: Shared YAML ```yaml instance_map: @@ -109,6 +116,7 @@ instance_map: port: 5678 tls: false ``` + Worker YAML ```yaml worker_app: synapse.app.generic_worker @@ -130,7 +138,10 @@ worker_listeners: worker_log_config: /etc/matrix-synapse/generic-worker-log.yaml ``` -### After: + + +#### After: + Shared YAML ```yaml instance_map: @@ -143,6 +154,7 @@ instance_map: port: 5678 tls: false ``` + Worker YAML ```yaml worker_app: synapse.app.generic_worker @@ -165,7 +177,6 @@ Notes: * `tls` is optional but mirrors the functionality of `worker_replication_http_tls` - # Upgrading to v1.81.0 ## Application service path & authentication deprecations |