From db3ddbaaa758ece4d0baf4345dee80fe3e63b7da Mon Sep 17 00:00:00 2001 From: Action Bot Date: Mon, 11 Dec 2023 14:56:41 +0000 Subject: [PATCH] Version picker deployed for v1.57 docs to Github Pages --- v1.57/.nojekyll | 1 - v1.57/.sample_config_header.yaml | 26 ---- v1.57/404.html | 17 ++- v1.57/CAPTCHA_SETUP.html | 17 ++- v1.57/admin_api/account_validity.html | 17 ++- v1.57/admin_api/delete_group.html | 17 ++- v1.57/admin_api/event_reports.html | 17 ++- v1.57/admin_api/media_admin_api.html | 17 ++- v1.57/admin_api/purge_history_api.html | 17 ++- v1.57/admin_api/register_api.html | 17 ++- v1.57/admin_api/room_membership.html | 17 ++- v1.57/admin_api/rooms.html | 17 ++- v1.57/admin_api/server_notices.html | 17 ++- v1.57/admin_api/statistics.html | 17 ++- v1.57/admin_api/user_admin_api.html | 17 ++- v1.57/admin_api/version_api.html | 17 ++- v1.57/application_services.html | 17 ++- v1.57/auth_chain_difference_algorithm.html | 17 ++- v1.57/code_style.html | 17 ++- v1.57/consent_tracking.html | 17 ++- v1.57/delegate.html | 17 ++- v1.57/deprecation_policy.html | 17 ++- v1.57/development/cas.html | 17 ++- v1.57/development/contributing_guide.html | 17 ++- v1.57/development/database_schema.html | 17 ++- v1.57/development/demo.html | 17 ++- v1.57/development/experimental_features.html | 17 ++- v1.57/development/git.html | 17 ++- .../internal_documentation/index.html | 17 ++- v1.57/development/releases.html | 17 ++- v1.57/development/room-dag-concepts.html | 17 ++- v1.57/development/saml.html | 17 ++- v1.57/development/url_previews.html | 17 ++- v1.57/docs/website_files/version-picker.css | 78 +++++++++++ v1.57/docs/website_files/version-picker.js | 127 ++++++++++++++++++ v1.57/docs/website_files/version.js | 1 + v1.57/federate.html | 17 ++- v1.57/index.html | 17 ++- v1.57/jwt.html | 17 ++- v1.57/log_contexts.html | 17 ++- v1.57/manhole.html | 17 ++- v1.57/media_repository.html | 17 ++- v1.57/message_retention_policies.html | 17 ++- v1.57/metrics-howto.html | 17 ++- v1.57/modules/account_data_callbacks.html | 17 ++- v1.57/modules/account_validity_callbacks.html | 17 ++- ...ackground_update_controller_callbacks.html | 17 ++- v1.57/modules/index.html | 17 ++- .../password_auth_provider_callbacks.html | 17 ++- v1.57/modules/porting_legacy_module.html | 17 ++- v1.57/modules/presence_router_callbacks.html | 17 ++- v1.57/modules/spam_checker_callbacks.html | 17 ++- .../modules/third_party_rules_callbacks.html | 17 ++- v1.57/modules/writing_a_module.html | 17 ++- v1.57/openid.html | 17 ++- v1.57/opentracing.html | 17 ++- ...ing_synapse_on_single_board_computers.html | 17 ++- v1.57/password_auth_providers.html | 17 ++- v1.57/postgres.html | 17 ++- v1.57/print.html | 17 ++- v1.57/replication.html | 17 ++- v1.57/reverse_proxy.html | 17 ++- v1.57/room_and_user_statistics.html | 17 ++- v1.57/server_notices.html | 17 ++- v1.57/setup/forward_proxy.html | 17 ++- v1.57/setup/installation.html | 17 ++- v1.57/sso_mapping_providers.html | 17 ++- v1.57/structured_logging.html | 17 ++- v1.57/synctl_workers.html | 17 ++- v1.57/systemd-with-workers/index.html | 17 ++- v1.57/tcp_replication.html | 17 ++- v1.57/templates.html | 17 ++- v1.57/turn-howto.html | 17 ++- v1.57/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.57/usage/administration/admin_faq.html | 17 ++- .../database_maintenance_tools.html | 17 ++- v1.57/usage/administration/index.html | 17 ++- v1.57/usage/administration/request_log.html | 17 ++- v1.57/usage/administration/state_groups.html | 17 ++- ...anding_synapse_through_grafana_graphs.html | 17 ++- .../administration/useful_sql_for_admins.html | 17 ++- .../homeserver_sample_config.html | 17 ++- v1.57/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.57/user_directory.html | 17 ++- v1.57/website_files/theme/index.hbs | 14 +- v1.57/website_files/version-picker.css | 78 +++++++++++ v1.57/website_files/version-picker.js | 127 ++++++++++++++++++ v1.57/website_files/version.js | 1 + v1.57/welcome_and_overview.html | 17 ++- v1.57/workers.html | 17 ++- 100 files changed, 1881 insertions(+), 119 deletions(-) delete mode 100644 v1.57/.nojekyll delete mode 100644 v1.57/.sample_config_header.yaml create mode 100644 v1.57/docs/website_files/version-picker.css create mode 100644 v1.57/docs/website_files/version-picker.js create mode 100644 v1.57/docs/website_files/version.js create mode 100644 v1.57/website_files/version-picker.css create mode 100644 v1.57/website_files/version-picker.js create mode 100644 v1.57/website_files/version.js diff --git a/v1.57/.nojekyll b/v1.57/.nojekyll deleted file mode 100644 index f17311098f..0000000000 --- a/v1.57/.nojekyll +++ /dev/null @@ -1 +0,0 @@ -This file makes sure that Github Pages doesn't process mdBook's output. diff --git a/v1.57/.sample_config_header.yaml b/v1.57/.sample_config_header.yaml deleted file mode 100644 index 09e86ca0ca..0000000000 --- a/v1.57/.sample_config_header.yaml +++ /dev/null @@ -1,26 +0,0 @@ -# This file is maintained as an up-to-date snapshot of the default -# homeserver.yaml configuration generated by Synapse. -# -# It is intended to act as a reference for the default configuration, -# helping admins keep track of new options and other changes, and compare -# their configs with the current default. As such, many of the actual -# config values shown are placeholders. -# -# 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. - -# Configuration options that take a time period can be set using a number -# followed by a letter. Letters have the following meanings: -# s = second -# m = minute -# h = hour -# d = day -# w = week -# y = year -# For example, setting redaction_retention_period: 5m would remove redacted -# messages from the database after 5 minutes, rather than 5 months. - -################################################################################ - diff --git a/v1.57/404.html b/v1.57/404.html index 17e9485c33..20921031ae 100644 --- a/v1.57/404.html +++ b/v1.57/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.57/CAPTCHA_SETUP.html b/v1.57/CAPTCHA_SETUP.html index 096e22bd61..27abdf7f61 100644 --- a/v1.57/CAPTCHA_SETUP.html +++ b/v1.57/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.57/admin_api/account_validity.html b/v1.57/admin_api/account_validity.html index c47e77eadb..d2bba5192e 100644 --- a/v1.57/admin_api/account_validity.html +++ b/v1.57/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.57/admin_api/delete_group.html b/v1.57/admin_api/delete_group.html index 7f2d1f5d71..1aa5088f9a 100644 --- a/v1.57/admin_api/delete_group.html +++ b/v1.57/admin_api/delete_group.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
+
+
+ + +
+ +
    + +
+
+

Synapse

@@ -194,5 +207,7 @@ for a server admin: see Admin API + + - \ No newline at end of file + diff --git a/v1.57/admin_api/event_reports.html b/v1.57/admin_api/event_reports.html index 63e58f975e..a5d1a0edca 100644 --- a/v1.57/admin_api/event_reports.html +++ b/v1.57/admin_api/event_reports.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
+
+
+ + +
+ +
    + +
+
+

Synapse

@@ -338,5 +351,7 @@ have a canonical alias set. + + - \ No newline at end of file + diff --git a/v1.57/admin_api/media_admin_api.html b/v1.57/admin_api/media_admin_api.html index 7440d915f8..351ff2d4eb 100644 --- a/v1.57/admin_api/media_admin_api.html +++ b/v1.57/admin_api/media_admin_api.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
+
+
+ + +
+ +
    + +
+
+

Synapse

@@ -398,5 +411,7 @@ from the originating server.

+ + - \ No newline at end of file + diff --git a/v1.57/admin_api/purge_history_api.html b/v1.57/admin_api/purge_history_api.html index bced462065..f9e3ed1e1c 100644 --- a/v1.57/admin_api/purge_history_api.html +++ b/v1.57/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.57/admin_api/register_api.html b/v1.57/admin_api/register_api.html index fa65f09dca..d5f4cdea41 100644 --- a/v1.57/admin_api/register_api.html +++ b/v1.57/admin_api/register_api.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
+
+
+ + +
+ +
    + +
+
+

Synapse

@@ -246,5 +259,7 @@ def generate_mac(nonce, user, password, admin=False, user_type=None): + + - \ No newline at end of file + diff --git a/v1.57/admin_api/room_membership.html b/v1.57/admin_api/room_membership.html index 562a3b6082..041eaf0667 100644 --- a/v1.57/admin_api/room_membership.html +++ b/v1.57/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.57/admin_api/rooms.html b/v1.57/admin_api/rooms.html index 9c4efd4dc0..315095b58d 100644 --- a/v1.57/admin_api/rooms.html +++ b/v1.57/admin_api/rooms.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
+
+
+ + +
+ +
    + +
+
+

Synapse

@@ -994,5 +1007,7 @@ that were deleted.

+ + - \ No newline at end of file + diff --git a/v1.57/admin_api/server_notices.html b/v1.57/admin_api/server_notices.html index 58a31303a9..aa5df91061 100644 --- a/v1.57/admin_api/server_notices.html +++ b/v1.57/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.57/admin_api/statistics.html b/v1.57/admin_api/statistics.html index b05a714110..e29fda8442 100644 --- a/v1.57/admin_api/statistics.html +++ b/v1.57/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.57/admin_api/user_admin_api.html b/v1.57/admin_api/user_admin_api.html index 94c2da194a..041f963adb 100644 --- a/v1.57/admin_api/user_admin_api.html +++ b/v1.57/admin_api/user_admin_api.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
+
+
+ + +
+ +
    + +
+
+

Synapse

@@ -1164,5 +1177,7 @@ for more information.

+ + - \ No newline at end of file + diff --git a/v1.57/admin_api/version_api.html b/v1.57/admin_api/version_api.html index a2b50cad74..63ea70635c 100644 --- a/v1.57/admin_api/version_api.html +++ b/v1.57/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.57/application_services.html b/v1.57/application_services.html index 3c784adfe3..22749513c1 100644 --- a/v1.57/application_services.html +++ b/v1.57/application_services.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
+
+
+ + +
+ +
    + +
+
+

Synapse

@@ -211,5 +224,7 @@ namespaces: + + - \ No newline at end of file + diff --git a/v1.57/auth_chain_difference_algorithm.html b/v1.57/auth_chain_difference_algorithm.html index fdea17500c..b0a4a61c64 100644 --- a/v1.57/auth_chain_difference_algorithm.html +++ b/v1.57/auth_chain_difference_algorithm.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
+
+
+ + +
+ +
    + +
+
+

Synapse

@@ -276,5 +289,7 @@ level). + + - \ No newline at end of file + diff --git a/v1.57/code_style.html b/v1.57/code_style.html index 0620f138e3..98a10180bf 100644 --- a/v1.57/code_style.html +++ b/v1.57/code_style.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
+
+
+ + +
+ +
    + +
+
+

Synapse

@@ -362,5 +375,7 @@ is left as an exercise for the reader!

+ + - \ No newline at end of file + diff --git a/v1.57/consent_tracking.html b/v1.57/consent_tracking.html index e0bce9b39f..ef8d23291c 100644 --- a/v1.57/consent_tracking.html +++ b/v1.57/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.57/delegate.html b/v1.57/delegate.html index 5e13feafff..5227855f3f 100644 --- a/v1.57/delegate.html +++ b/v1.57/delegate.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
+
+
+ + +
+ +
    + +
+
+

Synapse

@@ -257,5 +270,7 @@ reverse proxy.

+ + - \ No newline at end of file + diff --git a/v1.57/deprecation_policy.html b/v1.57/deprecation_policy.html index 87768c5c90..4f767bcdd7 100644 --- a/v1.57/deprecation_policy.html +++ b/v1.57/deprecation_policy.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
+
+
+ + +
+ +
    + +
+
+

Synapse

@@ -206,5 +219,7 @@ to constantly update their platform dependencies to the latest versions.

+ + - \ No newline at end of file + diff --git a/v1.57/development/cas.html b/v1.57/development/cas.html index df3e34dbd2..737d2574a2 100644 --- a/v1.57/development/cas.html +++ b/v1.57/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.57/development/contributing_guide.html b/v1.57/development/contributing_guide.html index 920ad727fd..a6e6ae0293 100644 --- a/v1.57/development/contributing_guide.html +++ b/v1.57/development/contributing_guide.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
+
+
+ + +
+ +
    + +
+
+

Synapse

@@ -557,5 +570,7 @@ do!

+ + - \ No newline at end of file + diff --git a/v1.57/development/database_schema.html b/v1.57/development/database_schema.html index eb4678413a..077ece347d 100644 --- a/v1.57/development/database_schema.html +++ b/v1.57/development/database_schema.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
+
+
+ + +
+ +
    + +
+
+

Synapse

@@ -347,5 +360,7 @@ in Python, evaluates to True.

+ + - \ No newline at end of file + diff --git a/v1.57/development/demo.html b/v1.57/development/demo.html index 9e1b6ae22e..1ccf1016b7 100644 --- a/v1.57/development/demo.html +++ b/v1.57/development/demo.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
+
+
+ + +
+ +
    + +
+
+

Synapse

@@ -219,5 +232,7 @@ it won't work if your HS already has a room with that name.

+ + - \ No newline at end of file + diff --git a/v1.57/development/experimental_features.html b/v1.57/development/experimental_features.html index 82a97bc900..c15780f4cc 100644 --- a/v1.57/development/experimental_features.html +++ b/v1.57/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.57/development/git.html b/v1.57/development/git.html index bf4c865f1d..d89d68945b 100644 --- a/v1.57/development/git.html +++ b/v1.57/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.57/development/internal_documentation/index.html b/v1.57/development/internal_documentation/index.html index 5becaa50a3..52a9e17592 100644 --- a/v1.57/development/internal_documentation/index.html +++ b/v1.57/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.57/development/releases.html b/v1.57/development/releases.html index 6dcd0fbade..63626e0bca 100644 --- a/v1.57/development/releases.html +++ b/v1.57/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.57/development/room-dag-concepts.html b/v1.57/development/room-dag-concepts.html index a03d34be03..9c399db168 100644 --- a/v1.57/development/room-dag-concepts.html +++ b/v1.57/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.57/development/saml.html b/v1.57/development/saml.html index 3990872c8f..17619e0d30 100644 --- a/v1.57/development/saml.html +++ b/v1.57/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.57/development/url_previews.html b/v1.57/development/url_previews.html index a9769a0a49..1453657e47 100644 --- a/v1.57/development/url_previews.html +++ b/v1.57/development/url_previews.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
+
+
+ + +
+ +
    + +
+
+

Synapse

@@ -269,5 +282,7 @@ deleted every 10 seconds. The default expiration time is 1 hour from download. + + - \ No newline at end of file + diff --git a/v1.57/docs/website_files/version-picker.css b/v1.57/docs/website_files/version-picker.css new file mode 100644 index 0000000000..28e5d5219a --- /dev/null +++ b/v1.57/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.57/docs/website_files/version-picker.js b/v1.57/docs/website_files/version-picker.js new file mode 100644 index 0000000000..bb35a7d896 --- /dev/null +++ b/v1.57/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.57/docs/website_files/version.js b/v1.57/docs/website_files/version.js new file mode 100644 index 0000000000..7ad324141a --- /dev/null +++ b/v1.57/docs/website_files/version.js @@ -0,0 +1 @@ +window.SYNAPSE_VERSION = 'v1.57'; diff --git a/v1.57/federate.html b/v1.57/federate.html index c7bb779047..7892a3a595 100644 --- a/v1.57/federate.html +++ b/v1.57/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.57/index.html b/v1.57/index.html index c7cb7b3c24..7f5e997d8f 100644 --- a/v1.57/index.html +++ b/v1.57/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.57/jwt.html b/v1.57/jwt.html index 166ff2425b..b1af769182 100644 --- a/v1.57/jwt.html +++ b/v1.57/jwt.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

    @@ -275,5 +288,7 @@ eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ0ZXN0LXVzZXIifQ.Ag71GT8v01UO3w80 + + - \ No newline at end of file + diff --git a/v1.57/log_contexts.html b/v1.57/log_contexts.html index 72f20b01fb..d99af44f10 100644 --- a/v1.57/log_contexts.html +++ b/v1.57/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.57/manhole.html b/v1.57/manhole.html index 10c4624903..c479e74c25 100644 --- a/v1.57/manhole.html +++ b/v1.57/manhole.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

    @@ -252,5 +265,7 @@ parts of the process.

    + + - \ No newline at end of file + diff --git a/v1.57/media_repository.html b/v1.57/media_repository.html index 496390e4bf..9c40251b8f 100644 --- a/v1.57/media_repository.html +++ b/v1.57/media_repository.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

    @@ -248,5 +261,7 @@ url_cache_thumbnails/yyyy-mm-dd/aaaaaaaaaaaaaaaa/128-96-image-jpeg-scale + + - \ No newline at end of file + diff --git a/v1.57/message_retention_policies.html b/v1.57/message_retention_policies.html index e3d98e7267..727a376729 100644 --- a/v1.57/message_retention_policies.html +++ b/v1.57/message_retention_policies.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

    @@ -341,5 +354,7 @@ operating system, the server admin needs to run VACUUM FULL; (or + + - \ No newline at end of file + diff --git a/v1.57/metrics-howto.html b/v1.57/metrics-howto.html index 25210dc730..7f8cfb841e 100644 --- a/v1.57/metrics-howto.html +++ b/v1.57/metrics-howto.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

    @@ -425,5 +438,7 @@ renamed.

    + + - \ No newline at end of file + diff --git a/v1.57/modules/account_data_callbacks.html b/v1.57/modules/account_data_callbacks.html index b19c41bed8..76c4af7b72 100644 --- a/v1.57/modules/account_data_callbacks.html +++ b/v1.57/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.57/modules/account_validity_callbacks.html b/v1.57/modules/account_validity_callbacks.html index 046287ee84..f9344ba574 100644 --- a/v1.57/modules/account_validity_callbacks.html +++ b/v1.57/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.57/modules/background_update_controller_callbacks.html b/v1.57/modules/background_update_controller_callbacks.html index 4af2813554..51bed34ab0 100644 --- a/v1.57/modules/background_update_controller_callbacks.html +++ b/v1.57/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.57/modules/index.html b/v1.57/modules/index.html index 2bedcf353a..342669712b 100644 --- a/v1.57/modules/index.html +++ b/v1.57/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.57/modules/password_auth_provider_callbacks.html b/v1.57/modules/password_auth_provider_callbacks.html index 47b1ea573e..8e930c35ab 100644 --- a/v1.57/modules/password_auth_provider_callbacks.html +++ b/v1.57/modules/password_auth_provider_callbacks.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

    @@ -420,5 +433,7 @@ class MyAuthProvider: + + - \ No newline at end of file + diff --git a/v1.57/modules/porting_legacy_module.html b/v1.57/modules/porting_legacy_module.html index 40c3e5dfaa..84c8daec63 100644 --- a/v1.57/modules/porting_legacy_module.html +++ b/v1.57/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.57/modules/presence_router_callbacks.html b/v1.57/modules/presence_router_callbacks.html index 3830f289fd..5a73fe9608 100644 --- a/v1.57/modules/presence_router_callbacks.html +++ b/v1.57/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.57/modules/spam_checker_callbacks.html b/v1.57/modules/spam_checker_callbacks.html index 274fe2c63e..c9ce77da8b 100644 --- a/v1.57/modules/spam_checker_callbacks.html +++ b/v1.57/modules/spam_checker_callbacks.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

    @@ -409,5 +422,7 @@ class ListSpamChecker: + + - \ No newline at end of file + diff --git a/v1.57/modules/third_party_rules_callbacks.html b/v1.57/modules/third_party_rules_callbacks.html index 4cc758818f..da486e917a 100644 --- a/v1.57/modules/third_party_rules_callbacks.html +++ b/v1.57/modules/third_party_rules_callbacks.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

    @@ -405,5 +418,7 @@ class EventCensorer: + + - \ No newline at end of file + diff --git a/v1.57/modules/writing_a_module.html b/v1.57/modules/writing_a_module.html index 3672ad1b20..2036d86503 100644 --- a/v1.57/modules/writing_a_module.html +++ b/v1.57/modules/writing_a_module.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

    @@ -246,5 +259,7 @@ the callback name as the argument name and the function as its value. A + + - \ No newline at end of file + diff --git a/v1.57/openid.html b/v1.57/openid.html index 299fd56495..4a365d1436 100644 --- a/v1.57/openid.html +++ b/v1.57/openid.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

    @@ -704,5 +717,7 @@ needed to add OAuth2 capabilities to your Django projects. It supports + + - \ No newline at end of file + diff --git a/v1.57/opentracing.html b/v1.57/opentracing.html index d9e1b5a0de..dbc3524d70 100644 --- a/v1.57/opentracing.html +++ b/v1.57/opentracing.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

    @@ -258,5 +271,7 @@ logged to OpenTracing's logs.
    • + + - \ No newline at end of file + diff --git a/v1.57/other/running_synapse_on_single_board_computers.html b/v1.57/other/running_synapse_on_single_board_computers.html index 7b45507aab..e14da97dc4 100644 --- a/v1.57/other/running_synapse_on_single_board_computers.html +++ b/v1.57/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.57/password_auth_providers.html b/v1.57/password_auth_providers.html index 87d1e680d9..0f6332528a 100644 --- a/v1.57/password_auth_providers.html +++ b/v1.57/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.57/postgres.html b/v1.57/postgres.html index b0273ff50c..cf73ac0029 100644 --- a/v1.57/postgres.html +++ b/v1.57/postgres.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

    @@ -386,5 +399,7 @@ successfully.

    + + - \ No newline at end of file + diff --git a/v1.57/print.html b/v1.57/print.html index 4c4d3b1b0e..d6203133dd 100644 --- a/v1.57/print.html +++ b/v1.57/print.html @@ -29,6 +29,7 @@ + @@ -104,6 +105,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

    @@ -15101,10 +15114,12 @@ admin@homeserver:~$ sudo --user postgres psql matrix-synapse --command 'select c + + - \ No newline at end of file + diff --git a/v1.57/replication.html b/v1.57/replication.html index 2e19db31d6..b8a939056e 100644 --- a/v1.57/replication.html +++ b/v1.57/replication.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

    @@ -213,5 +226,7 @@ replication API to invalidate their caches.

    + + - \ No newline at end of file + diff --git a/v1.57/reverse_proxy.html b/v1.57/reverse_proxy.html index 32890d6fbd..a243998564 100644 --- a/v1.57/reverse_proxy.html +++ b/v1.57/reverse_proxy.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

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

    + + - \ No newline at end of file + diff --git a/v1.57/room_and_user_statistics.html b/v1.57/room_and_user_statistics.html index 56db9ea216..61f51449d4 100644 --- a/v1.57/room_and_user_statistics.html +++ b/v1.57/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.57/server_notices.html b/v1.57/server_notices.html index 140071b202..d9cae29e71 100644 --- a/v1.57/server_notices.html +++ b/v1.57/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.57/setup/forward_proxy.html b/v1.57/setup/forward_proxy.html index 7c8fa44606..59a5f55e20 100644 --- a/v1.57/setup/forward_proxy.html +++ b/v1.57/setup/forward_proxy.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

    @@ -260,5 +273,7 @@ in Synapse can be deactivated.

    + + - \ No newline at end of file + diff --git a/v1.57/setup/installation.html b/v1.57/setup/installation.html index 3625e5d3ed..9728169440 100644 --- a/v1.57/setup/installation.html +++ b/v1.57/setup/installation.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

    @@ -588,5 +601,7 @@ failing, e.g.:

    + + - \ No newline at end of file + diff --git a/v1.57/sso_mapping_providers.html b/v1.57/sso_mapping_providers.html index 1672027ba7..5120df609e 100644 --- a/v1.57/sso_mapping_providers.html +++ b/v1.57/sso_mapping_providers.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

    @@ -434,5 +447,7 @@ specified in the config. It is located at + + - \ No newline at end of file + diff --git a/v1.57/structured_logging.html b/v1.57/structured_logging.html index e2e2fbdce5..562188fdbe 100644 --- a/v1.57/structured_logging.html +++ b/v1.57/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.57/synctl_workers.html b/v1.57/synctl_workers.html index 08a0d4c003..007dbee43c 100644 --- a/v1.57/synctl_workers.html +++ b/v1.57/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.57/systemd-with-workers/index.html b/v1.57/systemd-with-workers/index.html index 0d6a008397..34bea1ac85 100644 --- a/v1.57/systemd-with-workers/index.html +++ b/v1.57/systemd-with-workers/index.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

    @@ -277,5 +290,7 @@ the changes being applied at a glance.

    + + - \ No newline at end of file + diff --git a/v1.57/tcp_replication.html b/v1.57/tcp_replication.html index a99e6e6cd3..96566d9816 100644 --- a/v1.57/tcp_replication.html +++ b/v1.57/tcp_replication.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

    @@ -380,5 +393,7 @@ state + + - \ No newline at end of file + diff --git a/v1.57/templates.html b/v1.57/templates.html index 04a3eebb85..8dd1266179 100644 --- a/v1.57/templates.html +++ b/v1.57/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.57/turn-howto.html b/v1.57/turn-howto.html index e5339a633e..b1456d230f 100644 --- a/v1.57/turn-howto.html +++ b/v1.57/turn-howto.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

    @@ -505,5 +518,7 @@ entry in the results.

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

    Synapse

    @@ -1559,5 +1572,7 @@ in the local HS will automatically rejoin the room.

    + + - \ No newline at end of file + diff --git a/v1.57/usage/administration/admin_api/background_updates.html b/v1.57/usage/administration/admin_api/background_updates.html index e848c8af0f..daf7eb9bb5 100644 --- a/v1.57/usage/administration/admin_api/background_updates.html +++ b/v1.57/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.57/usage/administration/admin_api/federation.html b/v1.57/usage/administration/admin_api/federation.html index 81bed059c6..86b6f87457 100644 --- a/v1.57/usage/administration/admin_api/federation.html +++ b/v1.57/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.57/usage/administration/admin_api/index.html b/v1.57/usage/administration/admin_api/index.html index 38ad22a7a8..e81735c798 100644 --- a/v1.57/usage/administration/admin_api/index.html +++ b/v1.57/usage/administration/admin_api/index.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

    @@ -203,5 +216,7 @@ providing the token as either a query parameter or a request header. To add it a + + - \ No newline at end of file + diff --git a/v1.57/usage/administration/admin_api/registration_tokens.html b/v1.57/usage/administration/admin_api/registration_tokens.html index d5c755ebde..68425cd1ac 100644 --- a/v1.57/usage/administration/admin_api/registration_tokens.html +++ b/v1.57/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.57/usage/administration/admin_faq.html b/v1.57/usage/administration/admin_faq.html index 76102cb6ac..a10873ca2d 100644 --- a/v1.57/usage/administration/admin_faq.html +++ b/v1.57/usage/administration/admin_faq.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

    @@ -247,5 +260,7 @@ and order_by state_events.

    + + - \ No newline at end of file + diff --git a/v1.57/usage/administration/database_maintenance_tools.html b/v1.57/usage/administration/database_maintenance_tools.html index 904b63d2ff..f69a89dbba 100644 --- a/v1.57/usage/administration/database_maintenance_tools.html +++ b/v1.57/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.57/usage/administration/index.html b/v1.57/usage/administration/index.html index 64548b6118..93cc41d2f8 100644 --- a/v1.57/usage/administration/index.html +++ b/v1.57/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.57/usage/administration/request_log.html b/v1.57/usage/administration/request_log.html index 2ecd508b30..1cefb86323 100644 --- a/v1.57/usage/administration/request_log.html +++ b/v1.57/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.57/usage/administration/state_groups.html b/v1.57/usage/administration/state_groups.html index cf8b6da735..3946a76f1e 100644 --- a/v1.57/usage/administration/state_groups.html +++ b/v1.57/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.57/usage/administration/understanding_synapse_through_grafana_graphs.html b/v1.57/usage/administration/understanding_synapse_through_grafana_graphs.html index 9e55126c0b..3d3adf5b5d 100644 --- a/v1.57/usage/administration/understanding_synapse_through_grafana_graphs.html +++ b/v1.57/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.57/usage/administration/useful_sql_for_admins.html b/v1.57/usage/administration/useful_sql_for_admins.html index bca4be9875..4c8b1fc731 100644 --- a/v1.57/usage/administration/useful_sql_for_admins.html +++ b/v1.57/usage/administration/useful_sql_for_admins.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

    @@ -319,5 +332,7 @@ WHERE room_id IN (WHERE room_id IN ( + + - \ No newline at end of file + diff --git a/v1.57/usage/configuration/homeserver_sample_config.html b/v1.57/usage/configuration/homeserver_sample_config.html index fb6a1a0d5c..3cbff94aa6 100644 --- a/v1.57/usage/configuration/homeserver_sample_config.html +++ b/v1.57/usage/configuration/homeserver_sample_config.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

    @@ -2986,5 +2999,7 @@ background_updates: + + - \ No newline at end of file + diff --git a/v1.57/usage/configuration/index.html b/v1.57/usage/configuration/index.html index 880cf41cd7..17950b5955 100644 --- a/v1.57/usage/configuration/index.html +++ b/v1.57/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.57/usage/configuration/logging_sample_config.html b/v1.57/usage/configuration/logging_sample_config.html index 1bbea63415..ba609e4499 100644 --- a/v1.57/usage/configuration/logging_sample_config.html +++ b/v1.57/usage/configuration/logging_sample_config.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

    @@ -278,5 +291,7 @@ disable_existing_loggers: false + + - \ No newline at end of file + diff --git a/v1.57/usage/configuration/user_authentication/index.html b/v1.57/usage/configuration/user_authentication/index.html index 05cc2e7efa..e2b1fcb426 100644 --- a/v1.57/usage/configuration/user_authentication/index.html +++ b/v1.57/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.57/usage/configuration/user_authentication/refresh_tokens.html b/v1.57/usage/configuration/user_authentication/refresh_tokens.html index 115ef39ba6..72c37ddcdf 100644 --- a/v1.57/usage/configuration/user_authentication/refresh_tokens.html +++ b/v1.57/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.57/usage/configuration/user_authentication/single_sign_on/cas.html b/v1.57/usage/configuration/user_authentication/single_sign_on/cas.html index 201c69c7a4..60c72aadcf 100644 --- a/v1.57/usage/configuration/user_authentication/single_sign_on/cas.html +++ b/v1.57/usage/configuration/user_authentication/single_sign_on/cas.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.57/usage/configuration/user_authentication/single_sign_on/index.html b/v1.57/usage/configuration/user_authentication/single_sign_on/index.html index ed9354b6d6..0ef98ef4ec 100644 --- a/v1.57/usage/configuration/user_authentication/single_sign_on/index.html +++ b/v1.57/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.57/usage/configuration/user_authentication/single_sign_on/saml.html b/v1.57/usage/configuration/user_authentication/single_sign_on/saml.html index 31d4e0d62d..79a07ccab8 100644 --- a/v1.57/usage/configuration/user_authentication/single_sign_on/saml.html +++ b/v1.57/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.57/user_directory.html b/v1.57/user_directory.html index 0c49568216..688f26af44 100644 --- a/v1.57/user_directory.html +++ b/v1.57/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.57/website_files/theme/index.hbs b/v1.57/website_files/theme/index.hbs index 3b7a5b6163..b169323a43 100644 --- a/v1.57/website_files/theme/index.hbs +++ b/v1.57/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.57/website_files/version-picker.css b/v1.57/website_files/version-picker.css new file mode 100644 index 0000000000..28e5d5219a --- /dev/null +++ b/v1.57/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.57/website_files/version-picker.js b/v1.57/website_files/version-picker.js new file mode 100644 index 0000000000..bb35a7d896 --- /dev/null +++ b/v1.57/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.57/website_files/version.js b/v1.57/website_files/version.js new file mode 100644 index 0000000000..7ad324141a --- /dev/null +++ b/v1.57/website_files/version.js @@ -0,0 +1 @@ +window.SYNAPSE_VERSION = 'v1.57'; diff --git a/v1.57/welcome_and_overview.html b/v1.57/welcome_and_overview.html index c7cb7b3c24..7f5e997d8f 100644 --- a/v1.57/welcome_and_overview.html +++ b/v1.57/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.57/workers.html b/v1.57/workers.html index f6f10ac7e0..8e5820562a 100644 --- a/v1.57/workers.html +++ b/v1.57/workers.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

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

    + + - \ No newline at end of file +