summary refs log tree commit diff
path: root/develop/usage/configuration/config_documentation.html
diff options
context:
space:
mode:
authorDMRobertson <DMRobertson@users.noreply.github.com>2023-01-09 18:36:05 +0000
committerDMRobertson <DMRobertson@users.noreply.github.com>2023-01-09 18:36:05 +0000
commit629497902be3ed0426848332c68a9a9fdfda3bbc (patch)
treeef09a5ffb48c9f5b0ee0cd3670bfb3fffc9c8252 /develop/usage/configuration/config_documentation.html
parentdeploy: c7b2c31161cddd7f10d96cb5ec7a8a7b42ecdf79 (diff)
downloadsynapse-629497902be3ed0426848332c68a9a9fdfda3bbc.tar.xz
deploy: 3479599387164aca2613e88d1697191b087e55bc
Diffstat (limited to 'develop/usage/configuration/config_documentation.html')
-rw-r--r--develop/usage/configuration/config_documentation.html37
1 files changed, 32 insertions, 5 deletions
diff --git a/develop/usage/configuration/config_documentation.html b/develop/usage/configuration/config_documentation.html

index 560496dc39..5ac7add384 100644 --- a/develop/usage/configuration/config_documentation.html +++ b/develop/usage/configuration/config_documentation.html
@@ -2307,20 +2307,20 @@ state events are shared with users:</p> <p>To change the default behavior, use the following sub-options:</p> <ul> <li> -<p><code>disable_default_event_types</code>: boolean. Set to <code>true</code> to disable the above +<p><code>disable_default_event_types</code>: boolean. Set to <code>true</code> to disable the above defaults. If this is enabled, only the event types listed in <code>additional_event_types</code> are shared. Defaults to <code>false</code>.</p> </li> <li> -<p><code>additional_event_types</code>: A list of additional state events to include in the -events to be shared. By default, this list is empty (so only the default event +<p><code>additional_event_types</code>: A list of additional state events to include in the +events to be shared. By default, this list is empty (so only the default event types are shared).</p> <p>Each entry in this list should be either a single string or a list of two -strings. </p> +strings.</p> <ul> <li>A standalone string <code>t</code> represents all events with type <code>t</code> (i.e. with no restrictions on state keys).</li> -<li>A pair of strings <code>[t, s]</code> represents a single event with type <code>t</code> and +<li>A pair of strings <code>[t, s]</code> represents a single event with type <code>t</code> and state key <code>s</code>. The same type can appear in two entries with different state keys: in this situation, both state keys are included in prejoin state.</li> </ul> @@ -3457,6 +3457,33 @@ defaults to the main process.</p> <pre><code class="language-yaml">run_background_tasks_on: worker1 </code></pre> <hr /> +<h3 id="update_user_directory_from_worker"><a class="header" href="#update_user_directory_from_worker"><code>update_user_directory_from_worker</code></a></h3> +<p>The <a href="../../workers.html#updating-the-user-directory">worker</a> that is used to +update the user directory. If not provided this defaults to the main process.</p> +<p>Example configuration:</p> +<pre><code class="language-yaml">update_user_directory_from_worker: worker1 +</code></pre> +<p><em>Added in Synapse 1.59.0.</em></p> +<hr /> +<h3 id="notify_appservices_from_worker"><a class="header" href="#notify_appservices_from_worker"><code>notify_appservices_from_worker</code></a></h3> +<p>The <a href="../../workers.html#notifying-application-services">worker</a> that is used to +send output traffic to Application Services. If not provided this defaults +to the main process.</p> +<p>Example configuration:</p> +<pre><code class="language-yaml">notify_appservices_from_worker: worker1 +</code></pre> +<p><em>Added in Synapse 1.59.0.</em></p> +<hr /> +<h3 id="media_instance_running_background_jobs"><a class="header" href="#media_instance_running_background_jobs"><code>media_instance_running_background_jobs</code></a></h3> +<p>The <a href="../../workers.html#synapseappmedia_repository">worker</a> that is used to run +background tasks for media repository. If running multiple media repositories +you must configure a single instance to run the background tasks. If not provided +this defaults to the main process or your single <code>media_repository</code> worker.</p> +<p>Example configuration:</p> +<pre><code class="language-yaml">media_instance_running_background_jobs: worker1 +</code></pre> +<p><em>Added in Synapse 1.16.0.</em></p> +<hr /> <h3 id="redis"><a class="header" href="#redis"><code>redis</code></a></h3> <p>Configuration for Redis when using workers. This <em>must</em> be enabled when using workers. This setting has the following sub-options:</p>