From 37b0c8b51348d6908a8a2e9086923ee8a24789e5 Mon Sep 17 00:00:00 2001 From: DMRobertson Date: Tue, 17 Jan 2023 12:46:31 +0000 Subject: deploy: b6955673bfab5c8d553e8b43e9c50dd7b1212e2a --- .../usage/configuration/config_documentation.html | 330 ++++++++++++--------- 1 file changed, 189 insertions(+), 141 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 ab15c6704b..5ac7add384 100644 --- a/latest/usage/configuration/config_documentation.html +++ b/latest/usage/configuration/config_documentation.html @@ -629,6 +629,138 @@ delete any device that hasn't been accessed for more than the specified amount o

Example configuration:

delete_stale_devices_after: 1y
 
+
+

email

+

Configuration for sending emails from Synapse.

+

Server admins can configure custom templates for email content. See +here for more information.

+

This setting has the following sub-options:

+ +

Example configuration:

+
email:
+  smtp_host: mail.server
+  smtp_port: 587
+  smtp_user: "exampleusername"
+  smtp_pass: "examplepassword"
+  force_tls: true
+  require_transport_security: true
+  enable_tls: false
+  notif_from: "Your Friendly %(app)s homeserver <noreply@example.com>"
+  app_name: my_branded_matrix_server
+  enable_notifs: true
+  notif_for_new_users: false
+  client_base_url: "http://localhost/riot"
+  validation_token_lifetime: 15m
+  invite_client_location: https://app.element.io
+
+  subjects:
+    message_from_person_in_room: "[%(app)s] You have a message on %(app)s from %(person)s in the %(room)s room..."
+    message_from_person: "[%(app)s] You have a message on %(app)s from %(person)s..."
+    messages_from_person: "[%(app)s] You have messages on %(app)s from %(person)s..."
+    messages_in_room: "[%(app)s] You have messages on %(app)s in the %(room)s room..."
+    messages_in_room_and_others: "[%(app)s] You have messages on %(app)s in the %(room)s room and others..."
+    messages_from_person_and_others: "[%(app)s] You have messages on %(app)s from %(person)s and others..."
+    invite_from_person_to_room: "[%(app)s] %(person)s has invited you to join the %(room)s room on %(app)s..."
+    invite_from_person: "[%(app)s] %(person)s has invited you to chat on %(app)s..."
+    password_reset: "[%(server_name)s] Password reset"
+    email_validation: "[%(server_name)s] Validate your email"
+

Homeserver blocking

Useful options for Synapse admins.


@@ -1084,7 +1216,7 @@ durations.

  • max_cache_memory_usage sets a ceiling on how much memory the cache can use before caches begin to be continuously evicted. They will continue to be evicted until the memory usage drops below the target_memory_usage, set in the setting below, or until the min_cache_ttl is hit. There is no default value for this option.
  • -
  • target_memory_usage sets a rough target for the desired memory usage of the caches. There is no default value +
  • target_cache_memory_usage sets a rough target for the desired memory usage of the caches. There is no default value for this option.
  • min_cache_ttl sets a limit under which newer cache entries are not evicted and is only applied when caches are actively being evicted/max_cache_memory_usage has been exceeded. This is to protect hot caches @@ -1144,7 +1276,7 @@ connection pool. For a reference to valid arguments, see:

  • @@ -2175,20 +2307,20 @@ state events are shared with users:

    To change the default behavior, use the following sub-options: