From 04b9e8bec239d82a98cc8b6c654ad5b64f4b869f Mon Sep 17 00:00:00 2001 From: reivilibre Date: Tue, 23 May 2023 12:28:29 +0000 Subject: deploy: 5cae9158e67babe0553bc356802495a068222685 --- .../usage/configuration/config_documentation.html | 68 ++++++++++++++++++++-- 1 file changed, 62 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 d022ce3f99..250c4fec81 100644 --- a/latest/usage/configuration/config_documentation.html +++ b/latest/usage/configuration/config_documentation.html @@ -1669,6 +1669,24 @@ See here for more on using a reverse prox 
max_image_pixels: 35M
+

prevent_media_downloads_from

+

A list of domains to never download media from. Media from these +domains that is already downloaded will not be deleted, but will be +inaccessible to users. This option does not affect admin APIs trying +to download/operate on media.

+

This will not prevent the listed domains from accessing media themselves. +It simply prevents users on this server from downloading media originating +from the listed servers.

+

This will have no effect on media originating from the local server. +This only affects media downloaded from other Matrix servers, to +block domains from URL previews see url_preview_url_blacklist.

+

Defaults to an empty list (nothing blocked).

+

Example configuration:

+
prevent_media_downloads_from:
+  - evil.example.org
+  - evil2.example.org
+
+

dynamic_thumbnails

Whether to generate new thumbnails on the fly to precisely match the resolution requested by the client. If true then whenever @@ -3098,12 +3116,16 @@ This number can either be calculated as the number of unread messages for the u user has unread messages in. Defaults to true, meaning push clients will see the number of rooms with unread messages in them. Set to false to instead send the number of unread messages. +

  • jitter_delay: Delays push notifications by a random amount up to the given +duration. Useful for mitigating timing attacks. Optional, defaults to no +delay. Added in Synapse 1.84.0.

    • Example configuration:

    push:
   enabled: true
   include_content: false
   group_unread_count_by_room: false
+  jitter_delay: "10s"

    Rooms

    @@ -3327,6 +3349,13 @@ except com.example.foo.

    public_chat: null
    +

    forget_rooms_on_leave

    +

    Set to true to automatically forget rooms for users when they leave them, either +normally or via a kick or ban. Defaults to false.

    +

    Example configuration:

    +
    forget_rooms_on_leave: false
+
    +

    Opentracing

    Configuration options related to Opentracing support.

    @@ -3448,13 +3477,17 @@ events may be dropped).

    instance_map

    When using workers this should be a map from worker_name to the -HTTP replication listener of the worker, if configured. +HTTP replication listener of the worker, if configured, and to the main process. Each worker declared under stream_writers needs a HTTP replication listener, and that listener should be included in the instance_map. -(The main process also needs an HTTP replication listener, but it should not be -listed in the instance_map.)

    +The main process also needs an entry on the instance_map, and it should be listed under +main if even one other worker exists. Ensure the port matches with what is declared +inside the listener block for a replication listener.

    Example configuration:

    instance_map:
+  main:
+    host: localhost
+    port: 8030
   worker1:
     host: localhost
     port: 8034
@@ -3523,7 +3556,23 @@ localhost and 6379
    
 
 
  • 
 
    dbid: Optional redis dbid if needs to connect to specific redis logical db.
    
+
    • 
+
  • 
+
    use_tls: Whether to use tls connection. Defaults to false.
    
+
    • 
+
  • 
+
    certificate_file: Optional path to the certificate file
    
+
    • 
+
  • 
+
    private_key_file: Optional path to the private key file
    
+
    • 
+
  • 
+
    ca_file: Optional path to the CA certificate file. Use this one or:
    
+
    • 
+
  • 
+
    ca_path: Optional path to the folder containing the CA certificate file
    
 
    Added in Synapse 1.78.0.
    
+
    Changed in Synapse 1.84.0: Added use_tls, certificate_file, private_key_file, ca_file and ca_path attributes
    
 
    • 
 
 
    Example configuration:
    
@@ -3533,6 +3582,10 @@ localhost and 6379
    
   port: 6379
   password: <secret_password>
   dbid: <dbid>
+  #use_tls: True
+  #certificate_file: <path_to_the_certificate_file>
+  #private_key_file: <path_to_the_private_key_file>
+  #ca_file: <path_to_the_ca_certificate_file>

    Individual worker configuration

    @@ -3560,6 +3613,7 @@ giving each worker a unique worker_name.

    worker_replication_host

    +

    Deprecated as of version 1.84.0. Place host under main entry on the instance_map in your shared yaml configuration instead.

    The HTTP replication endpoint that it should talk to on the main Synapse process. The main Synapse process defines this with a replication resource in listeners option.

    @@ -3568,6 +3622,7 @@ The main Synapse process defines this with a replication resource i

    worker_replication_http_port

    +

    Deprecated as of version 1.84.0. Place port under main entry on the instance_map in your shared yaml configuration instead.

    The HTTP replication port that it should talk to on the main Synapse process. The main Synapse process defines this with a replication resource in listeners option.

    @@ -3576,6 +3631,7 @@ The main Synapse process defines this with a replication resource i

    worker_replication_http_tls

    +

    Deprecated as of version 1.84.0. Place tls under main entry on the instance_map in your shared yaml configuration instead.

    Whether TLS should be used for talking to the HTTP replication port on the main Synapse process. The main Synapse process defines this with the tls option on its listener that @@ -3593,9 +3649,9 @@ See worker_replication_secret<

    A worker can handle HTTP requests. To do so, a worker_listeners option must be declared, in the same way as the listeners option in the shared config.

    -

    Workers declared in stream_writers will need to include a -replication listener here, in order to accept internal HTTP requests from -other workers.

    +

    Workers declared in stream_writers and instance_map +will need to include a replication listener here, in order to accept internal HTTP +requests from other workers.

    Example configuration:

    worker_listeners:
   - type: http
-- 
cgit 1.5.1