From 3a2bd6c6e2ee23079d9cf802198740bf6a289b1b Mon Sep 17 00:00:00 2001 From: squahtx Date: Wed, 31 Aug 2022 12:55:41 +0000 Subject: deploy: 6f80fe1e1bbb6cab3ce605b2023e0488e2d80d52 --- .../usage/configuration/config_documentation.html | 21 +++++++++++++++------ 1 file changed, 15 insertions(+), 6 deletions(-) (limited to 'latest/usage/configuration/config_documentation.html') diff --git a/latest/usage/configuration/config_documentation.html b/latest/usage/configuration/config_documentation.html index 148eda5d9b..89e2bc44db 100644 --- a/latest/usage/configuration/config_documentation.html +++ b/latest/usage/configuration/config_documentation.html @@ -482,7 +482,7 @@ configuration.

metrics: (see the docs here),

  • -

    replication: (see the docs here).

    +

    replication: (deprecated as of Synapse 1.18, see the docs here).

    • @@ -502,7 +502,7 @@ on this port. Sub-options for each resource are:

  • compress: set to true to enable gzip compression on HTTP bodies for this resource. This is currently only supported with the -client, consent and metrics resources.

    +client, consent, metrics and federation resources.

    • @@ -769,6 +769,9 @@ using Synapse's media repository.

    redaction_retention_period

    How long to keep redacted events in unredacted form in the database. After this period redacted events get replaced with their redacted form in the DB.

    +

    Synapse will check whether the rentention period has concluded for redacted +events every 5 minutes. Thus, even if this option is set to 0, Synapse may +still take up to 5 minutes to purge redacted events from the database.

    Defaults to 7d. Set to null to disable.

    Example configuration:

    redaction_retention_period: 28d
@@ -832,7 +835,11 @@ the allowed_lifetime_min and allowed_lifetime_max conf
 which are older than the room's maximum retention period. Synapse will also
 filter events received over federation so that events that should have been
 purged are ignored and not stored again.
    
-
    The message retention policies feature is disabled by default.
    
+
    The message retention policies feature is disabled by default. Please be advised 
+that enabling this feature carries some risk. There are known bugs with the implementation
+which can cause database corruption. Setting retention to delete older history
+is less risky than deleting newer history but in general caution is advised when enabling this
+experimental feature. You can read more about this feature here.
    
 
    This setting has the following sub-options:
    
 
      
 
    • 
@@ -1925,7 +1932,9 @@ their account.
      
 
      (Servers handling the these requests must answer the /requestToken endpoints defined
 by the Matrix Identity Service API
 specification.)
      
-
      Updated in Synapse 1.64.0: The email option is deprecated.
      
+
      Deprecated in Synapse 1.64.0: The email option is deprecated.
      
+
      Removed in Synapse 1.66.0: The email option has been removed.
+If present, Synapse will report a configuration error on startup.
      
 
      Example configuration:
      
 
      account_threepid_delegates:
     msisdn: http://localhost:8090  # Delegate SMS sending to this local process
@@ -3012,7 +3021,7 @@ user directory. Defaults to false.
      • 
 
 
      For detailed instructions on user consent configuration, see here.
      
 
      Parts of this section are required if enabling the consent resource under
-listeners, in particular template_dir and version. # TODO: link listeners
      
+listeners, in particular template_dir and version.
      
 
        
 
      • 
 
        template_dir: gives the location of the templates for the HTML forms.
@@ -3027,7 +3036,7 @@ parameter.
        
 
        • 
 
      • 
 
        server_notice_content: if enabled, will send a user a "Server Notice"
-asking them to consent to the privacy policy. The server_notices section ##TODO: link
+asking them to consent to the privacy policy. The server_notices section
 must also be configured for this to work. Notices will not be sent to
 guest users unless send_server_notice_to_guests is set to true.
        
 
        • 
-- 
cgit 1.5.1