From 0a75ead764e5e81520ea1279ea7e4d8afc44c48c Mon Sep 17 00:00:00 2001 From: anoadragon453 Date: Tue, 14 May 2024 14:23:00 +0000 Subject: deploy: ecf4e0674c9a027aec253adaca89ed260700224b --- latest/usage/administration/admin_api/background_updates.html | 2 +- latest/usage/administration/admin_faq.html | 2 +- latest/usage/configuration/config_documentation.html | 8 ++++++-- 3 files changed, 8 insertions(+), 4 deletions(-) (limited to 'latest/usage') 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.

total_duration_ms how long the background process has been running, not including time spent sleeping. average_items_per_ms how many items are processed per millisecond based on an exponential average.

Enabled

-

This API allow pausing background updates.

+

This API allows pausing background updates.

Background updates should not be paused for significant periods of time, as this can affect the performance of Synapse.

Note: This won't persist over restarts.

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.

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.

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'.

subjects. It defaults to 'Matrix'.

  • -

    enable_notifs: Set to true to enable sending emails for messages that the user -has missed. Disabled by default.

    +

    enable_notifs: 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.

  • notif_for_new_users: 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.<

    event_cache_size

    The number of events to cache in memory. Defaults to 10K. Like other caches, this is affected by caches.global_factor (see below).

    +

    For example, the default is 10K and the global_factor default is 0.5.

    +

    Since 10K * 0.5 is 5K then the event cache size will be 5K.

    +

    The cache affected by this configuration is named as "getEvent".

    Note that this option is not part of the caches section.

    Example configuration:

    event_cache_size: 15K
@@ -1294,6 +1297,7 @@ set.
    
 variable. Setting by environment variable takes priority over
 setting through the config file.
    
 
    Defaults to 0.5, which will halve the size of all caches.
    
+
    Note that changing this value also affects the HTTP connection pool.

  • per_cache_factors: A dictionary of cache name to cache factor for that individual -- cgit 1.5.1