From 4adc33d520744afb6dc922cab34c6a6f81b977e6 Mon Sep 17 00:00:00 2001 From: clokep Date: Fri, 17 Nov 2023 13:44:41 +0000 Subject: deploy: c4f5522189687c1e739d63246b5a6668d89b2d5f --- latest/404.html | 2 +- latest/CAPTCHA_SETUP.html | 2 +- latest/admin_api/account_validity.html | 2 +- latest/admin_api/event_reports.html | 2 +- latest/admin_api/experimental_features.html | 2 +- latest/admin_api/media_admin_api.html | 2 +- latest/admin_api/purge_history_api.html | 2 +- latest/admin_api/register_api.html | 2 +- latest/admin_api/room_membership.html | 2 +- latest/admin_api/rooms.html | 2 +- latest/admin_api/server_notices.html | 2 +- latest/admin_api/statistics.html | 2 +- latest/admin_api/user_admin_api.html | 2 +- latest/admin_api/version_api.html | 2 +- latest/application_services.html | 2 +- latest/auth_chain_difference_algorithm.html | 2 +- latest/code_style.html | 2 +- latest/consent_tracking.html | 2 +- latest/delegate.html | 2 +- latest/deprecation_policy.html | 2 +- latest/development/cas.html | 2 +- latest/development/contributing_guide.html | 4 +- latest/development/database_schema.html | 2 +- latest/development/demo.html | 2 +- latest/development/dependencies.html | 2 +- latest/development/experimental_features.html | 2 +- latest/development/git.html | 2 +- .../development/internal_documentation/index.html | 2 +- latest/development/releases.html | 2 +- latest/development/reviews.html | 2 +- latest/development/room-dag-concepts.html | 2 +- latest/development/saml.html | 2 +- .../synapse_architecture/cancellation.html | 2 +- .../synapse_architecture/faster_joins.html | 2 +- .../development/synapse_architecture/streams.html | 14 +- latest/federate.html | 2 +- latest/index.html | 2 +- latest/jwt.html | 2 +- latest/log_contexts.html | 2 +- latest/manhole.html | 2 +- latest/media_repository.html | 2 +- latest/message_retention_policies.html | 2 +- latest/metrics-howto.html | 2 +- latest/modules/account_data_callbacks.html | 6 +- latest/modules/account_validity_callbacks.html | 2 +- ...add_extra_fields_to_client_events_unsigned.html | 210 +++++++++++++++++++++ .../background_update_controller_callbacks.html | 2 +- latest/modules/index.html | 2 +- .../modules/password_auth_provider_callbacks.html | 2 +- latest/modules/porting_legacy_module.html | 6 +- latest/modules/presence_router_callbacks.html | 14 +- latest/modules/spam_checker_callbacks.html | 2 +- latest/modules/third_party_rules_callbacks.html | 2 +- latest/modules/writing_a_module.html | 2 +- latest/openid.html | 2 +- latest/opentracing.html | 6 +- .../running_synapse_on_single_board_computers.html | 2 +- latest/password_auth_providers.html | 2 +- latest/postgres.html | 2 +- latest/print.html | 210 ++++++++++++++++----- latest/replication.html | 2 +- latest/reverse_proxy.html | 2 +- latest/room_and_user_statistics.html | 2 +- latest/searchindex.js | 2 +- latest/searchindex.json | 2 +- latest/server_notices.html | 2 +- latest/setup/forward_proxy.html | 2 +- latest/setup/installation.html | 2 +- latest/setup/turn/coturn.html | 2 +- latest/setup/turn/eturnal.html | 2 +- latest/sso_mapping_providers.html | 2 +- latest/structured_logging.html | 2 +- latest/synctl_workers.html | 2 +- latest/systemd-with-workers/index.html | 2 +- latest/tcp_replication.html | 2 +- latest/templates.html | 2 +- latest/turn-howto.html | 2 +- latest/upgrade.html | 2 +- .../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 | 2 +- .../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 | 2 +- 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 | 155 +++++++++++---- .../configuration/homeserver_sample_config.html | 2 +- latest/usage/configuration/index.html | 2 +- .../usage/configuration/logging_sample_config.html | 2 +- .../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 +- latest/user_directory.html | 2 +- latest/welcome_and_overview.html | 2 +- latest/workers.html | 2 +- 103 files changed, 615 insertions(+), 198 deletions(-) create mode 100644 latest/modules/add_extra_fields_to_client_events_unsigned.html (limited to 'latest') diff --git a/latest/404.html b/latest/404.html index 399c3a5829..9d2b63f465 100644 --- a/latest/404.html +++ b/latest/404.html @@ -77,7 +77,7 @@ diff --git a/latest/CAPTCHA_SETUP.html b/latest/CAPTCHA_SETUP.html index a0050f43fb..879a3289f3 100644 --- a/latest/CAPTCHA_SETUP.html +++ b/latest/CAPTCHA_SETUP.html @@ -76,7 +76,7 @@ diff --git a/latest/admin_api/account_validity.html b/latest/admin_api/account_validity.html index f6552ca2df..3f97284c26 100644 --- a/latest/admin_api/account_validity.html +++ b/latest/admin_api/account_validity.html @@ -76,7 +76,7 @@ diff --git a/latest/admin_api/event_reports.html b/latest/admin_api/event_reports.html index aabec67f60..fd2121e896 100644 --- a/latest/admin_api/event_reports.html +++ b/latest/admin_api/event_reports.html @@ -76,7 +76,7 @@ diff --git a/latest/admin_api/experimental_features.html b/latest/admin_api/experimental_features.html index 88b3e9aa0e..00b32d6429 100644 --- a/latest/admin_api/experimental_features.html +++ b/latest/admin_api/experimental_features.html @@ -76,7 +76,7 @@ diff --git a/latest/admin_api/media_admin_api.html b/latest/admin_api/media_admin_api.html index 89249d8c2c..0180aa291e 100644 --- a/latest/admin_api/media_admin_api.html +++ b/latest/admin_api/media_admin_api.html @@ -76,7 +76,7 @@ diff --git a/latest/admin_api/purge_history_api.html b/latest/admin_api/purge_history_api.html index 9b5e258b90..c40eedfa0d 100644 --- a/latest/admin_api/purge_history_api.html +++ b/latest/admin_api/purge_history_api.html @@ -76,7 +76,7 @@ diff --git a/latest/admin_api/register_api.html b/latest/admin_api/register_api.html index b3e4cbe917..af44e600ef 100644 --- a/latest/admin_api/register_api.html +++ b/latest/admin_api/register_api.html @@ -76,7 +76,7 @@ diff --git a/latest/admin_api/room_membership.html b/latest/admin_api/room_membership.html index b5b3e76b61..1db4204bba 100644 --- a/latest/admin_api/room_membership.html +++ b/latest/admin_api/room_membership.html @@ -76,7 +76,7 @@ diff --git a/latest/admin_api/rooms.html b/latest/admin_api/rooms.html index fe246b4041..dcc6af660a 100644 --- a/latest/admin_api/rooms.html +++ b/latest/admin_api/rooms.html @@ -76,7 +76,7 @@ diff --git a/latest/admin_api/server_notices.html b/latest/admin_api/server_notices.html index fdb9641d8c..8f2b92417f 100644 --- a/latest/admin_api/server_notices.html +++ b/latest/admin_api/server_notices.html @@ -76,7 +76,7 @@ diff --git a/latest/admin_api/statistics.html b/latest/admin_api/statistics.html index 323a1165e1..2b5f94d187 100644 --- a/latest/admin_api/statistics.html +++ b/latest/admin_api/statistics.html @@ -76,7 +76,7 @@ diff --git a/latest/admin_api/user_admin_api.html b/latest/admin_api/user_admin_api.html index 9c991b4542..2a473f2bee 100644 --- a/latest/admin_api/user_admin_api.html +++ b/latest/admin_api/user_admin_api.html @@ -76,7 +76,7 @@ diff --git a/latest/admin_api/version_api.html b/latest/admin_api/version_api.html index a48a7cd1ad..d2b3817223 100644 --- a/latest/admin_api/version_api.html +++ b/latest/admin_api/version_api.html @@ -76,7 +76,7 @@ diff --git a/latest/application_services.html b/latest/application_services.html index 3d7dd407d8..910777f19e 100644 --- a/latest/application_services.html +++ b/latest/application_services.html @@ -76,7 +76,7 @@ diff --git a/latest/auth_chain_difference_algorithm.html b/latest/auth_chain_difference_algorithm.html index d7d451fcfd..1acefd678e 100644 --- a/latest/auth_chain_difference_algorithm.html +++ b/latest/auth_chain_difference_algorithm.html @@ -76,7 +76,7 @@ diff --git a/latest/code_style.html b/latest/code_style.html index 02d716dbf6..70323b243f 100644 --- a/latest/code_style.html +++ b/latest/code_style.html @@ -76,7 +76,7 @@ diff --git a/latest/consent_tracking.html b/latest/consent_tracking.html index 7308c01531..abe5ded164 100644 --- a/latest/consent_tracking.html +++ b/latest/consent_tracking.html @@ -76,7 +76,7 @@ diff --git a/latest/delegate.html b/latest/delegate.html index fa99c564b2..20f1fcdd3f 100644 --- a/latest/delegate.html +++ b/latest/delegate.html @@ -76,7 +76,7 @@ diff --git a/latest/deprecation_policy.html b/latest/deprecation_policy.html index 95742bacae..cf8713a6b4 100644 --- a/latest/deprecation_policy.html +++ b/latest/deprecation_policy.html @@ -76,7 +76,7 @@ diff --git a/latest/development/cas.html b/latest/development/cas.html index ae35250574..0175828eac 100644 --- a/latest/development/cas.html +++ b/latest/development/cas.html @@ -76,7 +76,7 @@ diff --git a/latest/development/contributing_guide.html b/latest/development/contributing_guide.html index 1bf8403da6..f1c7b71fbe 100644 --- a/latest/development/contributing_guide.html +++ b/latest/development/contributing_guide.html @@ -76,7 +76,7 @@ @@ -189,7 +189,7 @@ source, you should install poetry. Of their installation methods, we recommend installing poetry using pipx,

pip install --user pipx
-pipx install poetry
+pipx install poetry==1.5.2  # Problems with Poetry 1.6, see https://github.com/matrix-org/synapse/issues/16147

but see poetry's installation instructions for other installation methods.

diff --git a/latest/development/database_schema.html b/latest/development/database_schema.html index 8dffa04d7a..0aeae50c98 100644 --- a/latest/development/database_schema.html +++ b/latest/development/database_schema.html @@ -76,7 +76,7 @@ diff --git a/latest/development/demo.html b/latest/development/demo.html index 2d4754ff33..ce8e259aa1 100644 --- a/latest/development/demo.html +++ b/latest/development/demo.html @@ -76,7 +76,7 @@ diff --git a/latest/development/dependencies.html b/latest/development/dependencies.html index f44f2db144..b4aecc2a51 100644 --- a/latest/development/dependencies.html +++ b/latest/development/dependencies.html @@ -76,7 +76,7 @@ diff --git a/latest/development/experimental_features.html b/latest/development/experimental_features.html index 98974dd4cd..bf06f62e93 100644 --- a/latest/development/experimental_features.html +++ b/latest/development/experimental_features.html @@ -76,7 +76,7 @@ diff --git a/latest/development/git.html b/latest/development/git.html index a6a9a322e6..34b9fb0ee3 100644 --- a/latest/development/git.html +++ b/latest/development/git.html @@ -76,7 +76,7 @@ diff --git a/latest/development/internal_documentation/index.html b/latest/development/internal_documentation/index.html index 10f4a067e1..51262280eb 100644 --- a/latest/development/internal_documentation/index.html +++ b/latest/development/internal_documentation/index.html @@ -76,7 +76,7 @@ diff --git a/latest/development/releases.html b/latest/development/releases.html index 4e96f192c1..30981828af 100644 --- a/latest/development/releases.html +++ b/latest/development/releases.html @@ -76,7 +76,7 @@ diff --git a/latest/development/reviews.html b/latest/development/reviews.html index ee932ce705..c30202f86f 100644 --- a/latest/development/reviews.html +++ b/latest/development/reviews.html @@ -76,7 +76,7 @@ diff --git a/latest/development/room-dag-concepts.html b/latest/development/room-dag-concepts.html index eaa06b291c..099a644e13 100644 --- a/latest/development/room-dag-concepts.html +++ b/latest/development/room-dag-concepts.html @@ -76,7 +76,7 @@ diff --git a/latest/development/saml.html b/latest/development/saml.html index 3a2e8ac490..3e3b9fb124 100644 --- a/latest/development/saml.html +++ b/latest/development/saml.html @@ -76,7 +76,7 @@ diff --git a/latest/development/synapse_architecture/cancellation.html b/latest/development/synapse_architecture/cancellation.html index 8f7d25bb88..097990e4a2 100644 --- a/latest/development/synapse_architecture/cancellation.html +++ b/latest/development/synapse_architecture/cancellation.html @@ -76,7 +76,7 @@ diff --git a/latest/development/synapse_architecture/faster_joins.html b/latest/development/synapse_architecture/faster_joins.html index dcb761384f..f43f49a007 100644 --- a/latest/development/synapse_architecture/faster_joins.html +++ b/latest/development/synapse_architecture/faster_joins.html @@ -76,7 +76,7 @@ diff --git a/latest/development/synapse_architecture/streams.html b/latest/development/synapse_architecture/streams.html index a76d3e8020..b940cdf006 100644 --- a/latest/development/synapse_architecture/streams.html +++ b/latest/development/synapse_architecture/streams.html @@ -76,7 +76,7 @@ @@ -186,16 +186,22 @@ will be inserted with that ID.

Current stream ID

For any given stream reader (including writers themselves), we may define a per-writer current stream ID:

-

The current stream ID for a writer W is the largest stream ID such that +

A current stream ID for a writer W is the largest stream ID such that all transactions added by W with equal or smaller ID have completed.

Similarly, there is a "linear" notion of current stream ID:

-

The "linear" current stream ID is the largest stream ID such that +

A "linear" current stream ID is the largest stream ID such that all facts (added by any writer) with equal or smaller ID have completed.

Because different stream readers A and B learn about new facts at different times, A and B may disagree about current stream IDs. Put differently: we should think of stream readers as being independent of each other, proceeding through a stream of facts at different rates.

+

The above definition does not give a unique current stream ID, in fact there can +be a range of current stream IDs. Synapse uses both the minimum and maximum IDs +for different purposes. Most often the maximum is used, as its generally +beneficial for workers to advance their IDs as soon as possible. However, the +minimum is used in situations where e.g. another worker is going to wait until +the stream advances past a position.

NB. For both senses of "current", that if a writer opens a transaction that never completes, the current stream ID will never advance beyond that writer's last written stream ID.

For single-writer streams, the per-writer current ID and the linear current ID are the same. Both senses of current ID are monotonic, but they may "skip" or jump over IDs because facts complete out of order.

@@ -238,7 +244,7 @@ We only ever treat this as a multiple single-writer streams as there is no impor
  • track their current position (i.e. its own per-writer stream ID).
  • their facts currently awaiting completion.
    • -

    At startup,

    +

    At startup,