From 91d9afe214455ad1f27029ea5abb9fc9aced5adb Mon Sep 17 00:00:00 2001 From: Action Bot Date: Mon, 11 Dec 2023 14:54:26 +0000 Subject: [PATCH] Version picker deployed for v1.82 docs to Github Pages --- v1.82/.nojekyll | 1 - v1.82/.sample_config_header.yaml | 12 -- v1.82/404.html | 17 ++- v1.82/CAPTCHA_SETUP.html | 17 ++- v1.82/admin_api/account_validity.html | 17 ++- v1.82/admin_api/event_reports.html | 17 ++- v1.82/admin_api/media_admin_api.html | 17 ++- v1.82/admin_api/purge_history_api.html | 17 ++- v1.82/admin_api/register_api.html | 17 ++- v1.82/admin_api/room_membership.html | 17 ++- v1.82/admin_api/rooms.html | 17 ++- v1.82/admin_api/server_notices.html | 17 ++- v1.82/admin_api/statistics.html | 17 ++- v1.82/admin_api/user_admin_api.html | 17 ++- v1.82/admin_api/version_api.html | 17 ++- v1.82/application_services.html | 17 ++- v1.82/auth_chain_difference_algorithm.html | 17 ++- v1.82/code_style.html | 17 ++- v1.82/consent_tracking.html | 17 ++- v1.82/delegate.html | 17 ++- v1.82/deprecation_policy.html | 17 ++- v1.82/development/cas.html | 17 ++- v1.82/development/contributing_guide.html | 17 ++- v1.82/development/database_schema.html | 17 ++- v1.82/development/demo.html | 17 ++- v1.82/development/dependencies.html | 17 ++- v1.82/development/experimental_features.html | 17 ++- v1.82/development/git.html | 17 ++- .../internal_documentation/index.html | 17 ++- v1.82/development/releases.html | 17 ++- v1.82/development/reviews.html | 17 ++- v1.82/development/room-dag-concepts.html | 17 ++- v1.82/development/saml.html | 17 ++- .../synapse_architecture/cancellation.html | 17 ++- .../synapse_architecture/faster_joins.html | 17 ++- v1.82/docs/website_files/version-picker.css | 78 +++++++++++ v1.82/docs/website_files/version-picker.js | 127 ++++++++++++++++++ v1.82/docs/website_files/version.js | 1 + v1.82/federate.html | 17 ++- v1.82/index.html | 17 ++- v1.82/jwt.html | 17 ++- v1.82/log_contexts.html | 17 ++- v1.82/manhole.html | 17 ++- v1.82/media_repository.html | 17 ++- v1.82/message_retention_policies.html | 17 ++- v1.82/metrics-howto.html | 17 ++- v1.82/modules/account_data_callbacks.html | 17 ++- v1.82/modules/account_validity_callbacks.html | 17 ++- ...ackground_update_controller_callbacks.html | 17 ++- v1.82/modules/index.html | 17 ++- .../password_auth_provider_callbacks.html | 17 ++- v1.82/modules/porting_legacy_module.html | 17 ++- v1.82/modules/presence_router_callbacks.html | 17 ++- v1.82/modules/spam_checker_callbacks.html | 17 ++- .../modules/third_party_rules_callbacks.html | 17 ++- v1.82/modules/writing_a_module.html | 17 ++- v1.82/openid.html | 17 ++- v1.82/opentracing.html | 17 ++- ...ing_synapse_on_single_board_computers.html | 17 ++- v1.82/password_auth_providers.html | 17 ++- v1.82/postgres.html | 17 ++- v1.82/print.html | 17 ++- v1.82/replication.html | 17 ++- v1.82/reverse_proxy.html | 17 ++- v1.82/room_and_user_statistics.html | 17 ++- v1.82/server_notices.html | 17 ++- v1.82/setup/forward_proxy.html | 17 ++- v1.82/setup/installation.html | 17 ++- v1.82/setup/turn/coturn.html | 17 ++- v1.82/setup/turn/eturnal.html | 17 ++- v1.82/sso_mapping_providers.html | 17 ++- v1.82/structured_logging.html | 17 ++- v1.82/synctl_workers.html | 17 ++- v1.82/systemd-with-workers/index.html | 17 ++- v1.82/tcp_replication.html | 17 ++- v1.82/templates.html | 17 ++- v1.82/turn-howto.html | 17 ++- v1.82/upgrade.html | 17 ++- .../admin_api/background_updates.html | 17 ++- .../administration/admin_api/federation.html | 17 ++- .../usage/administration/admin_api/index.html | 17 ++- .../admin_api/registration_tokens.html | 17 ++- v1.82/usage/administration/admin_faq.html | 17 ++- .../database_maintenance_tools.html | 17 ++- v1.82/usage/administration/index.html | 17 ++- ...reporting_homeserver_usage_statistics.html | 17 ++- .../administration/monthly_active_users.html | 17 ++- v1.82/usage/administration/request_log.html | 17 ++- v1.82/usage/administration/state_groups.html | 17 ++- ...anding_synapse_through_grafana_graphs.html | 17 ++- .../administration/useful_sql_for_admins.html | 17 ++- .../configuration/config_documentation.html | 17 ++- .../homeserver_sample_config.html | 17 ++- v1.82/usage/configuration/index.html | 17 ++- .../configuration/logging_sample_config.html | 17 ++- .../user_authentication/index.html | 17 ++- .../user_authentication/refresh_tokens.html | 17 ++- .../single_sign_on/cas.html | 17 ++- .../single_sign_on/index.html | 17 ++- .../single_sign_on/saml.html | 17 ++- v1.82/user_directory.html | 17 ++- v1.82/website_files/theme/index.hbs | 14 +- v1.82/website_files/version-picker.css | 78 +++++++++++ v1.82/website_files/version-picker.js | 127 ++++++++++++++++++ v1.82/website_files/version.js | 1 + v1.82/welcome_and_overview.html | 17 ++- v1.82/workers.html | 17 ++- 107 files changed, 1993 insertions(+), 112 deletions(-) delete mode 100644 v1.82/.nojekyll delete mode 100644 v1.82/.sample_config_header.yaml create mode 100644 v1.82/docs/website_files/version-picker.css create mode 100644 v1.82/docs/website_files/version-picker.js create mode 100644 v1.82/docs/website_files/version.js create mode 100644 v1.82/website_files/version-picker.css create mode 100644 v1.82/website_files/version-picker.js create mode 100644 v1.82/website_files/version.js diff --git a/v1.82/.nojekyll b/v1.82/.nojekyll deleted file mode 100644 index f17311098f..0000000000 --- a/v1.82/.nojekyll +++ /dev/null @@ -1 +0,0 @@ -This file makes sure that Github Pages doesn't process mdBook's output. diff --git a/v1.82/.sample_config_header.yaml b/v1.82/.sample_config_header.yaml deleted file mode 100644 index 2355337e6d..0000000000 --- a/v1.82/.sample_config_header.yaml +++ /dev/null @@ -1,12 +0,0 @@ -# This file is maintained as an up-to-date snapshot of the default -# homeserver.yaml configuration generated by Synapse. You can find a -# complete accounting of possible configuration options at -# https://matrix-org.github.io/synapse/latest/usage/configuration/config_documentation.html -# -# It is *not* intended to be copied and used as the basis for a real -# homeserver.yaml. Instead, if you are starting from scratch, please generate -# a fresh config using Synapse by following the instructions in -# https://matrix-org.github.io/synapse/latest/setup/installation.html. -# -################################################################################ - diff --git a/v1.82/404.html b/v1.82/404.html index e300ccf7e3..078e54538c 100644 --- a/v1.82/404.html +++ b/v1.82/404.html @@ -29,6 +29,7 @@ + @@ -104,6 +105,18 @@ +
+
+
+ + +
+ +
    + +
+
+

Synapse

@@ -173,5 +186,7 @@ + + - \ No newline at end of file + diff --git a/v1.82/CAPTCHA_SETUP.html b/v1.82/CAPTCHA_SETUP.html index a047d318e3..6ab9350065 100644 --- a/v1.82/CAPTCHA_SETUP.html +++ b/v1.82/CAPTCHA_SETUP.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
+
+
+ + +
+ +
    + +
+
+

Synapse

@@ -220,5 +233,7 @@ listeners section of the homeserver.yaml configuration file.

+ + - \ No newline at end of file + diff --git a/v1.82/admin_api/account_validity.html b/v1.82/admin_api/account_validity.html index 660867c5f2..9fe2d4d7ab 100644 --- a/v1.82/admin_api/account_validity.html +++ b/v1.82/admin_api/account_validity.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
+
+
+ + +
+ +
    + +
+
+

Synapse

@@ -214,5 +227,7 @@ milliseconds since epoch:

+ + - \ No newline at end of file + diff --git a/v1.82/admin_api/event_reports.html b/v1.82/admin_api/event_reports.html index 8357ecd2c8..5f75e1fc3a 100644 --- a/v1.82/admin_api/event_reports.html +++ b/v1.82/admin_api/event_reports.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
+
+
+ + +
+ +
    + +
+
+

Synapse

@@ -348,5 +361,7 @@ will be an empty JSON object.

+ + - \ No newline at end of file + diff --git a/v1.82/admin_api/media_admin_api.html b/v1.82/admin_api/media_admin_api.html index baa64e9f25..c2b3b71db8 100644 --- a/v1.82/admin_api/media_admin_api.html +++ b/v1.82/admin_api/media_admin_api.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
+
+
+ + +
+ +
    + +
+
+

Synapse

@@ -403,5 +416,7 @@ from the originating server.

+ + - \ No newline at end of file + diff --git a/v1.82/admin_api/purge_history_api.html b/v1.82/admin_api/purge_history_api.html index e36a9dde07..edd67756b8 100644 --- a/v1.82/admin_api/purge_history_api.html +++ b/v1.82/admin_api/purge_history_api.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
+
+
+ + +
+ +
    + +
+
+

Synapse

@@ -234,5 +247,7 @@ a purge id:

+ + - \ No newline at end of file + diff --git a/v1.82/admin_api/register_api.html b/v1.82/admin_api/register_api.html index 1661119c67..9923b2fc7a 100644 --- a/v1.82/admin_api/register_api.html +++ b/v1.82/admin_api/register_api.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
+
+
+ + +
+ +
    + +
+
+

Synapse

@@ -259,5 +272,7 @@ def generate_mac(nonce, user, password, admin=False, user_type=None): + + - \ No newline at end of file + diff --git a/v1.82/admin_api/room_membership.html b/v1.82/admin_api/room_membership.html index 0dda9d468a..42036daf3d 100644 --- a/v1.82/admin_api/room_membership.html +++ b/v1.82/admin_api/room_membership.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
+
+
+ + +
+ +
    + +
+
+

Synapse

@@ -211,5 +224,7 @@ for a server admin: see Admin API + + - \ No newline at end of file + diff --git a/v1.82/admin_api/rooms.html b/v1.82/admin_api/rooms.html index 395727f64d..4782d9184e 100644 --- a/v1.82/admin_api/rooms.html +++ b/v1.82/admin_api/rooms.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
+
+
+ + +
+ +
    + +
+
+

Synapse

@@ -1138,5 +1151,7 @@ that were deleted.

+ + - \ No newline at end of file + diff --git a/v1.82/admin_api/server_notices.html b/v1.82/admin_api/server_notices.html index 0809859a6d..f01122efa0 100644 --- a/v1.82/admin_api/server_notices.html +++ b/v1.82/admin_api/server_notices.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
+
+
+ + +
+ +
    + +
+
+

Synapse

@@ -216,5 +229,7 @@ can be used. See the server notices documentati + + - \ No newline at end of file + diff --git a/v1.82/admin_api/statistics.html b/v1.82/admin_api/statistics.html index e6dd559ff3..a971c5340d 100644 --- a/v1.82/admin_api/statistics.html +++ b/v1.82/admin_api/statistics.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
+
+
+ + +
+ +
    + +
+
+

Synapse

@@ -261,5 +274,7 @@ about the user and their local media. Objects contain the following fields: + + - \ No newline at end of file + diff --git a/v1.82/admin_api/user_admin_api.html b/v1.82/admin_api/user_admin_api.html index 03dddef241..922a97a9eb 100644 --- a/v1.82/admin_api/user_admin_api.html +++ b/v1.82/admin_api/user_admin_api.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
+
+
+ + +
+ +
    + +
+
+

Synapse

@@ -1229,5 +1242,7 @@ for more information.

+ + - \ No newline at end of file + diff --git a/v1.82/admin_api/version_api.html b/v1.82/admin_api/version_api.html index c1cd34a48d..7c330b8802 100644 --- a/v1.82/admin_api/version_api.html +++ b/v1.82/admin_api/version_api.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
+
+
+ + +
+ +
    + +
+
+

Synapse

@@ -199,5 +212,7 @@ contains Synapse version information).

+ + - \ No newline at end of file + diff --git a/v1.82/application_services.html b/v1.82/application_services.html index 0675d1f1e7..d3d3a48ce9 100644 --- a/v1.82/application_services.html +++ b/v1.82/application_services.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
+
+
+ + +
+ +
    + +
+
+

Synapse

@@ -212,5 +225,7 @@ namespaces: + + - \ No newline at end of file + diff --git a/v1.82/auth_chain_difference_algorithm.html b/v1.82/auth_chain_difference_algorithm.html index d921ee4ebc..d864429d6c 100644 --- a/v1.82/auth_chain_difference_algorithm.html +++ b/v1.82/auth_chain_difference_algorithm.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
+
+
+ + +
+ +
    + +
+
+

Synapse

@@ -306,5 +319,7 @@ level). + + - \ No newline at end of file + diff --git a/v1.82/code_style.html b/v1.82/code_style.html index 937be65168..5c59f85ce1 100644 --- a/v1.82/code_style.html +++ b/v1.82/code_style.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
+
+
+ + +
+ +
    + +
+
+

Synapse

@@ -304,5 +317,7 @@ is left as an exercise for the reader!

+ + - \ No newline at end of file + diff --git a/v1.82/consent_tracking.html b/v1.82/consent_tracking.html index b2c9f8b45f..e9965df2cc 100644 --- a/v1.82/consent_tracking.html +++ b/v1.82/consent_tracking.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
+
+
+ + +
+ +
    + +
+
+

Synapse

@@ -346,5 +359,7 @@ URI that clients use to connect to the server. (It is used to construct + + - \ No newline at end of file + diff --git a/v1.82/delegate.html b/v1.82/delegate.html index 02ba4f587b..67118c1184 100644 --- a/v1.82/delegate.html +++ b/v1.82/delegate.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
+
+
+ + +
+ +
    + +
+
+

Synapse

@@ -265,5 +278,7 @@ reverse proxy.

+ + - \ No newline at end of file + diff --git a/v1.82/deprecation_policy.html b/v1.82/deprecation_policy.html index 79119eae07..de44382d3e 100644 --- a/v1.82/deprecation_policy.html +++ b/v1.82/deprecation_policy.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
+
+
+ + +
+ +
    + +
+
+

Synapse

@@ -223,5 +236,7 @@ and is consistent with the .deb packages released by Matrix.org.

+ + - \ No newline at end of file + diff --git a/v1.82/development/cas.html b/v1.82/development/cas.html index 5d74ccf710..0cfd1a3dff 100644 --- a/v1.82/development/cas.html +++ b/v1.82/development/cas.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
+
+
+ + +
+ +
    + +
+
+

Synapse

@@ -247,5 +260,7 @@ and that the CAS server is on port 8000, both on localhost.

+ + - \ No newline at end of file + diff --git a/v1.82/development/contributing_guide.html b/v1.82/development/contributing_guide.html index 038bb27c49..ea10dfcffc 100644 --- a/v1.82/development/contributing_guide.html +++ b/v1.82/development/contributing_guide.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
+
+
+ + +
+ +
    + +
+
+

Synapse

@@ -619,5 +632,7 @@ do!

+ + - \ No newline at end of file + diff --git a/v1.82/development/database_schema.html b/v1.82/development/database_schema.html index 22ffe3bf76..3cda5391ed 100644 --- a/v1.82/development/database_schema.html +++ b/v1.82/development/database_schema.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
+
+
+ + +
+ +
    + +
+
+

Synapse

@@ -363,5 +376,7 @@ will never happen (SHA256 has a massive big key space).

+ + - \ No newline at end of file + diff --git a/v1.82/development/demo.html b/v1.82/development/demo.html index fa8ed6e29e..a5c145e7b2 100644 --- a/v1.82/development/demo.html +++ b/v1.82/development/demo.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
+
+
+ + +
+ +
    + +
+
+

Synapse

@@ -220,5 +233,7 @@ name.

+ + - \ No newline at end of file + diff --git a/v1.82/development/dependencies.html b/v1.82/development/dependencies.html index 0064454883..d31523d328 100644 --- a/v1.82/development/dependencies.html +++ b/v1.82/development/dependencies.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
+
+
+ + +
+ +
    + +
+
+

Synapse

@@ -401,5 +414,7 @@ letting Poetry do the right thing.

+ + - \ No newline at end of file + diff --git a/v1.82/development/experimental_features.html b/v1.82/development/experimental_features.html index b9527375f6..0daea52711 100644 --- a/v1.82/development/experimental_features.html +++ b/v1.82/development/experimental_features.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
+
+
+ + +
+ +
    + +
+
+

Synapse

@@ -218,5 +231,7 @@ configuration key (see the synapse.config.experimental file) and ei + + - \ No newline at end of file + diff --git a/v1.82/development/git.html b/v1.82/development/git.html index 6337ef8586..7490e497e7 100644 --- a/v1.82/development/git.html +++ b/v1.82/development/git.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
+
+
+ + +
+ +
    + +
+
+

Synapse

@@ -306,5 +319,7 @@ the history of Synapse), we've had two releases in flight at once. Obviously, + + - \ No newline at end of file + diff --git a/v1.82/development/internal_documentation/index.html b/v1.82/development/internal_documentation/index.html index 2132e89463..03e4a91db4 100644 --- a/v1.82/development/internal_documentation/index.html +++ b/v1.82/development/internal_documentation/index.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
+
+
+ + +
+ +
    + +
+
+

Synapse

@@ -194,5 +207,7 @@ under the Usage section of the documentation.

+ + - \ No newline at end of file + diff --git a/v1.82/development/releases.html b/v1.82/development/releases.html index e0f70ca08e..66e4f97521 100644 --- a/v1.82/development/releases.html +++ b/v1.82/development/releases.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
+
+
+ + +
+ +
    + +
+
+

Synapse

@@ -215,5 +228,7 @@ found in the security catego + + - \ No newline at end of file + diff --git a/v1.82/development/reviews.html b/v1.82/development/reviews.html index d37917af74..a982288c11 100644 --- a/v1.82/development/reviews.html +++ b/v1.82/development/reviews.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
+
+
+ + +
+ +
    + +
+
+

Synapse

@@ -218,5 +231,7 @@ with the rationale on why you're putting it back in the queue.

+ + - \ No newline at end of file + diff --git a/v1.82/development/room-dag-concepts.html b/v1.82/development/room-dag-concepts.html index 1f8fa07674..d75401dc91 100644 --- a/v1.82/development/room-dag-concepts.html +++ b/v1.82/development/room-dag-concepts.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
+
+
+ + +
+ +
    + +
+
+

Synapse

@@ -274,5 +287,7 @@ notes from @Azrenbeth, https://pastebin.com/seUGVGeT

+ + - \ No newline at end of file + diff --git a/v1.82/development/saml.html b/v1.82/development/saml.html index ce3b6551ec..c9da2a84a9 100644 --- a/v1.82/development/saml.html +++ b/v1.82/development/saml.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
+
+
+ + +
+ +
    + +
+
+

Synapse

@@ -223,5 +236,7 @@ samling page and clear the site data. In Chrome, this will be a button on the Ap + + - \ No newline at end of file + diff --git a/v1.82/development/synapse_architecture/cancellation.html b/v1.82/development/synapse_architecture/cancellation.html index 953cb23905..0daa1a5c9f 100644 --- a/v1.82/development/synapse_architecture/cancellation.html +++ b/v1.82/development/synapse_architecture/cancellation.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
+
+
+ + +
+ +
    + +
+
+

Synapse

@@ -532,5 +545,7 @@ with LoggingContext("request-1"): + + - \ No newline at end of file + diff --git a/v1.82/development/synapse_architecture/faster_joins.html b/v1.82/development/synapse_architecture/faster_joins.html index 76b88fcd98..b20eed0082 100644 --- a/v1.82/development/synapse_architecture/faster_joins.html +++ b/v1.82/development/synapse_architecture/faster_joins.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
+
+
+ + +
+ +
    + +
+
+

Synapse

@@ -526,5 +539,7 @@ work?

+ + - \ No newline at end of file + diff --git a/v1.82/docs/website_files/version-picker.css b/v1.82/docs/website_files/version-picker.css new file mode 100644 index 0000000000..28e5d5219a --- /dev/null +++ b/v1.82/docs/website_files/version-picker.css @@ -0,0 +1,78 @@ +.version-picker { + display: flex; + align-items: center; +} + +.version-picker .dropdown { + width: 130px; + max-height: 29px; + margin-left: 10px; + display: inline-block; + border-radius: 4px; + border: 1px solid var(--theme-popup-border); + position: relative; + font-size: 13px; + color: var(--fg); + height: 100%; + text-align: left; +} +.version-picker .dropdown .select { + cursor: pointer; + display: block; + padding: 5px 2px 5px 15px; +} +.version-picker .dropdown .select > i { + font-size: 10px; + color: var(--fg); + cursor: pointer; + float: right; + line-height: 20px !important; +} +.version-picker .dropdown:hover { + border: 1px solid var(--theme-popup-border); +} +.version-picker .dropdown:active { + background-color: var(--theme-popup-bg); +} +.version-picker .dropdown.active:hover, +.version-picker .dropdown.active { + border: 1px solid var(--theme-popup-border); + border-radius: 2px 2px 0 0; + background-color: var(--theme-popup-bg); +} +.version-picker .dropdown.active .select > i { + transform: rotate(-180deg); +} +.version-picker .dropdown .dropdown-menu { + position: absolute; + background-color: var(--theme-popup-bg); + width: 100%; + left: -1px; + right: 1px; + margin-top: 1px; + border: 1px solid var(--theme-popup-border); + border-radius: 0 0 4px 4px; + overflow: hidden; + display: none; + max-height: 300px; + overflow-y: auto; + z-index: 9; +} +.version-picker .dropdown .dropdown-menu li { + font-size: 12px; + padding: 6px 20px; + cursor: pointer; +} +.version-picker .dropdown .dropdown-menu { + padding: 0; + list-style: none; +} +.version-picker .dropdown .dropdown-menu li:hover { + background-color: var(--theme-hover); +} +.version-picker .dropdown .dropdown-menu li.active::before { + display: inline-block; + content: "✓"; + margin-inline-start: -14px; + width: 14px; +} \ No newline at end of file diff --git a/v1.82/docs/website_files/version-picker.js b/v1.82/docs/website_files/version-picker.js new file mode 100644 index 0000000000..bb35a7d896 --- /dev/null +++ b/v1.82/docs/website_files/version-picker.js @@ -0,0 +1,127 @@ + +const dropdown = document.querySelector('.version-picker .dropdown'); +const dropdownMenu = dropdown.querySelector('.dropdown-menu'); + +fetchVersions(dropdown, dropdownMenu).then(() => { + initializeVersionDropdown(dropdown, dropdownMenu); +}); + +/** + * Initialize the dropdown functionality for version selection. + * + * @param {Element} dropdown - The dropdown element. + * @param {Element} dropdownMenu - The dropdown menu element. + */ +function initializeVersionDropdown(dropdown, dropdownMenu) { + // Toggle the dropdown menu on click + dropdown.addEventListener('click', function () { + this.setAttribute('tabindex', 1); + this.classList.toggle('active'); + dropdownMenu.style.display = (dropdownMenu.style.display === 'block') ? 'none' : 'block'; + }); + + // Remove the 'active' class and hide the dropdown menu on focusout + dropdown.addEventListener('focusout', function () { + this.classList.remove('active'); + dropdownMenu.style.display = 'none'; + }); + + // Handle item selection within the dropdown menu + const dropdownMenuItems = dropdownMenu.querySelectorAll('li'); + dropdownMenuItems.forEach(function (item) { + item.addEventListener('click', function () { + dropdownMenuItems.forEach(function (item) { + item.classList.remove('active'); + }); + this.classList.add('active'); + dropdown.querySelector('span').textContent = this.textContent; + dropdown.querySelector('input').value = this.getAttribute('id'); + + window.location.href = changeVersion(window.location.href, this.textContent); + }); + }); +}; + +/** + * This function fetches the available versions from a GitHub repository + * and inserts them into the version picker. + * + * @param {Element} dropdown - The dropdown element. + * @param {Element} dropdownMenu - The dropdown menu element. + * @returns {Promise>} A promise that resolves with an array of available versions. + */ +function fetchVersions(dropdown, dropdownMenu) { + return new Promise((resolve, reject) => { + window.addEventListener("load", () => { + + fetch("https://api.github.com/repos/matrix-org/synapse/git/trees/gh-pages", { + cache: "force-cache", + }).then(res => + res.json() + ).then(resObject => { + const excluded = ['dev-docs', 'v1.91.0', 'v1.80.0', 'v1.69.0']; + const tree = resObject.tree.filter(item => item.type === "tree" && !excluded.includes(item.path)); + const versions = tree.map(item => item.path).sort(sortVersions); + + // Create a list of
  • items for versions + versions.forEach((version) => { + const li = document.createElement("li"); + li.textContent = version; + li.id = version; + + if (window.SYNAPSE_VERSION === version) { + li.classList.add('active'); + dropdown.querySelector('span').textContent = version; + dropdown.querySelector('input').value = version; + } + + dropdownMenu.appendChild(li); + }); + + resolve(versions); + + }).catch(ex => { + console.error("Failed to fetch version data", ex); + reject(ex); + }) + }); + }); +} + +/** + * Custom sorting function to sort an array of version strings. + * + * @param {string} a - The first version string to compare. + * @param {string} b - The second version string to compare. + * @returns {number} - A negative number if a should come before b, a positive number if b should come before a, or 0 if they are equal. + */ +function sortVersions(a, b) { + // Put 'develop' and 'latest' at the top + if (a === 'develop' || a === 'latest') return -1; + if (b === 'develop' || b === 'latest') return 1; + + const versionA = (a.match(/v\d+(\.\d+)+/) || [])[0]; + const versionB = (b.match(/v\d+(\.\d+)+/) || [])[0]; + + return versionB.localeCompare(versionA); +} + +/** + * Change the version in a URL path. + * + * @param {string} url - The original URL to be modified. + * @param {string} newVersion - The new version to replace the existing version in the URL. + * @returns {string} The updated URL with the new version. + */ +function changeVersion(url, newVersion) { + const parsedURL = new URL(url); + const pathSegments = parsedURL.pathname.split('/'); + + // Modify the version + pathSegments[2] = newVersion; + + // Reconstruct the URL + parsedURL.pathname = pathSegments.join('/'); + + return parsedURL.href; +} \ No newline at end of file diff --git a/v1.82/docs/website_files/version.js b/v1.82/docs/website_files/version.js new file mode 100644 index 0000000000..a3118fe15a --- /dev/null +++ b/v1.82/docs/website_files/version.js @@ -0,0 +1 @@ +window.SYNAPSE_VERSION = 'v1.82'; diff --git a/v1.82/federate.html b/v1.82/federate.html index f52beb11b4..ed86d5fb43 100644 --- a/v1.82/federate.html +++ b/v1.82/federate.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

    @@ -238,5 +251,7 @@ useful just for development purposes. See + + - \ No newline at end of file + diff --git a/v1.82/index.html b/v1.82/index.html index d853008a2f..dca5bc0e4c 100644 --- a/v1.82/index.html +++ b/v1.82/index.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

    @@ -264,5 +277,7 @@ Policy    . Thank you!

    + + - \ No newline at end of file + diff --git a/v1.82/jwt.html b/v1.82/jwt.html index 600637f896..61154b18fc 100644 --- a/v1.82/jwt.html +++ b/v1.82/jwt.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

    @@ -281,5 +294,7 @@ print(result.decode("ascii")) + + - \ No newline at end of file + diff --git a/v1.82/log_contexts.html b/v1.82/log_contexts.html index 31e001e8af..76c0834026 100644 --- a/v1.82/log_contexts.html +++ b/v1.82/log_contexts.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

    @@ -481,5 +494,7 @@ lead to leaked logcontexts which are incredibly hard to track down.

    + + - \ No newline at end of file + diff --git a/v1.82/manhole.html b/v1.82/manhole.html index 2996c94239..a23b434265 100644 --- a/v1.82/manhole.html +++ b/v1.82/manhole.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

    @@ -254,5 +267,7 @@ parts of the process.

    + + - \ No newline at end of file + diff --git a/v1.82/media_repository.html b/v1.82/media_repository.html index 71b85fbab5..2a5be243a0 100644 --- a/v1.82/media_repository.html +++ b/v1.82/media_repository.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

    @@ -245,5 +258,7 @@ url_cache_thumbnails/yyyy-mm-dd/aaaaaaaaaaaaaaaa/128-96-image-jpeg-scale + + - \ No newline at end of file + diff --git a/v1.82/message_retention_policies.html b/v1.82/message_retention_policies.html index 7f4f1f71f4..0cf9229845 100644 --- a/v1.82/message_retention_policies.html +++ b/v1.82/message_retention_policies.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

    @@ -342,5 +355,7 @@ operating system, the server admin needs to run VACUUM FULL; (or + + - \ No newline at end of file + diff --git a/v1.82/metrics-howto.html b/v1.82/metrics-howto.html index 8243108763..196e5d110b 100644 --- a/v1.82/metrics-howto.html +++ b/v1.82/metrics-howto.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

    @@ -458,5 +471,7 @@ renamed.

    + + - \ No newline at end of file + diff --git a/v1.82/modules/account_data_callbacks.html b/v1.82/modules/account_data_callbacks.html index 6b353ddff3..3ff60ca7b3 100644 --- a/v1.82/modules/account_data_callbacks.html +++ b/v1.82/modules/account_data_callbacks.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

    @@ -276,5 +289,7 @@ class CustomAccountDataModule: + + - \ No newline at end of file + diff --git a/v1.82/modules/account_validity_callbacks.html b/v1.82/modules/account_validity_callbacks.html index f141765c70..677936bdb0 100644 --- a/v1.82/modules/account_validity_callbacks.html +++ b/v1.82/modules/account_validity_callbacks.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

    @@ -214,5 +227,7 @@ represented by their Matrix user ID.

    + + - \ No newline at end of file + diff --git a/v1.82/modules/background_update_controller_callbacks.html b/v1.82/modules/background_update_controller_callbacks.html index 6fc7970302..4ecfb7c6d6 100644 --- a/v1.82/modules/background_update_controller_callbacks.html +++ b/v1.82/modules/background_update_controller_callbacks.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

    @@ -232,5 +245,7 @@ ensure that progress is always made.

    + + - \ No newline at end of file + diff --git a/v1.82/modules/index.html b/v1.82/modules/index.html index 74fb801e04..52bf0b45e1 100644 --- a/v1.82/modules/index.html +++ b/v1.82/modules/index.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

    @@ -227,5 +240,7 @@ another part of Synapse's configuration file.

    + + - \ No newline at end of file + diff --git a/v1.82/modules/password_auth_provider_callbacks.html b/v1.82/modules/password_auth_provider_callbacks.html index b921b486bc..528c2cd5ec 100644 --- a/v1.82/modules/password_auth_provider_callbacks.html +++ b/v1.82/modules/password_auth_provider_callbacks.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

    @@ -422,5 +435,7 @@ class MyAuthProvider: + + - \ No newline at end of file + diff --git a/v1.82/modules/porting_legacy_module.html b/v1.82/modules/porting_legacy_module.html index df9463345f..4a4b34f903 100644 --- a/v1.82/modules/porting_legacy_module.html +++ b/v1.82/modules/porting_legacy_module.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

    @@ -202,5 +215,7 @@ for more info).

    + + - \ No newline at end of file + diff --git a/v1.82/modules/presence_router_callbacks.html b/v1.82/modules/presence_router_callbacks.html index 51516af08c..bd1729e89a 100644 --- a/v1.82/modules/presence_router_callbacks.html +++ b/v1.82/modules/presence_router_callbacks.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

    @@ -267,5 +280,7 @@ class CustomPresenceRouter: + + - \ No newline at end of file + diff --git a/v1.82/modules/spam_checker_callbacks.html b/v1.82/modules/spam_checker_callbacks.html index 9c44bf6ca7..359138f77e 100644 --- a/v1.82/modules/spam_checker_callbacks.html +++ b/v1.82/modules/spam_checker_callbacks.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

    @@ -537,5 +550,7 @@ class ListSpamChecker: + + - \ No newline at end of file + diff --git a/v1.82/modules/third_party_rules_callbacks.html b/v1.82/modules/third_party_rules_callbacks.html index 43f97fa055..b44af5b83d 100644 --- a/v1.82/modules/third_party_rules_callbacks.html +++ b/v1.82/modules/third_party_rules_callbacks.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

    @@ -433,5 +446,7 @@ class EventCensorer: + + - \ No newline at end of file + diff --git a/v1.82/modules/writing_a_module.html b/v1.82/modules/writing_a_module.html index bc8627c62e..f69a5dcd6e 100644 --- a/v1.82/modules/writing_a_module.html +++ b/v1.82/modules/writing_a_module.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

    @@ -294,5 +307,7 @@ class MyModule: + + - \ No newline at end of file + diff --git a/v1.82/openid.html b/v1.82/openid.html index 39f6d0a33c..1a35ffd18a 100644 --- a/v1.82/openid.html +++ b/v1.82/openid.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

    @@ -813,5 +826,7 @@ are randomly generated data.
    • + + - \ No newline at end of file + diff --git a/v1.82/opentracing.html b/v1.82/opentracing.html index db3b1b8ebe..33a2a5ac74 100644 --- a/v1.82/opentracing.html +++ b/v1.82/opentracing.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

    @@ -259,5 +272,7 @@ logged to OpenTracing's logs. + + - \ No newline at end of file + diff --git a/v1.82/other/running_synapse_on_single_board_computers.html b/v1.82/other/running_synapse_on_single_board_computers.html index 9c2111fd1a..916c519748 100644 --- a/v1.82/other/running_synapse_on_single_board_computers.html +++ b/v1.82/other/running_synapse_on_single_board_computers.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

    @@ -235,5 +248,7 @@ admin@homeserver:~$ sudo --user postgres psql matrix-synapse --command 'select c + + - \ No newline at end of file + diff --git a/v1.82/password_auth_providers.html b/v1.82/password_auth_providers.html index d8b9eecd31..c01ce41caf 100644 --- a/v1.82/password_auth_providers.html +++ b/v1.82/password_auth_providers.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

    @@ -299,5 +312,7 @@ wait for the Awaitable to complete, but the result is ignored.

    + + - \ No newline at end of file + diff --git a/v1.82/postgres.html b/v1.82/postgres.html index af71da4100..1003e13120 100644 --- a/v1.82/postgres.html +++ b/v1.82/postgres.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

    @@ -394,5 +407,7 @@ successfully.

    + + - \ No newline at end of file + diff --git a/v1.82/print.html b/v1.82/print.html index ceb5af3661..87f9d4423f 100644 --- a/v1.82/print.html +++ b/v1.82/print.html @@ -29,6 +29,7 @@ + @@ -104,6 +105,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

    @@ -18496,10 +18509,12 @@ admin@homeserver:~$ sudo --user postgres psql matrix-synapse --command 'select c + + - \ No newline at end of file + diff --git a/v1.82/replication.html b/v1.82/replication.html index c6686ca6fa..9c7596224b 100644 --- a/v1.82/replication.html +++ b/v1.82/replication.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

    @@ -217,5 +230,7 @@ the classes interact, can be found in + + - \ No newline at end of file + diff --git a/v1.82/reverse_proxy.html b/v1.82/reverse_proxy.html index aaf3bccfd8..40733653f0 100644 --- a/v1.82/reverse_proxy.html +++ b/v1.82/reverse_proxy.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

    @@ -407,5 +420,7 @@ we do not recommend exposing them to the public internet without good reason.

    + + - \ No newline at end of file + diff --git a/v1.82/room_and_user_statistics.html b/v1.82/room_and_user_statistics.html index 09f7a2cb63..e136730053 100644 --- a/v1.82/room_and_user_statistics.html +++ b/v1.82/room_and_user_statistics.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

    @@ -200,5 +213,7 @@ statistics for a room. Each subject can only have one entry.

    + + - \ No newline at end of file + diff --git a/v1.82/server_notices.html b/v1.82/server_notices.html index 1296d5fa71..1a00a20736 100644 --- a/v1.82/server_notices.html +++ b/v1.82/server_notices.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

    @@ -229,5 +242,7 @@ displayname and avatar of the Server Notices user.

    + + - \ No newline at end of file + diff --git a/v1.82/setup/forward_proxy.html b/v1.82/setup/forward_proxy.html index 557b80d084..fc395aeb7c 100644 --- a/v1.82/setup/forward_proxy.html +++ b/v1.82/setup/forward_proxy.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

    @@ -260,5 +273,7 @@ your homserver.ya + + - \ No newline at end of file + diff --git a/v1.82/setup/installation.html b/v1.82/setup/installation.html index 85a3d847a8..4f518f9f83 100644 --- a/v1.82/setup/installation.html +++ b/v1.82/setup/installation.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

    @@ -610,5 +623,7 @@ failing, e.g.:

    + + - \ No newline at end of file + diff --git a/v1.82/setup/turn/coturn.html b/v1.82/setup/turn/coturn.html index bb85cf2670..12fb18da83 100644 --- a/v1.82/setup/turn/coturn.html +++ b/v1.82/setup/turn/coturn.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

    @@ -347,5 +360,7 @@ IPv6 address that is mapped by NAT to the external IPv6 address.

    + + - \ No newline at end of file + diff --git a/v1.82/setup/turn/eturnal.html b/v1.82/setup/turn/eturnal.html index 011889ea5d..607cc31b52 100644 --- a/v1.82/setup/turn/eturnal.html +++ b/v1.82/setup/turn/eturnal.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

    @@ -320,5 +333,7 @@ to query how many active sessions exist, to change logging behaviour and so on.< + + - \ No newline at end of file + diff --git a/v1.82/sso_mapping_providers.html b/v1.82/sso_mapping_providers.html index 355b389d5b..5fa1a54813 100644 --- a/v1.82/sso_mapping_providers.html +++ b/v1.82/sso_mapping_providers.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

    @@ -442,5 +455,7 @@ specified in the config. It is located at + + - \ No newline at end of file + diff --git a/v1.82/structured_logging.html b/v1.82/structured_logging.html index a87688c517..4ea8eac1f7 100644 --- a/v1.82/structured_logging.html +++ b/v1.82/structured_logging.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

    @@ -254,5 +267,7 @@ remote endpoint at 10.1.2.3:9999.

    + + - \ No newline at end of file + diff --git a/v1.82/synctl_workers.html b/v1.82/synctl_workers.html index 87b1b0bb57..8dcf649ea3 100644 --- a/v1.82/synctl_workers.html +++ b/v1.82/synctl_workers.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

    @@ -208,5 +221,7 @@ notifications.

    + + - \ No newline at end of file + diff --git a/v1.82/systemd-with-workers/index.html b/v1.82/systemd-with-workers/index.html index 4f3f95444a..957381ebaa 100644 --- a/v1.82/systemd-with-workers/index.html +++ b/v1.82/systemd-with-workers/index.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

    @@ -279,5 +292,7 @@ the changes being applied at a glance.

    + + - \ No newline at end of file + diff --git a/v1.82/tcp_replication.html b/v1.82/tcp_replication.html index 1b427ca48d..f9dc6a76de 100644 --- a/v1.82/tcp_replication.html +++ b/v1.82/tcp_replication.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

    @@ -381,5 +394,7 @@ state + + - \ No newline at end of file + diff --git a/v1.82/templates.html b/v1.82/templates.html index a099c98c60..d2ec859bef 100644 --- a/v1.82/templates.html +++ b/v1.82/templates.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

    @@ -467,5 +480,7 @@ When rendering, this template is given two variables: + + - \ No newline at end of file + diff --git a/v1.82/turn-howto.html b/v1.82/turn-howto.html index 7d3bd18491..a7e4fd86d2 100644 --- a/v1.82/turn-howto.html +++ b/v1.82/turn-howto.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

    @@ -342,5 +355,7 @@ entry in the results.

    + + - \ No newline at end of file + diff --git a/v1.82/upgrade.html b/v1.82/upgrade.html index fecb0986ff..cd23bbd4e2 100644 --- a/v1.82/upgrade.html +++ b/v1.82/upgrade.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

    @@ -1998,5 +2011,7 @@ in the local HS will automatically rejoin the room.

    + + - \ No newline at end of file + diff --git a/v1.82/usage/administration/admin_api/background_updates.html b/v1.82/usage/administration/admin_api/background_updates.html index 7eeed7db2b..e0e9ce5c6e 100644 --- a/v1.82/usage/administration/admin_api/background_updates.html +++ b/v1.82/usage/administration/admin_api/background_updates.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

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

    + + - \ No newline at end of file + diff --git a/v1.82/usage/administration/admin_api/federation.html b/v1.82/usage/administration/admin_api/federation.html index 2742f6fdeb..1f6e4aef67 100644 --- a/v1.82/usage/administration/admin_api/federation.html +++ b/v1.82/usage/administration/admin_api/federation.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

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

    + + - \ No newline at end of file + diff --git a/v1.82/usage/administration/admin_api/index.html b/v1.82/usage/administration/admin_api/index.html index 1ee941a723..1fc3d5fc23 100644 --- a/v1.82/usage/administration/admin_api/index.html +++ b/v1.82/usage/administration/admin_api/index.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

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

    + + - \ No newline at end of file + diff --git a/v1.82/usage/administration/admin_api/registration_tokens.html b/v1.82/usage/administration/admin_api/registration_tokens.html index b55896013d..4d502cd24d 100644 --- a/v1.82/usage/administration/admin_api/registration_tokens.html +++ b/v1.82/usage/administration/admin_api/registration_tokens.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

    @@ -423,5 +436,7 @@ the     Ma + + - \ No newline at end of file + diff --git a/v1.82/usage/administration/admin_faq.html b/v1.82/usage/administration/admin_faq.html index 7c4602fad7..99a91f6f92 100644 --- a/v1.82/usage/administration/admin_faq.html +++ b/v1.82/usage/administration/admin_faq.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

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

    + + - \ No newline at end of file + diff --git a/v1.82/usage/administration/database_maintenance_tools.html b/v1.82/usage/administration/database_maintenance_tools.html index cdeedc0183..1f2d14c48a 100644 --- a/v1.82/usage/administration/database_maintenance_tools.html +++ b/v1.82/usage/administration/database_maintenance_tools.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

    @@ -197,5 +210,7 @@ + + - \ No newline at end of file + diff --git a/v1.82/usage/administration/index.html b/v1.82/usage/administration/index.html index 5517ed230e..a8a4c3d41b 100644 --- a/v1.82/usage/administration/index.html +++ b/v1.82/usage/administration/index.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

    @@ -192,5 +205,7 @@ + + - \ No newline at end of file + diff --git a/v1.82/usage/administration/monitoring/reporting_homeserver_usage_statistics.html b/v1.82/usage/administration/monitoring/reporting_homeserver_usage_statistics.html index 83ae341b8b..d83b24c4f4 100644 --- a/v1.82/usage/administration/monitoring/reporting_homeserver_usage_statistics.html +++ b/v1.82/usage/administration/monitoring/reporting_homeserver_usage_statistics.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

    @@ -259,5 +272,7 @@ consider using one of the following known implementations:

    + + - \ No newline at end of file + diff --git a/v1.82/usage/administration/monthly_active_users.html b/v1.82/usage/administration/monthly_active_users.html index 9400609263..934de898f7 100644 --- a/v1.82/usage/administration/monthly_active_users.html +++ b/v1.82/usage/administration/monthly_active_users.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

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

    + + - \ No newline at end of file + diff --git a/v1.82/usage/administration/request_log.html b/v1.82/usage/administration/request_log.html index 2ba4afcae1..39c24d3bfd 100644 --- a/v1.82/usage/administration/request_log.html +++ b/v1.82/usage/administration/request_log.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

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

    + + - \ No newline at end of file + diff --git a/v1.82/usage/administration/state_groups.html b/v1.82/usage/administration/state_groups.html index c8b6c2a6fc..df5c56b818 100644 --- a/v1.82/usage/administration/state_groups.html +++ b/v1.82/usage/administration/state_groups.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

    @@ -198,5 +211,7 @@ + + - \ No newline at end of file + diff --git a/v1.82/usage/administration/understanding_synapse_through_grafana_graphs.html b/v1.82/usage/administration/understanding_synapse_through_grafana_graphs.html index 2af0d720da..5015d171ac 100644 --- a/v1.82/usage/administration/understanding_synapse_through_grafana_graphs.html +++ b/v1.82/usage/administration/understanding_synapse_through_grafana_graphs.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

    @@ -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/v1.82/usage/administration/useful_sql_for_admins.html b/v1.82/usage/administration/useful_sql_for_admins.html index 906918936b..ab2ab8646e 100644 --- a/v1.82/usage/administration/useful_sql_for_admins.html +++ b/v1.82/usage/administration/useful_sql_for_admins.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

    @@ -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/v1.82/usage/configuration/config_documentation.html b/v1.82/usage/configuration/config_documentation.html index 8a9624d123..9e303212f7 100644 --- a/v1.82/usage/configuration/config_documentation.html +++ b/v1.82/usage/configuration/config_documentation.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

    @@ -3712,5 +3725,7 @@ Set a size to change the default. + + - \ No newline at end of file + diff --git a/v1.82/usage/configuration/homeserver_sample_config.html b/v1.82/usage/configuration/homeserver_sample_config.html index ebcdf1a703..e7f988222a 100644 --- a/v1.82/usage/configuration/homeserver_sample_config.html +++ b/v1.82/usage/configuration/homeserver_sample_config.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

    @@ -239,5 +252,7 @@ trusted_key_servers: + + - \ No newline at end of file + diff --git a/v1.82/usage/configuration/index.html b/v1.82/usage/configuration/index.html index 1c495971ca..cc6dba8a98 100644 --- a/v1.82/usage/configuration/index.html +++ b/v1.82/usage/configuration/index.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

    @@ -188,5 +201,7 @@ file should have been generated when you     + + - \ No newline at end of file + diff --git a/v1.82/usage/configuration/logging_sample_config.html b/v1.82/usage/configuration/logging_sample_config.html index 1c284bb5e2..3c607392df 100644 --- a/v1.82/usage/configuration/logging_sample_config.html +++ b/v1.82/usage/configuration/logging_sample_config.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

    @@ -272,5 +285,7 @@ disable_existing_loggers: false + + - \ No newline at end of file + diff --git a/v1.82/usage/configuration/user_authentication/index.html b/v1.82/usage/configuration/user_authentication/index.html index 7547264240..ae85c1a0b4 100644 --- a/v1.82/usage/configuration/user_authentication/index.html +++ b/v1.82/usage/configuration/user_authentication/index.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

    @@ -198,5 +211,7 @@ modules.

    + + - \ No newline at end of file + diff --git a/v1.82/usage/configuration/user_authentication/refresh_tokens.html b/v1.82/usage/configuration/user_authentication/refresh_tokens.html index f5c613a14a..8513f70c8f 100644 --- a/v1.82/usage/configuration/user_authentication/refresh_tokens.html +++ b/v1.82/usage/configuration/user_authentication/refresh_tokens.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

    @@ -307,5 +320,7 @@ above requirements will still hold.

    + + - \ No newline at end of file + diff --git a/v1.82/usage/configuration/user_authentication/single_sign_on/cas.html b/v1.82/usage/configuration/user_authentication/single_sign_on/cas.html index 0a09ae308b..981d2f7c8f 100644 --- a/v1.82/usage/configuration/user_authentication/single_sign_on/cas.html +++ b/v1.82/usage/configuration/user_authentication/single_sign_on/cas.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

    @@ -191,5 +204,7 @@ sections of the configuration manual for more details.

    + + - \ No newline at end of file + diff --git a/v1.82/usage/configuration/user_authentication/single_sign_on/index.html b/v1.82/usage/configuration/user_authentication/single_sign_on/index.html index 5e392a9f00..edd679d3e2 100644 --- a/v1.82/usage/configuration/user_authentication/single_sign_on/index.html +++ b/v1.82/usage/configuration/user_authentication/single_sign_on/index.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

    @@ -189,5 +202,7 @@ auth provider modules.

    + + - \ No newline at end of file + diff --git a/v1.82/usage/configuration/user_authentication/single_sign_on/saml.html b/v1.82/usage/configuration/user_authentication/single_sign_on/saml.html index a37284424f..be3944e8fa 100644 --- a/v1.82/usage/configuration/user_authentication/single_sign_on/saml.html +++ b/v1.82/usage/configuration/user_authentication/single_sign_on/saml.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

    @@ -191,5 +204,7 @@ file     for more details.

    + + - \ No newline at end of file + diff --git a/v1.82/user_directory.html b/v1.82/user_directory.html index 952d247f8d..902ab06648 100644 --- a/v1.82/user_directory.html +++ b/v1.82/user_directory.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

    @@ -240,5 +253,7 @@ different, but this isn't enforced by a constraint.

    + + - \ No newline at end of file + diff --git a/v1.82/website_files/theme/index.hbs b/v1.82/website_files/theme/index.hbs index 3b7a5b6163..b169323a43 100644 --- a/v1.82/website_files/theme/index.hbs +++ b/v1.82/website_files/theme/index.hbs @@ -131,6 +131,18 @@ {{/if}} +
    +
    +
    + + +
    + +
      + +
    +
    +

    {{ book_title }}

    @@ -309,4 +321,4 @@ {{/if}} - \ No newline at end of file + diff --git a/v1.82/website_files/version-picker.css b/v1.82/website_files/version-picker.css new file mode 100644 index 0000000000..28e5d5219a --- /dev/null +++ b/v1.82/website_files/version-picker.css @@ -0,0 +1,78 @@ +.version-picker { + display: flex; + align-items: center; +} + +.version-picker .dropdown { + width: 130px; + max-height: 29px; + margin-left: 10px; + display: inline-block; + border-radius: 4px; + border: 1px solid var(--theme-popup-border); + position: relative; + font-size: 13px; + color: var(--fg); + height: 100%; + text-align: left; +} +.version-picker .dropdown .select { + cursor: pointer; + display: block; + padding: 5px 2px 5px 15px; +} +.version-picker .dropdown .select > i { + font-size: 10px; + color: var(--fg); + cursor: pointer; + float: right; + line-height: 20px !important; +} +.version-picker .dropdown:hover { + border: 1px solid var(--theme-popup-border); +} +.version-picker .dropdown:active { + background-color: var(--theme-popup-bg); +} +.version-picker .dropdown.active:hover, +.version-picker .dropdown.active { + border: 1px solid var(--theme-popup-border); + border-radius: 2px 2px 0 0; + background-color: var(--theme-popup-bg); +} +.version-picker .dropdown.active .select > i { + transform: rotate(-180deg); +} +.version-picker .dropdown .dropdown-menu { + position: absolute; + background-color: var(--theme-popup-bg); + width: 100%; + left: -1px; + right: 1px; + margin-top: 1px; + border: 1px solid var(--theme-popup-border); + border-radius: 0 0 4px 4px; + overflow: hidden; + display: none; + max-height: 300px; + overflow-y: auto; + z-index: 9; +} +.version-picker .dropdown .dropdown-menu li { + font-size: 12px; + padding: 6px 20px; + cursor: pointer; +} +.version-picker .dropdown .dropdown-menu { + padding: 0; + list-style: none; +} +.version-picker .dropdown .dropdown-menu li:hover { + background-color: var(--theme-hover); +} +.version-picker .dropdown .dropdown-menu li.active::before { + display: inline-block; + content: "✓"; + margin-inline-start: -14px; + width: 14px; +} \ No newline at end of file diff --git a/v1.82/website_files/version-picker.js b/v1.82/website_files/version-picker.js new file mode 100644 index 0000000000..bb35a7d896 --- /dev/null +++ b/v1.82/website_files/version-picker.js @@ -0,0 +1,127 @@ + +const dropdown = document.querySelector('.version-picker .dropdown'); +const dropdownMenu = dropdown.querySelector('.dropdown-menu'); + +fetchVersions(dropdown, dropdownMenu).then(() => { + initializeVersionDropdown(dropdown, dropdownMenu); +}); + +/** + * Initialize the dropdown functionality for version selection. + * + * @param {Element} dropdown - The dropdown element. + * @param {Element} dropdownMenu - The dropdown menu element. + */ +function initializeVersionDropdown(dropdown, dropdownMenu) { + // Toggle the dropdown menu on click + dropdown.addEventListener('click', function () { + this.setAttribute('tabindex', 1); + this.classList.toggle('active'); + dropdownMenu.style.display = (dropdownMenu.style.display === 'block') ? 'none' : 'block'; + }); + + // Remove the 'active' class and hide the dropdown menu on focusout + dropdown.addEventListener('focusout', function () { + this.classList.remove('active'); + dropdownMenu.style.display = 'none'; + }); + + // Handle item selection within the dropdown menu + const dropdownMenuItems = dropdownMenu.querySelectorAll('li'); + dropdownMenuItems.forEach(function (item) { + item.addEventListener('click', function () { + dropdownMenuItems.forEach(function (item) { + item.classList.remove('active'); + }); + this.classList.add('active'); + dropdown.querySelector('span').textContent = this.textContent; + dropdown.querySelector('input').value = this.getAttribute('id'); + + window.location.href = changeVersion(window.location.href, this.textContent); + }); + }); +}; + +/** + * This function fetches the available versions from a GitHub repository + * and inserts them into the version picker. + * + * @param {Element} dropdown - The dropdown element. + * @param {Element} dropdownMenu - The dropdown menu element. + * @returns {Promise>} A promise that resolves with an array of available versions. + */ +function fetchVersions(dropdown, dropdownMenu) { + return new Promise((resolve, reject) => { + window.addEventListener("load", () => { + + fetch("https://api.github.com/repos/matrix-org/synapse/git/trees/gh-pages", { + cache: "force-cache", + }).then(res => + res.json() + ).then(resObject => { + const excluded = ['dev-docs', 'v1.91.0', 'v1.80.0', 'v1.69.0']; + const tree = resObject.tree.filter(item => item.type === "tree" && !excluded.includes(item.path)); + const versions = tree.map(item => item.path).sort(sortVersions); + + // Create a list of
  • items for versions + versions.forEach((version) => { + const li = document.createElement("li"); + li.textContent = version; + li.id = version; + + if (window.SYNAPSE_VERSION === version) { + li.classList.add('active'); + dropdown.querySelector('span').textContent = version; + dropdown.querySelector('input').value = version; + } + + dropdownMenu.appendChild(li); + }); + + resolve(versions); + + }).catch(ex => { + console.error("Failed to fetch version data", ex); + reject(ex); + }) + }); + }); +} + +/** + * Custom sorting function to sort an array of version strings. + * + * @param {string} a - The first version string to compare. + * @param {string} b - The second version string to compare. + * @returns {number} - A negative number if a should come before b, a positive number if b should come before a, or 0 if they are equal. + */ +function sortVersions(a, b) { + // Put 'develop' and 'latest' at the top + if (a === 'develop' || a === 'latest') return -1; + if (b === 'develop' || b === 'latest') return 1; + + const versionA = (a.match(/v\d+(\.\d+)+/) || [])[0]; + const versionB = (b.match(/v\d+(\.\d+)+/) || [])[0]; + + return versionB.localeCompare(versionA); +} + +/** + * Change the version in a URL path. + * + * @param {string} url - The original URL to be modified. + * @param {string} newVersion - The new version to replace the existing version in the URL. + * @returns {string} The updated URL with the new version. + */ +function changeVersion(url, newVersion) { + const parsedURL = new URL(url); + const pathSegments = parsedURL.pathname.split('/'); + + // Modify the version + pathSegments[2] = newVersion; + + // Reconstruct the URL + parsedURL.pathname = pathSegments.join('/'); + + return parsedURL.href; +} \ No newline at end of file diff --git a/v1.82/website_files/version.js b/v1.82/website_files/version.js new file mode 100644 index 0000000000..a3118fe15a --- /dev/null +++ b/v1.82/website_files/version.js @@ -0,0 +1 @@ +window.SYNAPSE_VERSION = 'v1.82'; diff --git a/v1.82/welcome_and_overview.html b/v1.82/welcome_and_overview.html index d853008a2f..dca5bc0e4c 100644 --- a/v1.82/welcome_and_overview.html +++ b/v1.82/welcome_and_overview.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

    @@ -264,5 +277,7 @@ Policy. Thank you!

    + + - \ No newline at end of file + diff --git a/v1.82/workers.html b/v1.82/workers.html index 20e89c55e7..118941dde9 100644 --- a/v1.82/workers.html +++ b/v1.82/workers.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

    @@ -837,5 +850,7 @@ in systemd service files, but not required for synctl).

    + + - \ No newline at end of file +