1 files changed, 73 insertions, 0 deletions
diff --git a/latest/upgrade.html b/latest/upgrade.html
index ff3bd62604..d91683855a 100644
--- a/latest/upgrade.html
+++ b/latest/upgrade.html
@@ -231,6 +231,79 @@ dpkg -i matrix-synapse-py3_1.3.0+stretch1_amd64.deb
</code></pre>
</li>
</ul>
+<h1 id="upgrading-to-v1840"><a class="header" href="#upgrading-to-v1840">Upgrading to v1.84.0</a></h1>
+<h2 id="deprecation-of-worker_replication_-configuration-settings"><a class="header" href="#deprecation-of-worker_replication_-configuration-settings">Deprecation of <code>worker_replication_*</code> configuration settings</a></h2>
+<p>When using workers,</p>
+<ul>
+<li><code>worker_replication_host</code></li>
+<li><code>worker_replication_http_port</code></li>
+<li><code>worker_replication_http_tls</code></li>
+</ul>
+<p>should now be removed from individual worker YAML configurations and the main process should instead be added to the <code>instance_map</code>
+in the shared YAML configuration, using the name <code>main</code>.</p>
+<p>The old <code>worker_replication_*</code> settings are now considered deprecated and are expected to be removed in Synapse v1.88.0.</p>
+<h3 id="example-change"><a class="header" href="#example-change">Example change</a></h3>
+<h4 id="before"><a class="header" href="#before">Before:</a></h4>
+<p>Shared YAML</p>
+<pre><code class="language-yaml">instance_map:
+ generic_worker1:
+ host: localhost
+ port: 5678
+ tls: false
+</code></pre>
+<p>Worker YAML</p>
+<pre><code class="language-yaml">worker_app: synapse.app.generic_worker
+worker_name: generic_worker1
+
+worker_replication_host: localhost
+worker_replication_http_port: 3456
+worker_replication_http_tls: false
+
+worker_listeners:
+ - type: http
+ port: 1234
+ resources:
+ - names: [client, federation]
+ - type: http
+ port: 5678
+ resources:
+ - names: [replication]
+
+worker_log_config: /etc/matrix-synapse/generic-worker-log.yaml
+</code></pre>
+<h4 id="after"><a class="header" href="#after">After:</a></h4>
+<p>Shared YAML</p>
+<pre><code class="language-yaml">instance_map:
+ main:
+ host: localhost
+ port: 3456
+ tls: false
+ generic_worker1:
+ host: localhost
+ port: 5678
+ tls: false
+</code></pre>
+<p>Worker YAML</p>
+<pre><code class="language-yaml">worker_app: synapse.app.generic_worker
+worker_name: generic_worker1
+
+worker_listeners:
+ - type: http
+ port: 1234
+ resources:
+ - names: [client, federation]
+ - type: http
+ port: 5678
+ resources:
+ - names: [replication]
+
+worker_log_config: /etc/matrix-synapse/generic-worker-log.yaml
+
+</code></pre>
+<p>Notes: </p>
+<ul>
+<li><code>tls</code> is optional but mirrors the functionality of <code>worker_replication_http_tls</code></li>
+</ul>
<h1 id="upgrading-to-v1810"><a class="header" href="#upgrading-to-v1810">Upgrading to v1.81.0</a></h1>
<h2 id="application-service-path--authentication-deprecations"><a class="header" href="#application-service-path--authentication-deprecations">Application service path & authentication deprecations</a></h2>
<p>Synapse now attempts the versioned appservice paths before falling back to the
|
