From badfcd7688f6514665c9d62652251c9b833285fe Mon Sep 17 00:00:00 2001 From: reivilibre Date: Thu, 30 Jul 2026 11:35:43 +0000 Subject: [PATCH] deploy: 36664cac4fdec38993c68078cd9a82452b56dca7 --- develop/404.html | 4 +- develop/CAPTCHA_SETUP.html | 4 +- develop/admin_api/account_validity.html | 4 +- .../client_server_api_extensions.html | 4 +- develop/admin_api/event_reports.html | 4 +- develop/admin_api/experimental_features.html | 4 +- develop/admin_api/fetch_event.html | 4 +- develop/admin_api/media_admin_api.html | 4 +- develop/admin_api/purge_history_api.html | 4 +- develop/admin_api/register_api.html | 4 +- develop/admin_api/room_membership.html | 4 +- develop/admin_api/rooms.html | 4 +- develop/admin_api/scheduled_tasks.html | 4 +- develop/admin_api/server_notices.html | 4 +- develop/admin_api/statistics.html | 4 +- develop/admin_api/user_admin_api.html | 4 +- develop/admin_api/version_api.html | 4 +- develop/application_services.html | 4 +- develop/auth_chain_difference_algorithm.html | 4 +- develop/code_style.html | 4 +- develop/consent_tracking.html | 4 +- develop/delegate.html | 4 +- develop/deprecation_policy.html | 4 +- develop/development/cas.html | 4 +- develop/development/contributing_guide.html | 4 +- develop/development/database_schema.html | 4 +- develop/development/demo.html | 4 +- develop/development/dependencies.html | 4 +- .../development/experimental_features.html | 4 +- develop/development/git.html | 4 +- .../internal_documentation/index.html | 4 +- .../release_notes_review_checklist.html | 4 +- develop/development/releases.html | 4 +- develop/development/reviews.html | 4 +- develop/development/room-dag-concepts.html | 4 +- develop/development/saml.html | 4 +- .../synapse_architecture/cancellation.html | 4 +- .../synapse_architecture/faster_joins.html | 4 +- .../synapse_architecture/streams.html | 4 +- develop/federate.html | 4 +- develop/index.html | 4 +- develop/jwt.html | 4 +- develop/log_contexts.html | 4 +- develop/manhole.html | 4 +- develop/media_repository.html | 4 +- develop/message_retention_policies.html | 4 +- develop/metrics-howto.html | 4 +- develop/modules/account_data_callbacks.html | 4 +- .../modules/account_validity_callbacks.html | 4 +- ...xtra_fields_to_client_events_unsigned.html | 8 +- ...ackground_update_controller_callbacks.html | 4 +- develop/modules/federation_callbacks.html | 289 ++++++++++++++++++ develop/modules/index.html | 4 +- .../modules/media_repository_callbacks.html | 8 +- .../password_auth_provider_callbacks.html | 4 +- develop/modules/porting_legacy_module.html | 4 +- .../modules/presence_router_callbacks.html | 4 +- develop/modules/ratelimit_callbacks.html | 4 +- develop/modules/spam_checker_callbacks.html | 4 +- .../modules/third_party_rules_callbacks.html | 4 +- develop/modules/writing_a_module.html | 4 +- develop/openid.html | 4 +- develop/opentracing.html | 4 +- ...ing_synapse_on_single_board_computers.html | 4 +- develop/password_auth_providers.html | 4 +- develop/postgres.html | 4 +- develop/print.html | 35 ++- develop/replication.html | 4 +- develop/reverse_proxy.html | 4 +- develop/room_and_user_statistics.html | 4 +- develop/searcher-c2a407aa.js | 2 +- develop/searchindex-b0b4f94d.js | 1 + develop/searchindex-d60ccf57.js | 1 - develop/server_notices.html | 4 +- develop/setup/forward_proxy.html | 4 +- develop/setup/installation.html | 4 +- develop/setup/security.html | 4 +- develop/setup/turn/coturn.html | 4 +- develop/setup/turn/eturnal.html | 4 +- develop/sso_mapping_providers.html | 4 +- develop/structured_logging.html | 4 +- develop/synctl_workers.html | 4 +- develop/systemd-with-workers/index.html | 4 +- develop/tcp_replication.html | 4 +- develop/templates.html | 4 +- develop/{toc-4dc10a98.js => toc-64310643.js} | 2 +- develop/toc.html | 2 +- develop/turn-howto.html | 4 +- develop/upgrade.html | 4 +- .../admin_api/background_updates.html | 4 +- .../administration/admin_api/federation.html | 4 +- .../usage/administration/admin_api/index.html | 4 +- .../admin_api/registration_tokens.html | 4 +- develop/usage/administration/admin_faq.html | 4 +- develop/usage/administration/backups.html | 4 +- .../database_maintenance_tools.html | 4 +- develop/usage/administration/index.html | 4 +- ...reporting_homeserver_usage_statistics.html | 4 +- .../administration/monthly_active_users.html | 4 +- develop/usage/administration/request_log.html | 4 +- .../usage/administration/state_groups.html | 4 +- ...anding_synapse_through_grafana_graphs.html | 4 +- .../administration/useful_sql_for_admins.html | 4 +- .../configuration/config_documentation.html | 4 +- .../homeserver_sample_config.html | 4 +- develop/usage/configuration/index.html | 4 +- .../configuration/logging_sample_config.html | 4 +- .../user_authentication/index.html | 4 +- .../user_authentication/refresh_tokens.html | 4 +- .../single_sign_on/cas.html | 4 +- .../single_sign_on/index.html | 4 +- .../single_sign_on/saml.html | 4 +- develop/user_directory.html | 4 +- develop/welcome_and_overview.html | 4 +- develop/workers.html | 4 +- 115 files changed, 546 insertions(+), 226 deletions(-) create mode 100644 develop/modules/federation_callbacks.html create mode 100644 develop/searchindex-b0b4f94d.js delete mode 100644 develop/searchindex-d60ccf57.js rename develop/{toc-4dc10a98.js => toc-64310643.js} (74%) diff --git a/develop/404.html b/develop/404.html index bb99b5f47a..421f957ab3 100644 --- a/develop/404.html +++ b/develop/404.html @@ -38,10 +38,10 @@ const path_to_root = ""; const default_light_theme = "light"; const default_dark_theme = "navy"; - window.path_to_searchindex_js = "searchindex-d60ccf57.js"; + window.path_to_searchindex_js = "searchindex-b0b4f94d.js"; - +
diff --git a/develop/CAPTCHA_SETUP.html b/develop/CAPTCHA_SETUP.html index 9f1ea82ee7..6fce0d40d3 100644 --- a/develop/CAPTCHA_SETUP.html +++ b/develop/CAPTCHA_SETUP.html @@ -37,10 +37,10 @@ const path_to_root = ""; const default_light_theme = "light"; const default_dark_theme = "navy"; - window.path_to_searchindex_js = "searchindex-d60ccf57.js"; + window.path_to_searchindex_js = "searchindex-b0b4f94d.js"; - +
diff --git a/develop/admin_api/account_validity.html b/develop/admin_api/account_validity.html index 00ec1fd638..e01ce1bf69 100644 --- a/develop/admin_api/account_validity.html +++ b/develop/admin_api/account_validity.html @@ -37,10 +37,10 @@ const path_to_root = "../"; const default_light_theme = "light"; const default_dark_theme = "navy"; - window.path_to_searchindex_js = "../searchindex-d60ccf57.js"; + window.path_to_searchindex_js = "../searchindex-b0b4f94d.js"; - +
diff --git a/develop/admin_api/client_server_api_extensions.html b/develop/admin_api/client_server_api_extensions.html index 790984fa37..c38c691c4d 100644 --- a/develop/admin_api/client_server_api_extensions.html +++ b/develop/admin_api/client_server_api_extensions.html @@ -37,10 +37,10 @@ const path_to_root = "../"; const default_light_theme = "light"; const default_dark_theme = "navy"; - window.path_to_searchindex_js = "../searchindex-d60ccf57.js"; + window.path_to_searchindex_js = "../searchindex-b0b4f94d.js"; - +
diff --git a/develop/admin_api/event_reports.html b/develop/admin_api/event_reports.html index b06f1ecf2f..143f79e6f1 100644 --- a/develop/admin_api/event_reports.html +++ b/develop/admin_api/event_reports.html @@ -37,10 +37,10 @@ const path_to_root = "../"; const default_light_theme = "light"; const default_dark_theme = "navy"; - window.path_to_searchindex_js = "../searchindex-d60ccf57.js"; + window.path_to_searchindex_js = "../searchindex-b0b4f94d.js"; - +
diff --git a/develop/admin_api/experimental_features.html b/develop/admin_api/experimental_features.html index 9c9903b311..e5e3d1e5df 100644 --- a/develop/admin_api/experimental_features.html +++ b/develop/admin_api/experimental_features.html @@ -37,10 +37,10 @@ const path_to_root = "../"; const default_light_theme = "light"; const default_dark_theme = "navy"; - window.path_to_searchindex_js = "../searchindex-d60ccf57.js"; + window.path_to_searchindex_js = "../searchindex-b0b4f94d.js"; - +
diff --git a/develop/admin_api/fetch_event.html b/develop/admin_api/fetch_event.html index 3953bad3ff..3aad7812b8 100644 --- a/develop/admin_api/fetch_event.html +++ b/develop/admin_api/fetch_event.html @@ -37,10 +37,10 @@ const path_to_root = "../"; const default_light_theme = "light"; const default_dark_theme = "navy"; - window.path_to_searchindex_js = "../searchindex-d60ccf57.js"; + window.path_to_searchindex_js = "../searchindex-b0b4f94d.js"; - +
diff --git a/develop/admin_api/media_admin_api.html b/develop/admin_api/media_admin_api.html index 8316055e1a..a46124e6ac 100644 --- a/develop/admin_api/media_admin_api.html +++ b/develop/admin_api/media_admin_api.html @@ -37,10 +37,10 @@ const path_to_root = "../"; const default_light_theme = "light"; const default_dark_theme = "navy"; - window.path_to_searchindex_js = "../searchindex-d60ccf57.js"; + window.path_to_searchindex_js = "../searchindex-b0b4f94d.js"; - +
diff --git a/develop/admin_api/purge_history_api.html b/develop/admin_api/purge_history_api.html index 52d16287d7..b8971caa32 100644 --- a/develop/admin_api/purge_history_api.html +++ b/develop/admin_api/purge_history_api.html @@ -37,10 +37,10 @@ const path_to_root = "../"; const default_light_theme = "light"; const default_dark_theme = "navy"; - window.path_to_searchindex_js = "../searchindex-d60ccf57.js"; + window.path_to_searchindex_js = "../searchindex-b0b4f94d.js"; - +
diff --git a/develop/admin_api/register_api.html b/develop/admin_api/register_api.html index 7c1af86c54..d3872a16f6 100644 --- a/develop/admin_api/register_api.html +++ b/develop/admin_api/register_api.html @@ -37,10 +37,10 @@ const path_to_root = "../"; const default_light_theme = "light"; const default_dark_theme = "navy"; - window.path_to_searchindex_js = "../searchindex-d60ccf57.js"; + window.path_to_searchindex_js = "../searchindex-b0b4f94d.js"; - +
diff --git a/develop/admin_api/room_membership.html b/develop/admin_api/room_membership.html index 7dd373045e..8a9e0e96cb 100644 --- a/develop/admin_api/room_membership.html +++ b/develop/admin_api/room_membership.html @@ -37,10 +37,10 @@ const path_to_root = "../"; const default_light_theme = "light"; const default_dark_theme = "navy"; - window.path_to_searchindex_js = "../searchindex-d60ccf57.js"; + window.path_to_searchindex_js = "../searchindex-b0b4f94d.js"; - +
diff --git a/develop/admin_api/rooms.html b/develop/admin_api/rooms.html index 3c5366becf..172b5fd3d3 100644 --- a/develop/admin_api/rooms.html +++ b/develop/admin_api/rooms.html @@ -37,10 +37,10 @@ const path_to_root = "../"; const default_light_theme = "light"; const default_dark_theme = "navy"; - window.path_to_searchindex_js = "../searchindex-d60ccf57.js"; + window.path_to_searchindex_js = "../searchindex-b0b4f94d.js"; - +
diff --git a/develop/admin_api/scheduled_tasks.html b/develop/admin_api/scheduled_tasks.html index 7347bb8310..6fe03e6adb 100644 --- a/develop/admin_api/scheduled_tasks.html +++ b/develop/admin_api/scheduled_tasks.html @@ -37,10 +37,10 @@ const path_to_root = "../"; const default_light_theme = "light"; const default_dark_theme = "navy"; - window.path_to_searchindex_js = "../searchindex-d60ccf57.js"; + window.path_to_searchindex_js = "../searchindex-b0b4f94d.js"; - +
diff --git a/develop/admin_api/server_notices.html b/develop/admin_api/server_notices.html index 46a99351c9..64ff0785e8 100644 --- a/develop/admin_api/server_notices.html +++ b/develop/admin_api/server_notices.html @@ -37,10 +37,10 @@ const path_to_root = "../"; const default_light_theme = "light"; const default_dark_theme = "navy"; - window.path_to_searchindex_js = "../searchindex-d60ccf57.js"; + window.path_to_searchindex_js = "../searchindex-b0b4f94d.js"; - +
diff --git a/develop/admin_api/statistics.html b/develop/admin_api/statistics.html index 82c1806665..5d6c0a9b26 100644 --- a/develop/admin_api/statistics.html +++ b/develop/admin_api/statistics.html @@ -37,10 +37,10 @@ const path_to_root = "../"; const default_light_theme = "light"; const default_dark_theme = "navy"; - window.path_to_searchindex_js = "../searchindex-d60ccf57.js"; + window.path_to_searchindex_js = "../searchindex-b0b4f94d.js"; - +
diff --git a/develop/admin_api/user_admin_api.html b/develop/admin_api/user_admin_api.html index 59cd19e642..a62bafca49 100644 --- a/develop/admin_api/user_admin_api.html +++ b/develop/admin_api/user_admin_api.html @@ -37,10 +37,10 @@ const path_to_root = "../"; const default_light_theme = "light"; const default_dark_theme = "navy"; - window.path_to_searchindex_js = "../searchindex-d60ccf57.js"; + window.path_to_searchindex_js = "../searchindex-b0b4f94d.js"; - +
diff --git a/develop/admin_api/version_api.html b/develop/admin_api/version_api.html index c775817787..65f617e3ac 100644 --- a/develop/admin_api/version_api.html +++ b/develop/admin_api/version_api.html @@ -37,10 +37,10 @@ const path_to_root = "../"; const default_light_theme = "light"; const default_dark_theme = "navy"; - window.path_to_searchindex_js = "../searchindex-d60ccf57.js"; + window.path_to_searchindex_js = "../searchindex-b0b4f94d.js"; - +
diff --git a/develop/application_services.html b/develop/application_services.html index 0650020f94..83917b8d92 100644 --- a/develop/application_services.html +++ b/develop/application_services.html @@ -37,10 +37,10 @@ const path_to_root = ""; const default_light_theme = "light"; const default_dark_theme = "navy"; - window.path_to_searchindex_js = "searchindex-d60ccf57.js"; + window.path_to_searchindex_js = "searchindex-b0b4f94d.js"; - +
diff --git a/develop/auth_chain_difference_algorithm.html b/develop/auth_chain_difference_algorithm.html index 3bee422bf7..82e38c82af 100644 --- a/develop/auth_chain_difference_algorithm.html +++ b/develop/auth_chain_difference_algorithm.html @@ -37,10 +37,10 @@ const path_to_root = ""; const default_light_theme = "light"; const default_dark_theme = "navy"; - window.path_to_searchindex_js = "searchindex-d60ccf57.js"; + window.path_to_searchindex_js = "searchindex-b0b4f94d.js"; - +
diff --git a/develop/code_style.html b/develop/code_style.html index 36b35d7c05..50a4d8b2db 100644 --- a/develop/code_style.html +++ b/develop/code_style.html @@ -37,10 +37,10 @@ const path_to_root = ""; const default_light_theme = "light"; const default_dark_theme = "navy"; - window.path_to_searchindex_js = "searchindex-d60ccf57.js"; + window.path_to_searchindex_js = "searchindex-b0b4f94d.js"; - +
diff --git a/develop/consent_tracking.html b/develop/consent_tracking.html index a05f1ddb73..bf310b3ca9 100644 --- a/develop/consent_tracking.html +++ b/develop/consent_tracking.html @@ -37,10 +37,10 @@ const path_to_root = ""; const default_light_theme = "light"; const default_dark_theme = "navy"; - window.path_to_searchindex_js = "searchindex-d60ccf57.js"; + window.path_to_searchindex_js = "searchindex-b0b4f94d.js"; - +
diff --git a/develop/delegate.html b/develop/delegate.html index 93ae871889..d4889386ce 100644 --- a/develop/delegate.html +++ b/develop/delegate.html @@ -37,10 +37,10 @@ const path_to_root = ""; const default_light_theme = "light"; const default_dark_theme = "navy"; - window.path_to_searchindex_js = "searchindex-d60ccf57.js"; + window.path_to_searchindex_js = "searchindex-b0b4f94d.js"; - +
diff --git a/develop/deprecation_policy.html b/develop/deprecation_policy.html index 71a534011b..a6fceeab88 100644 --- a/develop/deprecation_policy.html +++ b/develop/deprecation_policy.html @@ -37,10 +37,10 @@ const path_to_root = ""; const default_light_theme = "light"; const default_dark_theme = "navy"; - window.path_to_searchindex_js = "searchindex-d60ccf57.js"; + window.path_to_searchindex_js = "searchindex-b0b4f94d.js"; - +
diff --git a/develop/development/cas.html b/develop/development/cas.html index 5db8d79b8d..0356db0c1f 100644 --- a/develop/development/cas.html +++ b/develop/development/cas.html @@ -37,10 +37,10 @@ const path_to_root = "../"; const default_light_theme = "light"; const default_dark_theme = "navy"; - window.path_to_searchindex_js = "../searchindex-d60ccf57.js"; + window.path_to_searchindex_js = "../searchindex-b0b4f94d.js"; - +
diff --git a/develop/development/contributing_guide.html b/develop/development/contributing_guide.html index 4eda1965bc..724fe36e05 100644 --- a/develop/development/contributing_guide.html +++ b/develop/development/contributing_guide.html @@ -37,10 +37,10 @@ const path_to_root = "../"; const default_light_theme = "light"; const default_dark_theme = "navy"; - window.path_to_searchindex_js = "../searchindex-d60ccf57.js"; + window.path_to_searchindex_js = "../searchindex-b0b4f94d.js"; - +
diff --git a/develop/development/database_schema.html b/develop/development/database_schema.html index 9a53b185e9..d1eebd5dc8 100644 --- a/develop/development/database_schema.html +++ b/develop/development/database_schema.html @@ -37,10 +37,10 @@ const path_to_root = "../"; const default_light_theme = "light"; const default_dark_theme = "navy"; - window.path_to_searchindex_js = "../searchindex-d60ccf57.js"; + window.path_to_searchindex_js = "../searchindex-b0b4f94d.js"; - +
diff --git a/develop/development/demo.html b/develop/development/demo.html index e97bb233e6..b3880512d9 100644 --- a/develop/development/demo.html +++ b/develop/development/demo.html @@ -37,10 +37,10 @@ const path_to_root = "../"; const default_light_theme = "light"; const default_dark_theme = "navy"; - window.path_to_searchindex_js = "../searchindex-d60ccf57.js"; + window.path_to_searchindex_js = "../searchindex-b0b4f94d.js"; - +
diff --git a/develop/development/dependencies.html b/develop/development/dependencies.html index 2ce4647de5..9d363068c6 100644 --- a/develop/development/dependencies.html +++ b/develop/development/dependencies.html @@ -37,10 +37,10 @@ const path_to_root = "../"; const default_light_theme = "light"; const default_dark_theme = "navy"; - window.path_to_searchindex_js = "../searchindex-d60ccf57.js"; + window.path_to_searchindex_js = "../searchindex-b0b4f94d.js"; - +
diff --git a/develop/development/experimental_features.html b/develop/development/experimental_features.html index 0a7dab856f..45587636a2 100644 --- a/develop/development/experimental_features.html +++ b/develop/development/experimental_features.html @@ -37,10 +37,10 @@ const path_to_root = "../"; const default_light_theme = "light"; const default_dark_theme = "navy"; - window.path_to_searchindex_js = "../searchindex-d60ccf57.js"; + window.path_to_searchindex_js = "../searchindex-b0b4f94d.js"; - +
diff --git a/develop/development/git.html b/develop/development/git.html index 96010ca9a1..d9128bc60d 100644 --- a/develop/development/git.html +++ b/develop/development/git.html @@ -37,10 +37,10 @@ const path_to_root = "../"; const default_light_theme = "light"; const default_dark_theme = "navy"; - window.path_to_searchindex_js = "../searchindex-d60ccf57.js"; + window.path_to_searchindex_js = "../searchindex-b0b4f94d.js"; - +
diff --git a/develop/development/internal_documentation/index.html b/develop/development/internal_documentation/index.html index 8e7cda1d8b..13bc8ae80f 100644 --- a/develop/development/internal_documentation/index.html +++ b/develop/development/internal_documentation/index.html @@ -37,10 +37,10 @@ const path_to_root = "../../"; const default_light_theme = "light"; const default_dark_theme = "navy"; - window.path_to_searchindex_js = "../../searchindex-d60ccf57.js"; + window.path_to_searchindex_js = "../../searchindex-b0b4f94d.js"; - +
diff --git a/develop/development/internal_documentation/release_notes_review_checklist.html b/develop/development/internal_documentation/release_notes_review_checklist.html index 34fdf81668..1c851671d7 100644 --- a/develop/development/internal_documentation/release_notes_review_checklist.html +++ b/develop/development/internal_documentation/release_notes_review_checklist.html @@ -37,10 +37,10 @@ const path_to_root = "../../"; const default_light_theme = "light"; const default_dark_theme = "navy"; - window.path_to_searchindex_js = "../../searchindex-d60ccf57.js"; + window.path_to_searchindex_js = "../../searchindex-b0b4f94d.js"; - +
diff --git a/develop/development/releases.html b/develop/development/releases.html index d7e97a5f18..a7357643ba 100644 --- a/develop/development/releases.html +++ b/develop/development/releases.html @@ -37,10 +37,10 @@ const path_to_root = "../"; const default_light_theme = "light"; const default_dark_theme = "navy"; - window.path_to_searchindex_js = "../searchindex-d60ccf57.js"; + window.path_to_searchindex_js = "../searchindex-b0b4f94d.js"; - +
diff --git a/develop/development/reviews.html b/develop/development/reviews.html index f7d0760237..16898648f5 100644 --- a/develop/development/reviews.html +++ b/develop/development/reviews.html @@ -37,10 +37,10 @@ const path_to_root = "../"; const default_light_theme = "light"; const default_dark_theme = "navy"; - window.path_to_searchindex_js = "../searchindex-d60ccf57.js"; + window.path_to_searchindex_js = "../searchindex-b0b4f94d.js"; - +
diff --git a/develop/development/room-dag-concepts.html b/develop/development/room-dag-concepts.html index 78975bdc3f..b54007ff33 100644 --- a/develop/development/room-dag-concepts.html +++ b/develop/development/room-dag-concepts.html @@ -37,10 +37,10 @@ const path_to_root = "../"; const default_light_theme = "light"; const default_dark_theme = "navy"; - window.path_to_searchindex_js = "../searchindex-d60ccf57.js"; + window.path_to_searchindex_js = "../searchindex-b0b4f94d.js"; - +
diff --git a/develop/development/saml.html b/develop/development/saml.html index 3744acc239..1f3b240ce7 100644 --- a/develop/development/saml.html +++ b/develop/development/saml.html @@ -37,10 +37,10 @@ const path_to_root = "../"; const default_light_theme = "light"; const default_dark_theme = "navy"; - window.path_to_searchindex_js = "../searchindex-d60ccf57.js"; + window.path_to_searchindex_js = "../searchindex-b0b4f94d.js"; - +
diff --git a/develop/development/synapse_architecture/cancellation.html b/develop/development/synapse_architecture/cancellation.html index 4e7430ed25..2120b02f9d 100644 --- a/develop/development/synapse_architecture/cancellation.html +++ b/develop/development/synapse_architecture/cancellation.html @@ -37,10 +37,10 @@ const path_to_root = "../../"; const default_light_theme = "light"; const default_dark_theme = "navy"; - window.path_to_searchindex_js = "../../searchindex-d60ccf57.js"; + window.path_to_searchindex_js = "../../searchindex-b0b4f94d.js"; - +
diff --git a/develop/development/synapse_architecture/faster_joins.html b/develop/development/synapse_architecture/faster_joins.html index 710c47ddd9..338b5c43d3 100644 --- a/develop/development/synapse_architecture/faster_joins.html +++ b/develop/development/synapse_architecture/faster_joins.html @@ -37,10 +37,10 @@ const path_to_root = "../../"; const default_light_theme = "light"; const default_dark_theme = "navy"; - window.path_to_searchindex_js = "../../searchindex-d60ccf57.js"; + window.path_to_searchindex_js = "../../searchindex-b0b4f94d.js"; - +
diff --git a/develop/development/synapse_architecture/streams.html b/develop/development/synapse_architecture/streams.html index 0054009e61..9e7d498432 100644 --- a/develop/development/synapse_architecture/streams.html +++ b/develop/development/synapse_architecture/streams.html @@ -37,10 +37,10 @@ const path_to_root = "../../"; const default_light_theme = "light"; const default_dark_theme = "navy"; - window.path_to_searchindex_js = "../../searchindex-d60ccf57.js"; + window.path_to_searchindex_js = "../../searchindex-b0b4f94d.js"; - +
diff --git a/develop/federate.html b/develop/federate.html index 18c12036e0..046cb44134 100644 --- a/develop/federate.html +++ b/develop/federate.html @@ -37,10 +37,10 @@ const path_to_root = ""; const default_light_theme = "light"; const default_dark_theme = "navy"; - window.path_to_searchindex_js = "searchindex-d60ccf57.js"; + window.path_to_searchindex_js = "searchindex-b0b4f94d.js"; - +
diff --git a/develop/index.html b/develop/index.html index c85c6f9a74..80312169ec 100644 --- a/develop/index.html +++ b/develop/index.html @@ -37,10 +37,10 @@ const path_to_root = ""; const default_light_theme = "light"; const default_dark_theme = "navy"; - window.path_to_searchindex_js = "searchindex-d60ccf57.js"; + window.path_to_searchindex_js = "searchindex-b0b4f94d.js"; - +
diff --git a/develop/jwt.html b/develop/jwt.html index c6ccee634e..af201b0cfd 100644 --- a/develop/jwt.html +++ b/develop/jwt.html @@ -37,10 +37,10 @@ const path_to_root = ""; const default_light_theme = "light"; const default_dark_theme = "navy"; - window.path_to_searchindex_js = "searchindex-d60ccf57.js"; + window.path_to_searchindex_js = "searchindex-b0b4f94d.js"; - +
diff --git a/develop/log_contexts.html b/develop/log_contexts.html index 157d33599f..61775e39f1 100644 --- a/develop/log_contexts.html +++ b/develop/log_contexts.html @@ -37,10 +37,10 @@ const path_to_root = ""; const default_light_theme = "light"; const default_dark_theme = "navy"; - window.path_to_searchindex_js = "searchindex-d60ccf57.js"; + window.path_to_searchindex_js = "searchindex-b0b4f94d.js"; - +
diff --git a/develop/manhole.html b/develop/manhole.html index cd7ca38fc7..30687e6934 100644 --- a/develop/manhole.html +++ b/develop/manhole.html @@ -37,10 +37,10 @@ const path_to_root = ""; const default_light_theme = "light"; const default_dark_theme = "navy"; - window.path_to_searchindex_js = "searchindex-d60ccf57.js"; + window.path_to_searchindex_js = "searchindex-b0b4f94d.js"; - +
diff --git a/develop/media_repository.html b/develop/media_repository.html index 60bc9b8f7a..c9a2aa0f67 100644 --- a/develop/media_repository.html +++ b/develop/media_repository.html @@ -37,10 +37,10 @@ const path_to_root = ""; const default_light_theme = "light"; const default_dark_theme = "navy"; - window.path_to_searchindex_js = "searchindex-d60ccf57.js"; + window.path_to_searchindex_js = "searchindex-b0b4f94d.js"; - +
diff --git a/develop/message_retention_policies.html b/develop/message_retention_policies.html index 1faa356521..a7fccd51ce 100644 --- a/develop/message_retention_policies.html +++ b/develop/message_retention_policies.html @@ -37,10 +37,10 @@ const path_to_root = ""; const default_light_theme = "light"; const default_dark_theme = "navy"; - window.path_to_searchindex_js = "searchindex-d60ccf57.js"; + window.path_to_searchindex_js = "searchindex-b0b4f94d.js"; - +
diff --git a/develop/metrics-howto.html b/develop/metrics-howto.html index 0b5265ad59..e2ba623c43 100644 --- a/develop/metrics-howto.html +++ b/develop/metrics-howto.html @@ -37,10 +37,10 @@ const path_to_root = ""; const default_light_theme = "light"; const default_dark_theme = "navy"; - window.path_to_searchindex_js = "searchindex-d60ccf57.js"; + window.path_to_searchindex_js = "searchindex-b0b4f94d.js"; - +
diff --git a/develop/modules/account_data_callbacks.html b/develop/modules/account_data_callbacks.html index a41658dc01..43b6533847 100644 --- a/develop/modules/account_data_callbacks.html +++ b/develop/modules/account_data_callbacks.html @@ -37,10 +37,10 @@ const path_to_root = "../"; const default_light_theme = "light"; const default_dark_theme = "navy"; - window.path_to_searchindex_js = "../searchindex-d60ccf57.js"; + window.path_to_searchindex_js = "../searchindex-b0b4f94d.js"; - +
diff --git a/develop/modules/account_validity_callbacks.html b/develop/modules/account_validity_callbacks.html index 428a5cb8bc..e340b91e1f 100644 --- a/develop/modules/account_validity_callbacks.html +++ b/develop/modules/account_validity_callbacks.html @@ -37,10 +37,10 @@ const path_to_root = "../"; const default_light_theme = "light"; const default_dark_theme = "navy"; - window.path_to_searchindex_js = "../searchindex-d60ccf57.js"; + window.path_to_searchindex_js = "../searchindex-b0b4f94d.js"; - +
diff --git a/develop/modules/add_extra_fields_to_client_events_unsigned.html b/develop/modules/add_extra_fields_to_client_events_unsigned.html index a480875d69..5c8317ec69 100644 --- a/develop/modules/add_extra_fields_to_client_events_unsigned.html +++ b/develop/modules/add_extra_fields_to_client_events_unsigned.html @@ -37,10 +37,10 @@ const path_to_root = "../"; const default_light_theme = "light"; const default_dark_theme = "navy"; - window.path_to_searchindex_js = "../searchindex-d60ccf57.js"; + window.path_to_searchindex_js = "../searchindex-b0b4f94d.js"; - +
@@ -227,7 +227,7 @@ section, the last-registered callback wins.

- @@ -241,7 +241,7 @@ section, the last-registered callback wins.

- diff --git a/develop/modules/background_update_controller_callbacks.html b/develop/modules/background_update_controller_callbacks.html index a3b783361d..74e8503386 100644 --- a/develop/modules/background_update_controller_callbacks.html +++ b/develop/modules/background_update_controller_callbacks.html @@ -37,10 +37,10 @@ const path_to_root = "../"; const default_light_theme = "light"; const default_dark_theme = "navy"; - window.path_to_searchindex_js = "../searchindex-d60ccf57.js"; + window.path_to_searchindex_js = "../searchindex-b0b4f94d.js"; - +
diff --git a/develop/modules/federation_callbacks.html b/develop/modules/federation_callbacks.html new file mode 100644 index 0000000000..81fec0400d --- /dev/null +++ b/develop/modules/federation_callbacks.html @@ -0,0 +1,289 @@ + + + + + + Federation callbacks - Synapse + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+

Keyboard shortcuts

+
+

Press or to navigate between chapters

+

Press S or / to search in the book

+

Press ? to show this help

+

Press Esc to hide this help

+
+
+
+
+ + + + + + + + + + + + + +
+ +
+
+ + + + + + + +
+
+

Federation callbacks

+

Federation callbacks can be registered using the module API’s register_federation_callbacks method.

+

Callbacks

+

The available federation callbacks are:

+

on_event_delivered_over_federation

+

First introduced in Synapse v1.158.0

+
async def on_event_delivered_over_federation(
+    event: FederationEventDeliveryEvent,
+) -> None:
+
+

Called when an event has been delivered over federation. +See FederationEventDeliveryEvent for detailed information available on the event.

+

Note that depending on the specific method, delivery may not have +actually been acknowledged by the other homeserver. +See FederatedEventDeliveryMethod for details on which cases imply acknowledgment.

+

Modules should anticipate more methods being added to the FederatedEventDeliveryMethod enum +over time (it is non-exhaustive).

+

Only methods that deliver full, signed PDUs are included in this mechanism. +Some notable examples of excluded endpoints:

+
    +
  • /send_knock is excluded as it only returns unsigned ‘stripped state’.
  • +
  • /timestamp_to_event is excluded as it only returns event IDs, not events themselves.
  • +
+

If multiple modules implement this callback, Synapse runs them all in order. +Exceptions are logged and otherwise ignored.

+

Performance note:

+
    +
  • Registering this hook causes a performance (caching) optimisation on the +Federation /state endpoint to be bypassed.
  • +
+ +
+ + +
+
+ + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + diff --git a/develop/modules/index.html b/develop/modules/index.html index 3309edb71a..1f338b391b 100644 --- a/develop/modules/index.html +++ b/develop/modules/index.html @@ -37,10 +37,10 @@ const path_to_root = "../"; const default_light_theme = "light"; const default_dark_theme = "navy"; - window.path_to_searchindex_js = "../searchindex-d60ccf57.js"; + window.path_to_searchindex_js = "../searchindex-b0b4f94d.js"; - +
diff --git a/develop/modules/media_repository_callbacks.html b/develop/modules/media_repository_callbacks.html index f59c8d9daf..b8177206c0 100644 --- a/develop/modules/media_repository_callbacks.html +++ b/develop/modules/media_repository_callbacks.html @@ -37,10 +37,10 @@ const path_to_root = "../"; const default_light_theme = "light"; const default_dark_theme = "navy"; - window.path_to_searchindex_js = "../searchindex-d60ccf57.js"; + window.path_to_searchindex_js = "../searchindex-b0b4f94d.js"; - +
@@ -296,7 +296,7 @@ some external method.