summary refs log tree commit diff
path: root/develop/usage
diff options
context:
space:
mode:
Diffstat (limited to 'develop/usage')
-rw-r--r--develop/usage/configuration/config_documentation.html10
-rw-r--r--develop/usage/configuration/homeserver_sample_config.html6
2 files changed, 16 insertions, 0 deletions
diff --git a/develop/usage/configuration/config_documentation.html b/develop/usage/configuration/config_documentation.html

index 0603e07295..a16cd961f0 100644 --- a/develop/usage/configuration/config_documentation.html +++ b/develop/usage/configuration/config_documentation.html
@@ -1058,6 +1058,16 @@ at all.</p> expire_caches: false sync_response_cache_duration: 2m </code></pre> +<h3 id="reloading-cache-factors"><a class="header" href="#reloading-cache-factors">Reloading cache factors</a></h3> +<p>The cache factors (i.e. <code>caches.global_factor</code> and <code>caches.per_cache_factors</code>) may be reloaded at any time by sending a +<a href="https://en.wikipedia.org/wiki/SIGHUP"><code>SIGHUP</code></a> signal to Synapse using e.g.</p> +<pre><code class="language-commandline">kill -HUP [PID_OF_SYNAPSE_PROCESS] +</code></pre> +<p>If you are running multiple workers, you must individually update the worker +config file and send this signal to each worker process.</p> +<p>If you're using the <a href="https://github.com/matrix-org/synapse/blob/develop/contrib/systemd/matrix-synapse.service">example systemd service</a> +file in Synapse's <code>contrib</code> directory, you can send a <code>SIGHUP</code> signal by using +<code>systemctl reload matrix-synapse</code>.</p> <hr /> <h2 id="database"><a class="header" href="#database">Database</a></h2> <p>Config options related to database settings.</p> diff --git a/develop/usage/configuration/homeserver_sample_config.html b/develop/usage/configuration/homeserver_sample_config.html
index ec9c6791ec..fe8852586e 100644 --- a/develop/usage/configuration/homeserver_sample_config.html +++ b/develop/usage/configuration/homeserver_sample_config.html
@@ -886,6 +886,12 @@ retention: # A cache 'factor' is a multiplier that can be applied to each of # Synapse's caches in order to increase or decrease the maximum # number of entries that can be stored. +# +# The configuration for cache factors (caches.global_factor and +# caches.per_cache_factors) can be reloaded while the application is running, +# by sending a SIGHUP signal to the Synapse process. Changes to other parts of +# the caching config will NOT be applied after a SIGHUP is received; a restart +# is necessary. # The number of events to cache in memory. Not affected by # caches.global_factor.