From c67c41f4674407719cb59a01da98536f96fa1977 Mon Sep 17 00:00:00 2001 From: H-Shay Date: Tue, 31 Jan 2023 18:36:56 +0000 Subject: deploy: eafdb12dd8db985fbe1ac27ca75d28af8d4e4c5d --- .../admin_api/background_updates.html | 2 +- .../usage/administration/admin_api/federation.html | 2 +- latest/usage/administration/admin_api/index.html | 2 +- .../admin_api/registration_tokens.html | 2 +- latest/usage/administration/admin_faq.html | 7 ++++- .../administration/database_maintenance_tools.html | 2 +- latest/usage/administration/index.html | 2 +- .../reporting_homeserver_usage_statistics.html | 2 +- .../usage/administration/monthly_active_users.html | 2 +- latest/usage/administration/request_log.html | 4 +-- latest/usage/administration/state_groups.html | 2 +- ...derstanding_synapse_through_grafana_graphs.html | 2 +- .../administration/useful_sql_for_admins.html | 2 +- .../usage/configuration/config_documentation.html | 35 +++++++++++++++++++--- .../configuration/homeserver_sample_config.html | 2 +- latest/usage/configuration/index.html | 2 +- .../usage/configuration/logging_sample_config.html | 9 +++--- .../configuration/user_authentication/index.html | 2 +- .../user_authentication/refresh_tokens.html | 2 +- .../user_authentication/single_sign_on/cas.html | 2 +- .../user_authentication/single_sign_on/index.html | 2 +- .../user_authentication/single_sign_on/saml.html | 2 +- 22 files changed, 62 insertions(+), 29 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 c3ee1aea1c..7eeed7db2b 100644 --- a/latest/usage/administration/admin_api/background_updates.html +++ b/latest/usage/administration/admin_api/background_updates.html @@ -76,7 +76,7 @@ diff --git a/latest/usage/administration/admin_api/federation.html b/latest/usage/administration/admin_api/federation.html index 1f63f6fdd4..2742f6fdeb 100644 --- a/latest/usage/administration/admin_api/federation.html +++ b/latest/usage/administration/admin_api/federation.html @@ -76,7 +76,7 @@ diff --git a/latest/usage/administration/admin_api/index.html b/latest/usage/administration/admin_api/index.html index 62901ed644..1ee941a723 100644 --- a/latest/usage/administration/admin_api/index.html +++ b/latest/usage/administration/admin_api/index.html @@ -76,7 +76,7 @@ diff --git a/latest/usage/administration/admin_api/registration_tokens.html b/latest/usage/administration/admin_api/registration_tokens.html index c3415214de..b55896013d 100644 --- a/latest/usage/administration/admin_api/registration_tokens.html +++ b/latest/usage/administration/admin_api/registration_tokens.html @@ -76,7 +76,7 @@ diff --git a/latest/usage/administration/admin_faq.html b/latest/usage/administration/admin_faq.html index 4fb69892cd..cb8ce2a8bb 100644 --- a/latest/usage/administration/admin_faq.html +++ b/latest/usage/administration/admin_faq.html @@ -76,7 +76,7 @@ @@ -166,6 +166,11 @@

What users are registered on my server?

SELECT NAME from users;
+

How can I export user data?

+

Synapse includes a Python command to export data for a specific user. It takes the homeserver +configuration file and the full Matrix ID of the user to export:

+
python -m synapse.app.admin_cmd -c <config_file> export-data <user_id>
+

Manually resetting passwords

Users can reset their password through their client. Alternatively, a server admin can reset a user's password using the admin API.

diff --git a/latest/usage/administration/database_maintenance_tools.html b/latest/usage/administration/database_maintenance_tools.html index 1636d7239d..7ceb0a0f43 100644 --- a/latest/usage/administration/database_maintenance_tools.html +++ b/latest/usage/administration/database_maintenance_tools.html @@ -76,7 +76,7 @@ diff --git a/latest/usage/administration/index.html b/latest/usage/administration/index.html index b5226c18ad..5517ed230e 100644 --- a/latest/usage/administration/index.html +++ b/latest/usage/administration/index.html @@ -76,7 +76,7 @@ diff --git a/latest/usage/administration/monitoring/reporting_homeserver_usage_statistics.html b/latest/usage/administration/monitoring/reporting_homeserver_usage_statistics.html index f04402eab6..83ae341b8b 100644 --- a/latest/usage/administration/monitoring/reporting_homeserver_usage_statistics.html +++ b/latest/usage/administration/monitoring/reporting_homeserver_usage_statistics.html @@ -76,7 +76,7 @@ diff --git a/latest/usage/administration/monthly_active_users.html b/latest/usage/administration/monthly_active_users.html index 0b9b992bef..9400609263 100644 --- a/latest/usage/administration/monthly_active_users.html +++ b/latest/usage/administration/monthly_active_users.html @@ -76,7 +76,7 @@ diff --git a/latest/usage/administration/request_log.html b/latest/usage/administration/request_log.html index 38eceea543..2ba4afcae1 100644 --- a/latest/usage/administration/request_log.html +++ b/latest/usage/administration/request_log.html @@ -76,7 +76,7 @@ @@ -154,7 +154,7 @@ - + diff --git a/latest/usage/administration/state_groups.html b/latest/usage/administration/state_groups.html index 03bc079719..c8b6c2a6fc 100644 --- a/latest/usage/administration/state_groups.html +++ b/latest/usage/administration/state_groups.html @@ -76,7 +76,7 @@ diff --git a/latest/usage/administration/understanding_synapse_through_grafana_graphs.html b/latest/usage/administration/understanding_synapse_through_grafana_graphs.html index 715e258c92..2af0d720da 100644 --- a/latest/usage/administration/understanding_synapse_through_grafana_graphs.html +++ b/latest/usage/administration/understanding_synapse_through_grafana_graphs.html @@ -76,7 +76,7 @@ diff --git a/latest/usage/administration/useful_sql_for_admins.html b/latest/usage/administration/useful_sql_for_admins.html index 4565af12cd..906918936b 100644 --- a/latest/usage/administration/useful_sql_for_admins.html +++ b/latest/usage/administration/useful_sql_for_admins.html @@ -76,7 +76,7 @@ diff --git a/latest/usage/configuration/config_documentation.html b/latest/usage/configuration/config_documentation.html index 5ac7add384..f2f57562d4 100644 --- a/latest/usage/configuration/config_documentation.html +++ b/latest/usage/configuration/config_documentation.html @@ -76,7 +76,7 @@ @@ -372,7 +372,8 @@ rooms directory via federation. Defaults to false.

Known room versions are listed here

For example, for room version 1, default_room_version should be set to "1".

-

Currently defaults to "9".

+

Currently defaults to "10".

+

Changed in Synapse 1.76: the default version room version was increased from 9 to 10.

Example configuration:

default_room_version: "8"
@@ -469,6 +470,11 @@ configuration.

port: the TCP port to bind to.

  • +

    tag: An alias for the port in the logger name. If set the tag is logged instead +of the port. Default to None, is optional and only valid for listener with type: http. +See the docs request log format.

    +
    • +

  • bind_addresses: a list of local addresses to listen on. The default is 'all local interfaces'.

    • @@ -546,6 +552,13 @@ additional endpoints which should be loaded via dynamic modules.

  • static: static resources under synapse/static (/_matrix/static). (Mostly useful for 'fallback authentication'.)

    • +
  • +

    health: the health check endpoint. This endpoint +is by default active for all other resources and does not have to be activated separately. +This is only useful if you want to use the health endpoint explicitly on a dedicated port or +for workers and containers without listener e.g. +application services.

    +

    • Example configuration #1:

    listeners:
@@ -3112,8 +3125,8 @@ will also not affect rooms created by other servers.
    
 empty responses are returned to all queries. Defaults to true.
    
 
 
  • 
-
    search_all_users: Defines whether to search all users visible to your HS when searching
-the user directory. If false, search results will only contain users
+
    search_all_users: Defines whether to search all users visible to your HS at the time the search is performed. If set to true, will return all users who share a room with the user from the homeserver.
+If false, search results will only contain users
 visible in public rooms and users sharing a room with the requester.
 Defaults to false.
    
 
    NB. If you set this to true, and the last time the user_directory search
@@ -3570,6 +3583,20 @@ other workers.
    
       - names: [client, federation]
    • +

    worker_manhole

    +

    A worker may have a listener for manhole. +It allows server administrators to access a Python shell on the worker.

    +

    Example configuration:

    +
    worker_manhole: 9000
+
    +

    This is a short form for:

    +
    worker_listeners:
+  - port: 9000
+    bind_addresses: ['127.0.0.1']
+    type: manhole
+
    +

    It needs also an additional manhole_settings configuration.

    +

    worker_daemonize

    Specifies whether the worker should be started as a daemon process. If Synapse is being managed by systemd, this option diff --git a/latest/usage/configuration/homeserver_sample_config.html b/latest/usage/configuration/homeserver_sample_config.html index e48a4d48aa..ebcdf1a703 100644 --- a/latest/usage/configuration/homeserver_sample_config.html +++ b/latest/usage/configuration/homeserver_sample_config.html @@ -76,7 +76,7 @@

    diff --git a/latest/usage/configuration/index.html b/latest/usage/configuration/index.html index 52e8264c9d..1c495971ca 100644 --- a/latest/usage/configuration/index.html +++ b/latest/usage/configuration/index.html @@ -76,7 +76,7 @@ diff --git a/latest/usage/configuration/logging_sample_config.html b/latest/usage/configuration/logging_sample_config.html index c5272f82bc..1c284bb5e2 100644 --- a/latest/usage/configuration/logging_sample_config.html +++ b/latest/usage/configuration/logging_sample_config.html @@ -76,7 +76,7 @@ @@ -148,9 +148,10 @@

    Logging Sample Configuration File

    Below is a sample logging configuration file. This file can be tweaked to control how your -homeserver will output logs. A restart of the server is generally required to apply any -changes made to this file. The value of the log_config option in your homeserver -config should be the path to this file.

    +homeserver will output logs. The value of the log_config option in your homeserver config +should be the path to this file.

    +

    To apply changes made to this file, send Synapse a SIGHUP signal (or, if using systemd, run +systemctl reload on the Synapse service).

    Note that a default logging configuration (shown below) is created automatically alongside the homeserver config when following the installation instructions. It should be named <SERVERNAME>.log.config by default.

    diff --git a/latest/usage/configuration/user_authentication/index.html b/latest/usage/configuration/user_authentication/index.html index b3de5df11a..7547264240 100644 --- a/latest/usage/configuration/user_authentication/index.html +++ b/latest/usage/configuration/user_authentication/index.html @@ -76,7 +76,7 @@ diff --git a/latest/usage/configuration/user_authentication/refresh_tokens.html b/latest/usage/configuration/user_authentication/refresh_tokens.html index fc7b2c7483..f5c613a14a 100644 --- a/latest/usage/configuration/user_authentication/refresh_tokens.html +++ b/latest/usage/configuration/user_authentication/refresh_tokens.html @@ -76,7 +76,7 @@ diff --git a/latest/usage/configuration/user_authentication/single_sign_on/cas.html b/latest/usage/configuration/user_authentication/single_sign_on/cas.html index 2c1ebbba62..0a09ae308b 100644 --- a/latest/usage/configuration/user_authentication/single_sign_on/cas.html +++ b/latest/usage/configuration/user_authentication/single_sign_on/cas.html @@ -76,7 +76,7 @@ diff --git a/latest/usage/configuration/user_authentication/single_sign_on/index.html b/latest/usage/configuration/user_authentication/single_sign_on/index.html index df7ef55bc4..5e392a9f00 100644 --- a/latest/usage/configuration/user_authentication/single_sign_on/index.html +++ b/latest/usage/configuration/user_authentication/single_sign_on/index.html @@ -76,7 +76,7 @@ diff --git a/latest/usage/configuration/user_authentication/single_sign_on/saml.html b/latest/usage/configuration/user_authentication/single_sign_on/saml.html index 04b85e31ef..a37284424f 100644 --- a/latest/usage/configuration/user_authentication/single_sign_on/saml.html +++ b/latest/usage/configuration/user_authentication/single_sign_on/saml.html @@ -76,7 +76,7 @@ -- cgit 1.5.1
    PartExplanation
    AAAATimestamp request was logged (not received)
    BBBBLogger name (synapse.access.(http\|https).<tag>, where 'tag' is defined in the listeners config section, normally the port)
    BBBBLogger name (synapse.access.(http\|https).<tag>, where 'tag' is defined in the listeners config section, normally the port)
    CCCCLine number in code
    DDDDLog Level
    EEEERequest Identifier (This identifier is shared by related log lines)