From 001046b66e7cf9d27f0edda65c763a15c181fd26 Mon Sep 17 00:00:00 2001 From: erikjohnston Date: Tue, 12 Dec 2023 17:29:11 +0000 Subject: deploy: 15733b0931ceaa72cf4175c44fe58128fa273bac --- .../admin_api/background_updates.html | 17 ++++- .../usage/administration/admin_api/federation.html | 17 ++++- latest/usage/administration/admin_api/index.html | 17 ++++- .../admin_api/registration_tokens.html | 17 ++++- latest/usage/administration/admin_faq.html | 17 ++++- .../administration/database_maintenance_tools.html | 17 ++++- latest/usage/administration/index.html | 17 ++++- .../reporting_homeserver_usage_statistics.html | 17 ++++- .../usage/administration/monthly_active_users.html | 17 ++++- latest/usage/administration/request_log.html | 17 ++++- latest/usage/administration/state_groups.html | 17 ++++- ...derstanding_synapse_through_grafana_graphs.html | 17 ++++- .../administration/useful_sql_for_admins.html | 17 ++++- .../usage/configuration/config_documentation.html | 81 ++++++++++++++++++---- .../configuration/homeserver_sample_config.html | 17 ++++- latest/usage/configuration/index.html | 17 ++++- .../usage/configuration/logging_sample_config.html | 17 ++++- .../configuration/user_authentication/index.html | 17 ++++- .../user_authentication/refresh_tokens.html | 17 ++++- .../user_authentication/single_sign_on/cas.html | 17 ++++- .../user_authentication/single_sign_on/index.html | 17 ++++- .../user_authentication/single_sign_on/saml.html | 17 ++++- 22 files changed, 404 insertions(+), 34 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 a67f7d869b..499f27c4db 100644 --- a/latest/usage/administration/admin_api/background_updates.html +++ b/latest/usage/administration/admin_api/background_updates.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +

+ +

@@ -255,5 +268,7 @@ background updates which won't be cancelled once started.

+ + - \ No newline at end of file + diff --git a/latest/usage/administration/admin_api/federation.html b/latest/usage/administration/admin_api/federation.html index de6a55d40d..7fc104437c 100644 --- a/latest/usage/administration/admin_api/federation.html +++ b/latest/usage/administration/admin_api/federation.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +

+ +

@@ -357,5 +370,7 @@ even if the API already returns the http status 200.

+ + - \ No newline at end of file + diff --git a/latest/usage/administration/admin_api/index.html b/latest/usage/administration/admin_api/index.html index 0e8be5c8b6..f09b4462a4 100644 --- a/latest/usage/administration/admin_api/index.html +++ b/latest/usage/administration/admin_api/index.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +

+ +

@@ -217,5 +230,7 @@ information from the Admin API.

+ + - \ No newline at end of file + diff --git a/latest/usage/administration/admin_api/registration_tokens.html b/latest/usage/administration/admin_api/registration_tokens.html index e9ac3206ea..d01834b7bb 100644 --- a/latest/usage/administration/admin_api/registration_tokens.html +++ b/latest/usage/administration/admin_api/registration_tokens.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +

+ +

@@ -424,5 +437,7 @@ the Ma + + - \ No newline at end of file + diff --git a/latest/usage/administration/admin_faq.html b/latest/usage/administration/admin_faq.html index d98443f665..d771ea5dc1 100644 --- a/latest/usage/administration/admin_faq.html +++ b/latest/usage/administration/admin_faq.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +

+ +

@@ -394,5 +407,7 @@ you see this failure mode so we can help debug it, however.

+ + - \ No newline at end of file + diff --git a/latest/usage/administration/database_maintenance_tools.html b/latest/usage/administration/database_maintenance_tools.html index 4fc7a88391..69a78a90d6 100644 --- a/latest/usage/administration/database_maintenance_tools.html +++ b/latest/usage/administration/database_maintenance_tools.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +

+ +

@@ -197,5 +210,7 @@ + + - \ No newline at end of file + diff --git a/latest/usage/administration/index.html b/latest/usage/administration/index.html index b1a6d96192..515c40611e 100644 --- a/latest/usage/administration/index.html +++ b/latest/usage/administration/index.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +

+ +

@@ -192,5 +205,7 @@ + + - \ No newline at end of file + diff --git a/latest/usage/administration/monitoring/reporting_homeserver_usage_statistics.html b/latest/usage/administration/monitoring/reporting_homeserver_usage_statistics.html index 52611e11ef..901a6c0de0 100644 --- a/latest/usage/administration/monitoring/reporting_homeserver_usage_statistics.html +++ b/latest/usage/administration/monitoring/reporting_homeserver_usage_statistics.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +

+ +

@@ -254,5 +267,7 @@ consider using one of the following known implementations:

+ + - \ No newline at end of file + diff --git a/latest/usage/administration/monthly_active_users.html b/latest/usage/administration/monthly_active_users.html index 6b21ea3bf7..6efacdf47a 100644 --- a/latest/usage/administration/monthly_active_users.html +++ b/latest/usage/administration/monthly_active_users.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +

+ +

@@ -249,5 +262,7 @@ registered accounts on the homeserver.

+ + - \ No newline at end of file + diff --git a/latest/usage/administration/request_log.html b/latest/usage/administration/request_log.html index 43db860ef4..adf42d8f6d 100644 --- a/latest/usage/administration/request_log.html +++ b/latest/usage/administration/request_log.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +

+ +

@@ -220,5 +233,7 @@ small processing times.

+ + - \ No newline at end of file + diff --git a/latest/usage/administration/state_groups.html b/latest/usage/administration/state_groups.html index 1e035d2bb0..3136f29dd1 100644 --- a/latest/usage/administration/state_groups.html +++ b/latest/usage/administration/state_groups.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +

+ +

@@ -198,5 +211,7 @@ + + - \ No newline at end of file + diff --git a/latest/usage/administration/understanding_synapse_through_grafana_graphs.html b/latest/usage/administration/understanding_synapse_through_grafana_graphs.html index 5e044a0bcc..9fa2b487ec 100644 --- a/latest/usage/administration/understanding_synapse_through_grafana_graphs.html +++ b/latest/usage/administration/understanding_synapse_through_grafana_graphs.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +

+ +

@@ -235,5 +248,7 @@ to make use of multiple CPU cores / multiple machines for your homeserver.

+ + - \ No newline at end of file + diff --git a/latest/usage/administration/useful_sql_for_admins.html b/latest/usage/administration/useful_sql_for_admins.html index c5753465f7..37f3b8c213 100644 --- a/latest/usage/administration/useful_sql_for_admins.html +++ b/latest/usage/administration/useful_sql_for_admins.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +

+ +

@@ -355,5 +368,7 @@ WHERE room_stats_state.room_id = event_json.room_id" | psql -d synapse -h l + + - \ No newline at end of file + diff --git a/latest/usage/configuration/config_documentation.html b/latest/usage/configuration/config_documentation.html index 93a8d5b5eb..c0b3f44ce9 100644 --- a/latest/usage/configuration/config_documentation.html +++ b/latest/usage/configuration/config_documentation.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +

+ +

@@ -176,6 +189,16 @@ messages from the database after 5 minutes, rather than 5 months.

For example, setting max_avatar_size: 10M means that Synapse will not accept files larger than 10,485,760 bytes for a user avatar.

Config Validation

The configuration file can be validated with the following command:

python -m synapse.config read <config key to print> -c <path to config>
+

To validate the entire file, omit read <config key to print>:

python -m synapse.config -c <path to config>
+

To see how to set other options, check the help reference:

python -m synapse.config --help
+

YAML

The configuration file is a YAML file, which means that certain syntax rules apply if you want your config file to be read properly. A few helpful things to know:

@@ -635,7 +658,7 @@ for workers and containers without listener e.g # Note that x_forwarded will default to true, when using a UNIX socket. Please see # https://matrix-org.github.io/synapse/latest/reverse_proxy.html. # - - path: /var/run/synapse/main_public.sock + - path: /run/synapse/main_public.sock type: http resources: - names: [client, federation] @@ -1390,7 +1413,7 @@ see here.

args: user: synapse_user password: secretpassword - database: synapse + dbname: synapse host: localhost port: 5432 cp_min: 5 @@ -1472,7 +1495,7 @@ when Synapse is started.

args: user: synapse_user password: secretpassword - database: synapse_main + dbname: synapse_main host: localhost port: 5432 cp_min: 5 @@ -1485,7 +1508,7 @@ when Synapse is started.

args: user: synapse_user password: secretpassword - database: synapse_state + dbname: synapse_state host: localhost port: 5432 cp_min: 5 @@ -1665,6 +1688,16 @@ sending the invite. Defaults to per_second: 0.2,

burst_count:
   burst_count: 10

`rc_media_create`

This option ratelimits creation of MXC URIs via the /_matrix/media/v1/create +endpoint based on the account that's creating the media. Defaults to +per_second: 10, burst_count: 50.

Example configuration:

rc_media_create:
+  per_second: 10
+  burst_count: 50
+

`rc_federation`

Defines limits on federation requests.

The rc_federation configuration has the following sub-options:

@@ -1713,6 +1746,21 @@ Set to false if you are using a separate media store worker.

media_store_path: "DATADIR/media_store"

`max_pending_media_uploads`

How many pending media uploads can a given user have? A pending media upload +is a created MXC URI that (a) is not expired (the unused_expires_at timestamp +has not passed) and (b) the media has not yet been uploaded for. Defaults to 5.

Example configuration:

max_pending_media_uploads: 5
+

`unused_expiration_time`

How long to wait in milliseconds before expiring created media IDs. Defaults to +"24h"

Example configuration:

unused_expiration_time: "1h"
+

`media_storage_providers`

Media storage providers allow media to be stored in different locations. Defaults to none. Associated sub-options are:

@@ -3425,6 +3473,8 @@ notices.

system_mxid_display_name: set the display name of the "notices" user

system_mxid_avatar_url: set the avatar for the "notices" user

room_name: set the room name of the server notices room

auto_join: boolean. If true, the user will be automatically joined to the room instead of being invited. +Defaults to false. Added in Synapse 1.98.0.

Example configuration:

server_notices:
@@ -3432,6 +3482,7 @@ notices.
   system_mxid_display_name: "Server Notices"
   system_mxid_avatar_url: "mxc://server.com/oumMVlgDnLYFaPVkExemNVVZ"
   room_name: "Server Notices"
+  auto_join: true

`enable_room_list_search`

@@ -3741,9 +3792,9 @@ declared inside the listener block for a replication l

Example configuration(#2, for UNIX sockets):

instance_map:
   main:
-    path: /var/run/synapse/main_replication.sock
+    path: /run/synapse/main_replication.sock
   worker1:
-    path: /var/run/synapse/worker1_replication.sock
+    path: /run/synapse/worker1_replication.sock

`stream_writers`

@@ -3768,9 +3819,11 @@ authorize inter-worker communication.

- federation_sender1 - federation_sender2 -

Also see the worker +
Also see the worker documentation -for more info.

+for more info.

Added in Synapse 1.89.0.

`run_background_tasks_on`

The worker that is used to run background tasks (e.g. cleaning up expired data). If not provided this @@ -3900,13 +3953,13 @@ requests from other workers.

Example configuration(#2, using UNIX sockets with a replication listener):

worker_listeners:
   - type: http
-    path: /var/run/synapse/worker_public.sock
+    path: /run/synapse/worker_replication.sock
     resources:
-      - names: [client, federation]
+      - names: [replication]
   - type: http
-    path: /var/run/synapse/worker_replication.sock
+    path: /run/synapse/worker_public.sock
     resources:
-      - names: [replication]
+      - names: [client, federation]

`worker_manhole`

@@ -4017,5 +4070,7 @@ Set a size to change the default. + + - \ No newline at end of file + diff --git a/latest/usage/configuration/homeserver_sample_config.html b/latest/usage/configuration/homeserver_sample_config.html index b69f0f0ba5..965a308d9f 100644 --- a/latest/usage/configuration/homeserver_sample_config.html +++ b/latest/usage/configuration/homeserver_sample_config.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +

+ +

@@ -239,5 +252,7 @@ trusted_key_servers: + + - \ No newline at end of file + diff --git a/latest/usage/configuration/index.html b/latest/usage/configuration/index.html index dc23ebb711..81f3e1647a 100644 --- a/latest/usage/configuration/index.html +++ b/latest/usage/configuration/index.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +

+ +