summary refs log tree commit diff
path: root/latest/usage
diff options
context:
space:
mode:
Diffstat (limited to 'latest/usage')
-rw-r--r--latest/usage/administration/admin_api/background_updates.html2
-rw-r--r--latest/usage/administration/admin_faq.html2
-rw-r--r--latest/usage/configuration/config_documentation.html8
3 files changed, 8 insertions, 4 deletions
diff --git a/latest/usage/administration/admin_api/background_updates.html b/latest/usage/administration/admin_api/background_updates.html

index f81a7c0564..2aab4bfefe 100644 --- a/latest/usage/administration/admin_api/background_updates.html +++ b/latest/usage/administration/admin_api/background_updates.html
@@ -188,7 +188,7 @@ run against the database.</p> <code>total_duration_ms</code> how long the background process has been running, not including time spent sleeping. <code>average_items_per_ms</code> how many items are processed per millisecond based on an exponential average.</p> <h2 id="enabled"><a class="header" href="#enabled">Enabled</a></h2> -<p>This API allow pausing background updates.</p> +<p>This API allows pausing background updates.</p> <p>Background updates should <em>not</em> be paused for significant periods of time, as this can affect the performance of Synapse.</p> <p><em>Note</em>: This won't persist over restarts.</p> diff --git a/latest/usage/administration/admin_faq.html b/latest/usage/administration/admin_faq.html
index c560d2efdf..82fef6efcc 100644 --- a/latest/usage/administration/admin_faq.html +++ b/latest/usage/administration/admin_faq.html
@@ -331,7 +331,7 @@ variable. The default is 0.5, which can be decreased to reduce RAM usage in memory constrained environments, or increased if performance starts to degrade.</p> <p>However, degraded performance due to a low cache factor, common on -machines with slow disks, often leads to explosions in memory use due +machines with slow disks, often leads to explosions in memory use due to backlogged requests. In this case, reducing the cache factor will make things worse. Instead, try increasing it drastically. 2.0 is a good starting value.</p> diff --git a/latest/usage/configuration/config_documentation.html b/latest/usage/configuration/config_documentation.html
index c3bde7a4de..4ccbdda5f2 100644 --- a/latest/usage/configuration/config_documentation.html +++ b/latest/usage/configuration/config_documentation.html
@@ -753,8 +753,8 @@ trailing 's'.</p> subjects. It defaults to 'Matrix'.</p> </li> <li> -<p><code>enable_notifs</code>: Set to true to enable sending emails for messages that the user -has missed. Disabled by default.</p> +<p><code>enable_notifs</code>: Set to true to allow users to receive e-mail notifications. If this is not set, +users can configure e-mail notifications but will not receive them. Disabled by default.</p> </li> <li> <p><code>notif_for_new_users</code>: Set to false to disable automatic subscription to email @@ -1275,6 +1275,9 @@ for a given destination and the state of the backoff is stored in the database.< <h3 id="event_cache_size"><a class="header" href="#event_cache_size"><code>event_cache_size</code></a></h3> <p>The number of events to cache in memory. Defaults to 10K. Like other caches, this is affected by <code>caches.global_factor</code> (see below).</p> +<p>For example, the default is 10K and the global_factor default is 0.5.</p> +<p>Since 10K * 0.5 is 5K then the event cache size will be 5K.</p> +<p>The cache affected by this configuration is named as &quot;<em>getEvent</em>&quot;.</p> <p>Note that this option is not part of the <code>caches</code> section.</p> <p>Example configuration:</p> <pre><code class="language-yaml">event_cache_size: 15K @@ -1294,6 +1297,7 @@ set.</p> variable. Setting by environment variable takes priority over setting through the config file.</p> <p>Defaults to 0.5, which will halve the size of all caches.</p> +<p>Note that changing this value also affects the HTTP connection pool.</p> </li> <li> <p><code>per_cache_factors</code>: A dictionary of cache name to cache factor for that individual