deploy: 6acb6d772a77a4398c112d82118c5b79755a91cb

develop/print.html

@@ -6632,7 +6632,7 @@ loads. Some workers are privileged and can accept requests from other workers.</
 <ol>
 <li>The first part (in this section of the manual) defines which shardable tasks
 are delegated to privileged workers. This allows unprivileged workers to make
-request a privileged worker to act on their behalf.</li>
+requests to a privileged worker to act on their behalf.</li>
 <li><a href="usage/configuration/config_documentation.html#individual-worker-configuration">The second part</a>
 controls the behaviour of individual workers in isolation.</li>
 </ol>
@@ -6648,6 +6648,7 @@ traffic between the workers and the main process is not authenticated.</p>
 </code></pre>
 <hr />
 <h3 id="start_pushers"><a class="header" href="#start_pushers"><code>start_pushers</code></a></h3>
+<p>Unnecessary to set if using <a href="usage/configuration/config_documentation.html#pusher_instances"><code>pusher_instances</code></a> with <a href="usage/configuration/../../workers.html#synapseappgeneric_worker"><code>generic_workers</code></a>.</p>
 <p>Controls sending of push notifications on the main process. Set to <code>false</code>
 if using a <a href="usage/configuration/../../workers.html#synapseapppusher">pusher worker</a>. Defaults to <code>true</code>.</p>
 <p>Example configuration:</p>
@@ -6655,21 +6656,24 @@ if using a <a href="usage/configuration/../../workers.html#synapseapppusher">pus
 </code></pre>
 <hr />
 <h3 id="pusher_instances"><a class="header" href="#pusher_instances"><code>pusher_instances</code></a></h3>
-<p>It is possible to run multiple <a href="usage/configuration/../../workers.html#synapseapppusher">pusher workers</a>,
+<p>It is possible to scale the processes that handle sending push notifications to <a href="https://github.com/matrix-org/sygnal">sygnal</a>
-in which case the work is balanced across them. Use this setting to list the pushers by
+and email by running a <a href="usage/configuration/../../workers.html#synapseappgeneric_worker"><code>generic_worker</code></a> and adding it's <a href="usage/configuration/config_documentation.html#worker_name"><code>worker_name</code></a> to
-<a href="usage/configuration/config_documentation.html#worker_name"><code>worker_name</code></a>. Ensure the main process and all pusher workers are
+a <code>pusher_instances</code> map. Doing so will remove handling of this function from the main
-restarted after changing this option.</p>
+process. Multiple workers can be added to this map, in which case the work is balanced
-<p>If no or only one pusher worker is configured, this setting is not necessary.
+across them. Ensure the main process and all pusher workers are restarted after changing
-The main process will send out push notifications by default if you do not disable
+this option.</p>
-it by setting <a href="usage/configuration/config_documentation.html#start_pushers"><code>start_pushers: false</code></a>.</p>
+<p>Example configuration for a single worker:</p>
-<p>Example configuration:</p>
+<pre><code class="language-yaml">pusher_instances:
-<pre><code class="language-yaml">start_pushers: false
+  - pusher_worker1
-pusher_instances:
+</code></pre>
+<p>And for multiple workers:</p>
+<pre><code class="language-yaml">pusher_instances:
   - pusher_worker1
   - pusher_worker2
 </code></pre>
 <hr />
 <h3 id="send_federation"><a class="header" href="#send_federation"><code>send_federation</code></a></h3>
+<p>Unnecessary to set if using <a href="usage/configuration/config_documentation.html#federation_sender_instances"><code>federation_sender_instances</code></a> with <a href="usage/configuration/../../workers.html#synapseappgeneric_worker"><code>generic_workers</code></a>.</p>
 <p>Controls sending of outbound federation transactions on the main process.
 Set to <code>false</code> if using a <a href="usage/configuration/../../workers.html#synapseappfederation_sender">federation sender worker</a>.
 Defaults to <code>true</code>.</p>
@@ -6678,18 +6682,24 @@ Defaults to <code>true</code>.</p>
 </code></pre>
 <hr />
 <h3 id="federation_sender_instances"><a class="header" href="#federation_sender_instances"><code>federation_sender_instances</code></a></h3>
-<p>It is possible to run multiple
+<p>It is possible to scale the processes that handle sending outbound federation requests
-<a href="usage/configuration/../../workers.html#synapseappfederation_sender">federation sender worker</a>, in which
+by running a <a href="usage/configuration/../../workers.html#synapseappgeneric_worker"><code>generic_worker</code></a> and adding it's <a href="usage/configuration/config_documentation.html#worker_name"><code>worker_name</code></a> to
-case the work is balanced across them. Use this setting to list the senders.</p>
+a <code>federation_sender_instances</code> map. Doing so will remove handling of this function from
-<p>This configuration setting must be shared between all federation sender workers, and if
+the main process. Multiple workers can be added to this map, in which case the work is
-changed all federation sender workers must be stopped at the same time and then
+balanced across them.</p>
-started, to ensure that all instances are running with the same config (otherwise
+<p>This configuration setting must be shared between all workers handling federation
+sending, and if changed all federation sender workers must be stopped at the same time
+and then started, to ensure that all instances are running with the same config (otherwise
 events may be dropped).</p>
-<p>Example configuration:</p>
+<p>Example configuration for a single worker:</p>
-<pre><code class="language-yaml">send_federation: false
+<pre><code class="language-yaml">federation_sender_instances:
-federation_sender_instances:
   - federation_sender1
 </code></pre>
+<p>And for multiple workers:</p>
+<pre><code class="language-yaml">federation_sender_instances:
+  - federation_sender1
+  - federation_sender2
+</code></pre>
 <hr />
 <h3 id="instance_map"><a class="header" href="#instance_map"><code>instance_map</code></a></h3>
 <p>When using workers this should be a map from <a href="usage/configuration/config_documentation.html#worker_name"><code>worker_name</code></a> to the
@@ -10602,6 +10612,8 @@ after setting this option in the shared configuration!</p>
 <p>This style of configuration supersedes the legacy <code>synapse.app.appservice</code>
 worker application type.</p>
 <h3 id="synapseapppusher"><a class="header" href="#synapseapppusher"><code>synapse.app.pusher</code></a></h3>
+<p>It is likely this option will be deprecated in the future and is not recommended for new
+installations. Instead, <a href="usage/configuration/config_documentation.html#pusher_instances">use <code>synapse.app.generic_worker</code> with the <code>pusher_instances</code></a>.</p>
 <p>Handles sending push notifications to sygnal and email. Doesn't handle any
 REST endpoints itself, but you should set
 <a href="usage/configuration/config_documentation.html#start_pushers"><code>start_pushers: false</code></a> in the
@@ -10633,6 +10645,8 @@ REST endpoints itself, but you should set <code>notify_appservices: False</code>
 shared configuration file to stop the main synapse sending appservice notifications.</p>
 <p>Note this worker cannot be load-balanced: only one instance should be active.</p>
 <h3 id="synapseappfederation_sender"><a class="header" href="#synapseappfederation_sender"><code>synapse.app.federation_sender</code></a></h3>
+<p>It is likely this option will be deprecated in the future and not recommended for
+new installations. Instead, <a href="usage/configuration/config_documentation.html#federation_sender_instances">use <code>synapse.app.generic_worker</code> with the <code>federation_sender_instances</code></a>. </p>
 <p>Handles sending federation traffic to other servers. Doesn't handle any
 REST endpoints itself, but you should set
 <a href="usage/configuration/config_documentation.html#send_federation"><code>send_federation: false</code></a>
@@ -10724,7 +10738,9 @@ equivalent to <code>synapse.app.generic_worker</code>:</p>
 <li><code>synapse.app.client_reader</code></li>
 <li><code>synapse.app.event_creator</code></li>
 <li><code>synapse.app.federation_reader</code></li>
+<li><code>synapse.app.federation_sender</code></li>
 <li><code>synapse.app.frontend_proxy</code></li>
+<li><code>synapse.app.pusher</code></li>
 <li><code>synapse.app.synchrotron</code></li>
 </ul>
 <h2 id="migration-from-old-config"><a class="header" href="#migration-from-old-config">Migration from old config</a></h2>

develop/usage/configuration/config_documentation.html

@@ -3310,7 +3310,7 @@ loads. Some workers are privileged and can accept requests from other workers.</
 <ol>
 <li>The first part (in this section of the manual) defines which shardable tasks
 are delegated to privileged workers. This allows unprivileged workers to make
-request a privileged worker to act on their behalf.</li>
+requests to a privileged worker to act on their behalf.</li>
 <li><a href="#individual-worker-configuration">The second part</a>
 controls the behaviour of individual workers in isolation.</li>
 </ol>
@@ -3326,6 +3326,7 @@ traffic between the workers and the main process is not authenticated.</p>
 </code></pre>
 <hr />
 <h3 id="start_pushers"><a class="header" href="#start_pushers"><code>start_pushers</code></a></h3>
+<p>Unnecessary to set if using <a href="#pusher_instances"><code>pusher_instances</code></a> with <a href="../../workers.html#synapseappgeneric_worker"><code>generic_workers</code></a>.</p>
 <p>Controls sending of push notifications on the main process. Set to <code>false</code>
 if using a <a href="../../workers.html#synapseapppusher">pusher worker</a>. Defaults to <code>true</code>.</p>
 <p>Example configuration:</p>
@@ -3333,21 +3334,24 @@ if using a <a href="../../workers.html#synapseapppusher">pusher worker</a>. Defa
 </code></pre>
 <hr />
 <h3 id="pusher_instances"><a class="header" href="#pusher_instances"><code>pusher_instances</code></a></h3>
-<p>It is possible to run multiple <a href="../../workers.html#synapseapppusher">pusher workers</a>,
+<p>It is possible to scale the processes that handle sending push notifications to <a href="https://github.com/matrix-org/sygnal">sygnal</a>
-in which case the work is balanced across them. Use this setting to list the pushers by
+and email by running a <a href="../../workers.html#synapseappgeneric_worker"><code>generic_worker</code></a> and adding it's <a href="#worker_name"><code>worker_name</code></a> to
-<a href="#worker_name"><code>worker_name</code></a>. Ensure the main process and all pusher workers are
+a <code>pusher_instances</code> map. Doing so will remove handling of this function from the main
-restarted after changing this option.</p>
+process. Multiple workers can be added to this map, in which case the work is balanced
-<p>If no or only one pusher worker is configured, this setting is not necessary.
+across them. Ensure the main process and all pusher workers are restarted after changing
-The main process will send out push notifications by default if you do not disable
+this option.</p>
-it by setting <a href="#start_pushers"><code>start_pushers: false</code></a>.</p>
+<p>Example configuration for a single worker:</p>
-<p>Example configuration:</p>
+<pre><code class="language-yaml">pusher_instances:
-<pre><code class="language-yaml">start_pushers: false
+  - pusher_worker1
-pusher_instances:
+</code></pre>
+<p>And for multiple workers:</p>
+<pre><code class="language-yaml">pusher_instances:
   - pusher_worker1
   - pusher_worker2
 </code></pre>
 <hr />
 <h3 id="send_federation"><a class="header" href="#send_federation"><code>send_federation</code></a></h3>
+<p>Unnecessary to set if using <a href="#federation_sender_instances"><code>federation_sender_instances</code></a> with <a href="../../workers.html#synapseappgeneric_worker"><code>generic_workers</code></a>.</p>
 <p>Controls sending of outbound federation transactions on the main process.
 Set to <code>false</code> if using a <a href="../../workers.html#synapseappfederation_sender">federation sender worker</a>.
 Defaults to <code>true</code>.</p>
@@ -3356,18 +3360,24 @@ Defaults to <code>true</code>.</p>
 </code></pre>
 <hr />
 <h3 id="federation_sender_instances"><a class="header" href="#federation_sender_instances"><code>federation_sender_instances</code></a></h3>
-<p>It is possible to run multiple
+<p>It is possible to scale the processes that handle sending outbound federation requests
-<a href="../../workers.html#synapseappfederation_sender">federation sender worker</a>, in which
+by running a <a href="../../workers.html#synapseappgeneric_worker"><code>generic_worker</code></a> and adding it's <a href="#worker_name"><code>worker_name</code></a> to
-case the work is balanced across them. Use this setting to list the senders.</p>
+a <code>federation_sender_instances</code> map. Doing so will remove handling of this function from
-<p>This configuration setting must be shared between all federation sender workers, and if
+the main process. Multiple workers can be added to this map, in which case the work is
-changed all federation sender workers must be stopped at the same time and then
+balanced across them.</p>
-started, to ensure that all instances are running with the same config (otherwise
+<p>This configuration setting must be shared between all workers handling federation
+sending, and if changed all federation sender workers must be stopped at the same time
+and then started, to ensure that all instances are running with the same config (otherwise
 events may be dropped).</p>
-<p>Example configuration:</p>
+<p>Example configuration for a single worker:</p>
-<pre><code class="language-yaml">send_federation: false
+<pre><code class="language-yaml">federation_sender_instances:
-federation_sender_instances:
   - federation_sender1
 </code></pre>
+<p>And for multiple workers:</p>
+<pre><code class="language-yaml">federation_sender_instances:
+  - federation_sender1
+  - federation_sender2
+</code></pre>
 <hr />
 <h3 id="instance_map"><a class="header" href="#instance_map"><code>instance_map</code></a></h3>
 <p>When using workers this should be a map from <a href="#worker_name"><code>worker_name</code></a> to the

develop/workers.html

@@ -589,6 +589,8 @@ after setting this option in the shared configuration!</p>
 <p>This style of configuration supersedes the legacy <code>synapse.app.appservice</code>
 worker application type.</p>
 <h3 id="synapseapppusher"><a class="header" href="#synapseapppusher"><code>synapse.app.pusher</code></a></h3>
+<p>It is likely this option will be deprecated in the future and is not recommended for new
+installations. Instead, <a href="usage/configuration/config_documentation.html#pusher_instances">use <code>synapse.app.generic_worker</code> with the <code>pusher_instances</code></a>.</p>
 <p>Handles sending push notifications to sygnal and email. Doesn't handle any
 REST endpoints itself, but you should set
 <a href="usage/configuration/config_documentation.html#start_pushers"><code>start_pushers: false</code></a> in the
@@ -620,6 +622,8 @@ REST endpoints itself, but you should set <code>notify_appservices: False</code>
 shared configuration file to stop the main synapse sending appservice notifications.</p>
 <p>Note this worker cannot be load-balanced: only one instance should be active.</p>
 <h3 id="synapseappfederation_sender"><a class="header" href="#synapseappfederation_sender"><code>synapse.app.federation_sender</code></a></h3>
+<p>It is likely this option will be deprecated in the future and not recommended for
+new installations. Instead, <a href="usage/configuration/config_documentation.html#federation_sender_instances">use <code>synapse.app.generic_worker</code> with the <code>federation_sender_instances</code></a>. </p>
 <p>Handles sending federation traffic to other servers. Doesn't handle any
 REST endpoints itself, but you should set
 <a href="usage/configuration/config_documentation.html#send_federation"><code>send_federation: false</code></a>
@@ -711,7 +715,9 @@ equivalent to <code>synapse.app.generic_worker</code>:</p>
 <li><code>synapse.app.client_reader</code></li>
 <li><code>synapse.app.event_creator</code></li>
 <li><code>synapse.app.federation_reader</code></li>
+<li><code>synapse.app.federation_sender</code></li>
 <li><code>synapse.app.frontend_proxy</code></li>
+<li><code>synapse.app.pusher</code></li>
 <li><code>synapse.app.synchrotron</code></li>
 </ul>
 <h2 id="migration-from-old-config"><a class="header" href="#migration-from-old-config">Migration from old config</a></h2>