From 1621dba8b35a2bfbe1e2b835e0a87f6efcd03b2c Mon Sep 17 00:00:00 2001 From: Action Bot Date: Mon, 11 Dec 2023 14:56:08 +0000 Subject: [PATCH] Version picker deployed for v1.63 docs to Github Pages --- v1.63/.nojekyll | 1 - v1.63/.sample_config_header.yaml | 12 -- v1.63/404.html | 17 ++- v1.63/CAPTCHA_SETUP.html | 17 ++- v1.63/admin_api/account_validity.html | 17 ++- v1.63/admin_api/event_reports.html | 17 ++- v1.63/admin_api/media_admin_api.html | 17 ++- v1.63/admin_api/purge_history_api.html | 17 ++- v1.63/admin_api/register_api.html | 17 ++- v1.63/admin_api/room_membership.html | 17 ++- v1.63/admin_api/rooms.html | 17 ++- v1.63/admin_api/server_notices.html | 17 ++- v1.63/admin_api/statistics.html | 17 ++- v1.63/admin_api/user_admin_api.html | 17 ++- v1.63/admin_api/version_api.html | 17 ++- v1.63/application_services.html | 17 ++- v1.63/auth_chain_difference_algorithm.html | 17 ++- v1.63/code_style.html | 17 ++- v1.63/consent_tracking.html | 17 ++- v1.63/delegate.html | 17 ++- v1.63/deprecation_policy.html | 17 ++- v1.63/development/cas.html | 17 ++- v1.63/development/contributing_guide.html | 17 ++- v1.63/development/database_schema.html | 17 ++- v1.63/development/demo.html | 17 ++- v1.63/development/dependencies.html | 17 ++- v1.63/development/experimental_features.html | 17 ++- v1.63/development/git.html | 17 ++- .../internal_documentation/index.html | 17 ++- v1.63/development/releases.html | 17 ++- v1.63/development/reviews.html | 17 ++- v1.63/development/room-dag-concepts.html | 17 ++- v1.63/development/saml.html | 17 ++- .../synapse_architecture/cancellation.html | 17 ++- v1.63/development/url_previews.html | 17 ++- v1.63/docs/website_files/version-picker.css | 78 +++++++++++ v1.63/docs/website_files/version-picker.js | 127 ++++++++++++++++++ v1.63/docs/website_files/version.js | 1 + v1.63/federate.html | 17 ++- v1.63/index.html | 17 ++- v1.63/jwt.html | 17 ++- v1.63/log_contexts.html | 17 ++- v1.63/manhole.html | 17 ++- v1.63/media_repository.html | 17 ++- v1.63/message_retention_policies.html | 17 ++- v1.63/metrics-howto.html | 17 ++- v1.63/modules/account_data_callbacks.html | 17 ++- v1.63/modules/account_validity_callbacks.html | 17 ++- ...ackground_update_controller_callbacks.html | 17 ++- v1.63/modules/index.html | 17 ++- .../password_auth_provider_callbacks.html | 17 ++- v1.63/modules/porting_legacy_module.html | 17 ++- v1.63/modules/presence_router_callbacks.html | 17 ++- v1.63/modules/spam_checker_callbacks.html | 17 ++- .../modules/third_party_rules_callbacks.html | 17 ++- v1.63/modules/writing_a_module.html | 17 ++- v1.63/openid.html | 17 ++- v1.63/opentracing.html | 17 ++- ...ing_synapse_on_single_board_computers.html | 17 ++- v1.63/password_auth_providers.html | 17 ++- v1.63/postgres.html | 17 ++- v1.63/print.html | 17 ++- v1.63/replication.html | 17 ++- v1.63/reverse_proxy.html | 17 ++- v1.63/room_and_user_statistics.html | 17 ++- v1.63/server_notices.html | 17 ++- v1.63/setup/forward_proxy.html | 17 ++- v1.63/setup/installation.html | 17 ++- v1.63/sso_mapping_providers.html | 17 ++- v1.63/structured_logging.html | 17 ++- v1.63/synctl_workers.html | 17 ++- v1.63/systemd-with-workers/index.html | 17 ++- v1.63/tcp_replication.html | 17 ++- v1.63/templates.html | 17 ++- v1.63/turn-howto.html | 17 ++- v1.63/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.63/usage/administration/admin_faq.html | 17 ++- .../database_maintenance_tools.html | 17 ++- v1.63/usage/administration/index.html | 17 ++- ...reporting_homeserver_usage_statistics.html | 17 ++- v1.63/usage/administration/request_log.html | 17 ++- v1.63/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.63/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.63/user_directory.html | 17 ++- v1.63/website_files/theme/index.hbs | 14 +- v1.63/website_files/version-picker.css | 78 +++++++++++ v1.63/website_files/version-picker.js | 127 ++++++++++++++++++ v1.63/website_files/version.js | 1 + v1.63/welcome_and_overview.html | 17 ++- v1.63/workers.html | 17 ++- 104 files changed, 1945 insertions(+), 109 deletions(-) delete mode 100644 v1.63/.nojekyll delete mode 100644 v1.63/.sample_config_header.yaml create mode 100644 v1.63/docs/website_files/version-picker.css create mode 100644 v1.63/docs/website_files/version-picker.js create mode 100644 v1.63/docs/website_files/version.js create mode 100644 v1.63/website_files/version-picker.css create mode 100644 v1.63/website_files/version-picker.js create mode 100644 v1.63/website_files/version.js diff --git a/v1.63/.nojekyll b/v1.63/.nojekyll deleted file mode 100644 index f17311098f..0000000000 --- a/v1.63/.nojekyll +++ /dev/null @@ -1 +0,0 @@ -This file makes sure that Github Pages doesn't process mdBook's output. diff --git a/v1.63/.sample_config_header.yaml b/v1.63/.sample_config_header.yaml deleted file mode 100644 index 2355337e6d..0000000000 --- a/v1.63/.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.63/404.html b/v1.63/404.html index 297f7be89e..da6199acfc 100644 --- a/v1.63/404.html +++ b/v1.63/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.63/CAPTCHA_SETUP.html b/v1.63/CAPTCHA_SETUP.html index b1ae6ca30e..b1cc35912f 100644 --- a/v1.63/CAPTCHA_SETUP.html +++ b/v1.63/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.63/admin_api/account_validity.html b/v1.63/admin_api/account_validity.html index 21c9c4a303..0537321209 100644 --- a/v1.63/admin_api/account_validity.html +++ b/v1.63/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.63/admin_api/event_reports.html b/v1.63/admin_api/event_reports.html index a62222f3a2..6c04834c12 100644 --- a/v1.63/admin_api/event_reports.html +++ b/v1.63/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.63/admin_api/media_admin_api.html b/v1.63/admin_api/media_admin_api.html index 5a8a604eb6..14be65ec7f 100644 --- a/v1.63/admin_api/media_admin_api.html +++ b/v1.63/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.63/admin_api/purge_history_api.html b/v1.63/admin_api/purge_history_api.html index c7a7c50409..1ab4ae8be2 100644 --- a/v1.63/admin_api/purge_history_api.html +++ b/v1.63/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.63/admin_api/register_api.html b/v1.63/admin_api/register_api.html index 286bbe8d2a..676637a959 100644 --- a/v1.63/admin_api/register_api.html +++ b/v1.63/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.63/admin_api/room_membership.html b/v1.63/admin_api/room_membership.html index 700fa68d53..99abffaa6d 100644 --- a/v1.63/admin_api/room_membership.html +++ b/v1.63/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.63/admin_api/rooms.html b/v1.63/admin_api/rooms.html index f106d40e48..f6225892e5 100644 --- a/v1.63/admin_api/rooms.html +++ b/v1.63/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.63/admin_api/server_notices.html b/v1.63/admin_api/server_notices.html index d365d86f98..6dc9e325a2 100644 --- a/v1.63/admin_api/server_notices.html +++ b/v1.63/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.63/admin_api/statistics.html b/v1.63/admin_api/statistics.html index bc92dd2908..7b98621623 100644 --- a/v1.63/admin_api/statistics.html +++ b/v1.63/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.63/admin_api/user_admin_api.html b/v1.63/admin_api/user_admin_api.html index 9029191c2c..9f22b9e17e 100644 --- a/v1.63/admin_api/user_admin_api.html +++ b/v1.63/admin_api/user_admin_api.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
+
+
+ + +
+ +
    + +
+
+

Synapse

@@ -1165,5 +1178,7 @@ for more information.

+ + - \ No newline at end of file + diff --git a/v1.63/admin_api/version_api.html b/v1.63/admin_api/version_api.html index 75522a9ffa..d5b0e0e1fa 100644 --- a/v1.63/admin_api/version_api.html +++ b/v1.63/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.63/application_services.html b/v1.63/application_services.html index ab37695696..a5a73923d4 100644 --- a/v1.63/application_services.html +++ b/v1.63/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.63/auth_chain_difference_algorithm.html b/v1.63/auth_chain_difference_algorithm.html index 69ed57e4e9..680c094bf6 100644 --- a/v1.63/auth_chain_difference_algorithm.html +++ b/v1.63/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.63/code_style.html b/v1.63/code_style.html index 6b21c6b902..5bb5bf4375 100644 --- a/v1.63/code_style.html +++ b/v1.63/code_style.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
+
+
+ + +
+ +
    + +
+
+

Synapse

@@ -308,5 +321,7 @@ is left as an exercise for the reader!

+ + - \ No newline at end of file + diff --git a/v1.63/consent_tracking.html b/v1.63/consent_tracking.html index 447e83a64d..daf04fe9b9 100644 --- a/v1.63/consent_tracking.html +++ b/v1.63/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.63/delegate.html b/v1.63/delegate.html index d6477468a2..df8f28590c 100644 --- a/v1.63/delegate.html +++ b/v1.63/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.63/deprecation_policy.html b/v1.63/deprecation_policy.html index 7756cd2e81..f68fa54456 100644 --- a/v1.63/deprecation_policy.html +++ b/v1.63/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.63/development/cas.html b/v1.63/development/cas.html index f8228d64a2..0a1014f2b4 100644 --- a/v1.63/development/cas.html +++ b/v1.63/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.63/development/contributing_guide.html b/v1.63/development/contributing_guide.html index bdebf87817..82df1891bd 100644 --- a/v1.63/development/contributing_guide.html +++ b/v1.63/development/contributing_guide.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
+
+
+ + +
+ +
    + +
+
+

Synapse

@@ -592,5 +605,7 @@ do!

+ + - \ No newline at end of file + diff --git a/v1.63/development/database_schema.html b/v1.63/development/database_schema.html index 2b2c5ceaec..a5d5679b5e 100644 --- a/v1.63/development/database_schema.html +++ b/v1.63/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.63/development/demo.html b/v1.63/development/demo.html index 88089929c4..50d3bacfc4 100644 --- a/v1.63/development/demo.html +++ b/v1.63/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.63/development/dependencies.html b/v1.63/development/dependencies.html index 168648a8a0..51cbc0f3a1 100644 --- a/v1.63/development/dependencies.html +++ b/v1.63/development/dependencies.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
+
+
+ + +
+ +
    + +
+
+

Synapse

@@ -360,5 +373,7 @@ doesn't require poetry. (It's what we use in CI too). However, you could try + + - \ No newline at end of file + diff --git a/v1.63/development/experimental_features.html b/v1.63/development/experimental_features.html index e58d22dba1..99ce817ced 100644 --- a/v1.63/development/experimental_features.html +++ b/v1.63/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.63/development/git.html b/v1.63/development/git.html index 1f6ac5c907..3c92e18e3e 100644 --- a/v1.63/development/git.html +++ b/v1.63/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.63/development/internal_documentation/index.html b/v1.63/development/internal_documentation/index.html index 1de6b5daee..6581bde74e 100644 --- a/v1.63/development/internal_documentation/index.html +++ b/v1.63/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.63/development/releases.html b/v1.63/development/releases.html index 502adcad8e..eca1f61ce9 100644 --- a/v1.63/development/releases.html +++ b/v1.63/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.63/development/reviews.html b/v1.63/development/reviews.html index bf32996243..15e0d68ecf 100644 --- a/v1.63/development/reviews.html +++ b/v1.63/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.63/development/room-dag-concepts.html b/v1.63/development/room-dag-concepts.html index 69dc0aa4a3..378fa698d4 100644 --- a/v1.63/development/room-dag-concepts.html +++ b/v1.63/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.63/development/saml.html b/v1.63/development/saml.html index 6c99649b81..78782dab0d 100644 --- a/v1.63/development/saml.html +++ b/v1.63/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.63/development/synapse_architecture/cancellation.html b/v1.63/development/synapse_architecture/cancellation.html index 0cbce2f205..addef7d05c 100644 --- a/v1.63/development/synapse_architecture/cancellation.html +++ b/v1.63/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.63/development/url_previews.html b/v1.63/development/url_previews.html index 8814f5c9da..40b03316f2 100644 --- a/v1.63/development/url_previews.html +++ b/v1.63/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.63/docs/website_files/version-picker.css b/v1.63/docs/website_files/version-picker.css new file mode 100644 index 0000000000..28e5d5219a --- /dev/null +++ b/v1.63/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.63/docs/website_files/version-picker.js b/v1.63/docs/website_files/version-picker.js new file mode 100644 index 0000000000..bb35a7d896 --- /dev/null +++ b/v1.63/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.63/docs/website_files/version.js b/v1.63/docs/website_files/version.js new file mode 100644 index 0000000000..0594b5c438 --- /dev/null +++ b/v1.63/docs/website_files/version.js @@ -0,0 +1 @@ +window.SYNAPSE_VERSION = 'v1.63'; diff --git a/v1.63/federate.html b/v1.63/federate.html index a20703787b..b380865d67 100644 --- a/v1.63/federate.html +++ b/v1.63/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.63/index.html b/v1.63/index.html index 6f70f20372..365f0eabf5 100644 --- a/v1.63/index.html +++ b/v1.63/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.63/jwt.html b/v1.63/jwt.html index 2f43b478c5..5ea021abfb 100644 --- a/v1.63/jwt.html +++ b/v1.63/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.63/log_contexts.html b/v1.63/log_contexts.html index 1e636c4844..5d9c787f4c 100644 --- a/v1.63/log_contexts.html +++ b/v1.63/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.63/manhole.html b/v1.63/manhole.html index df14e88bd3..0cc90e1417 100644 --- a/v1.63/manhole.html +++ b/v1.63/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.63/media_repository.html b/v1.63/media_repository.html index 188303ee7f..2dca3dab21 100644 --- a/v1.63/media_repository.html +++ b/v1.63/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.63/message_retention_policies.html b/v1.63/message_retention_policies.html index c7e44629fc..7f5e489a9c 100644 --- a/v1.63/message_retention_policies.html +++ b/v1.63/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.63/metrics-howto.html b/v1.63/metrics-howto.html index 02009a33b1..03f9bd2378 100644 --- a/v1.63/metrics-howto.html +++ b/v1.63/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.63/modules/account_data_callbacks.html b/v1.63/modules/account_data_callbacks.html index 69e04ab3b5..203b07e237 100644 --- a/v1.63/modules/account_data_callbacks.html +++ b/v1.63/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.63/modules/account_validity_callbacks.html b/v1.63/modules/account_validity_callbacks.html index fc0aef2946..e72c8eaa21 100644 --- a/v1.63/modules/account_validity_callbacks.html +++ b/v1.63/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.63/modules/background_update_controller_callbacks.html b/v1.63/modules/background_update_controller_callbacks.html index 3e4ebfb3d8..b4533b0dfb 100644 --- a/v1.63/modules/background_update_controller_callbacks.html +++ b/v1.63/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.63/modules/index.html b/v1.63/modules/index.html index c5b7441f06..657914b55e 100644 --- a/v1.63/modules/index.html +++ b/v1.63/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.63/modules/password_auth_provider_callbacks.html b/v1.63/modules/password_auth_provider_callbacks.html index 77594acf6d..d92372f4e9 100644 --- a/v1.63/modules/password_auth_provider_callbacks.html +++ b/v1.63/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.63/modules/porting_legacy_module.html b/v1.63/modules/porting_legacy_module.html index b6b9a4c73c..f67243f377 100644 --- a/v1.63/modules/porting_legacy_module.html +++ b/v1.63/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.63/modules/presence_router_callbacks.html b/v1.63/modules/presence_router_callbacks.html index e0e799c05e..888c0b7d4b 100644 --- a/v1.63/modules/presence_router_callbacks.html +++ b/v1.63/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.63/modules/spam_checker_callbacks.html b/v1.63/modules/spam_checker_callbacks.html index 49cb139492..ba1987c14f 100644 --- a/v1.63/modules/spam_checker_callbacks.html +++ b/v1.63/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.63/modules/third_party_rules_callbacks.html b/v1.63/modules/third_party_rules_callbacks.html index 936ef7eeaf..8e23c8254e 100644 --- a/v1.63/modules/third_party_rules_callbacks.html +++ b/v1.63/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.63/modules/writing_a_module.html b/v1.63/modules/writing_a_module.html index ea887b0d7d..242586bb4b 100644 --- a/v1.63/modules/writing_a_module.html +++ b/v1.63/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.63/openid.html b/v1.63/openid.html index e068fd33dc..f59d5bcccc 100644 --- a/v1.63/openid.html +++ b/v1.63/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.63/opentracing.html b/v1.63/opentracing.html index 15605862b7..38a4f7ab0e 100644 --- a/v1.63/opentracing.html +++ b/v1.63/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.63/other/running_synapse_on_single_board_computers.html b/v1.63/other/running_synapse_on_single_board_computers.html index 256b512edb..67b9a8cc28 100644 --- a/v1.63/other/running_synapse_on_single_board_computers.html +++ b/v1.63/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.63/password_auth_providers.html b/v1.63/password_auth_providers.html index 77dbafca9c..632508d171 100644 --- a/v1.63/password_auth_providers.html +++ b/v1.63/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.63/postgres.html b/v1.63/postgres.html index d81498c566..4534e67bf4 100644 --- a/v1.63/postgres.html +++ b/v1.63/postgres.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

    @@ -393,5 +406,7 @@ successfully.

    + + - \ No newline at end of file + diff --git a/v1.63/print.html b/v1.63/print.html index 914e5e569f..0780975d0b 100644 --- a/v1.63/print.html +++ b/v1.63/print.html @@ -29,6 +29,7 @@ + @@ -104,6 +105,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

    @@ -16545,10 +16558,12 @@ admin@homeserver:~$ sudo --user postgres psql matrix-synapse --command 'select c + + - \ No newline at end of file + diff --git a/v1.63/replication.html b/v1.63/replication.html index 076a020005..7f8464d2c5 100644 --- a/v1.63/replication.html +++ b/v1.63/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.63/reverse_proxy.html b/v1.63/reverse_proxy.html index a2fe5714b9..54d4e892ea 100644 --- a/v1.63/reverse_proxy.html +++ b/v1.63/reverse_proxy.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

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

    + + - \ No newline at end of file + diff --git a/v1.63/room_and_user_statistics.html b/v1.63/room_and_user_statistics.html index 2c5b298976..6c0b3fa86d 100644 --- a/v1.63/room_and_user_statistics.html +++ b/v1.63/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.63/server_notices.html b/v1.63/server_notices.html index f003e583b2..f7c45305e6 100644 --- a/v1.63/server_notices.html +++ b/v1.63/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.63/setup/forward_proxy.html b/v1.63/setup/forward_proxy.html index 3814741c93..f54f48c994 100644 --- a/v1.63/setup/forward_proxy.html +++ b/v1.63/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.63/setup/installation.html b/v1.63/setup/installation.html index fec09fc441..9051568b11 100644 --- a/v1.63/setup/installation.html +++ b/v1.63/setup/installation.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

    @@ -592,5 +605,7 @@ failing, e.g.:

    + + - \ No newline at end of file + diff --git a/v1.63/sso_mapping_providers.html b/v1.63/sso_mapping_providers.html index 85254b4985..4a72f5bb67 100644 --- a/v1.63/sso_mapping_providers.html +++ b/v1.63/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.63/structured_logging.html b/v1.63/structured_logging.html index dd98e65e09..14de515d80 100644 --- a/v1.63/structured_logging.html +++ b/v1.63/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.63/synctl_workers.html b/v1.63/synctl_workers.html index b8358e24cb..29a81b6b50 100644 --- a/v1.63/synctl_workers.html +++ b/v1.63/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.63/systemd-with-workers/index.html b/v1.63/systemd-with-workers/index.html index 70dd92e9f7..e200206b11 100644 --- a/v1.63/systemd-with-workers/index.html +++ b/v1.63/systemd-with-workers/index.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

    @@ -278,5 +291,7 @@ the changes being applied at a glance.

    + + - \ No newline at end of file + diff --git a/v1.63/tcp_replication.html b/v1.63/tcp_replication.html index 18c678b53c..2a1c5aff81 100644 --- a/v1.63/tcp_replication.html +++ b/v1.63/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.63/templates.html b/v1.63/templates.html index c15420b7d4..0323eb1551 100644 --- a/v1.63/templates.html +++ b/v1.63/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.63/turn-howto.html b/v1.63/turn-howto.html index 62ae159278..14486dd06b 100644 --- a/v1.63/turn-howto.html +++ b/v1.63/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.63/upgrade.html b/v1.63/upgrade.html index fd99669f9c..791786cdd2 100644 --- a/v1.63/upgrade.html +++ b/v1.63/upgrade.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

    @@ -1730,5 +1743,7 @@ in the local HS will automatically rejoin the room.

    + + - \ No newline at end of file + diff --git a/v1.63/usage/administration/admin_api/background_updates.html b/v1.63/usage/administration/admin_api/background_updates.html index 95fbd5aaf4..8bcb6bfd3e 100644 --- a/v1.63/usage/administration/admin_api/background_updates.html +++ b/v1.63/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.63/usage/administration/admin_api/federation.html b/v1.63/usage/administration/admin_api/federation.html index f8edb4d29e..06330b8ad8 100644 --- a/v1.63/usage/administration/admin_api/federation.html +++ b/v1.63/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.63/usage/administration/admin_api/index.html b/v1.63/usage/administration/admin_api/index.html index 520cd84a05..2a5a0a300d 100644 --- a/v1.63/usage/administration/admin_api/index.html +++ b/v1.63/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.63/usage/administration/admin_api/registration_tokens.html b/v1.63/usage/administration/admin_api/registration_tokens.html index 1a421f07d1..4c3e600e96 100644 --- a/v1.63/usage/administration/admin_api/registration_tokens.html +++ b/v1.63/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.63/usage/administration/admin_faq.html b/v1.63/usage/administration/admin_faq.html index a0f7e3f5cb..356d414149 100644 --- a/v1.63/usage/administration/admin_faq.html +++ b/v1.63/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.63/usage/administration/database_maintenance_tools.html b/v1.63/usage/administration/database_maintenance_tools.html index 4fb8965e86..f4043bf6e0 100644 --- a/v1.63/usage/administration/database_maintenance_tools.html +++ b/v1.63/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.63/usage/administration/index.html b/v1.63/usage/administration/index.html index 402708e6a0..bd6f7a1d90 100644 --- a/v1.63/usage/administration/index.html +++ b/v1.63/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.63/usage/administration/monitoring/reporting_homeserver_usage_statistics.html b/v1.63/usage/administration/monitoring/reporting_homeserver_usage_statistics.html index f0504e3f99..8733f3d690 100644 --- a/v1.63/usage/administration/monitoring/reporting_homeserver_usage_statistics.html +++ b/v1.63/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.63/usage/administration/request_log.html b/v1.63/usage/administration/request_log.html index 8fcebfa53b..89a5aa2be7 100644 --- a/v1.63/usage/administration/request_log.html +++ b/v1.63/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.63/usage/administration/state_groups.html b/v1.63/usage/administration/state_groups.html index 5dad270edd..79ba656baa 100644 --- a/v1.63/usage/administration/state_groups.html +++ b/v1.63/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.63/usage/administration/understanding_synapse_through_grafana_graphs.html b/v1.63/usage/administration/understanding_synapse_through_grafana_graphs.html index e99b55b8ec..f65ca66a3f 100644 --- a/v1.63/usage/administration/understanding_synapse_through_grafana_graphs.html +++ b/v1.63/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.63/usage/administration/useful_sql_for_admins.html b/v1.63/usage/administration/useful_sql_for_admins.html index 0d3a11fff8..0bde5f2f6b 100644 --- a/v1.63/usage/administration/useful_sql_for_admins.html +++ b/v1.63/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.63/usage/configuration/config_documentation.html b/v1.63/usage/configuration/config_documentation.html index 5abd69fd39..d23424bb78 100644 --- a/v1.63/usage/configuration/config_documentation.html +++ b/v1.63/usage/configuration/config_documentation.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

    @@ -3344,5 +3357,7 @@ Set a size to change the default. + + - \ No newline at end of file + diff --git a/v1.63/usage/configuration/homeserver_sample_config.html b/v1.63/usage/configuration/homeserver_sample_config.html index 7a22b27d32..d52746f112 100644 --- a/v1.63/usage/configuration/homeserver_sample_config.html +++ b/v1.63/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.63/usage/configuration/index.html b/v1.63/usage/configuration/index.html index a9739343d6..886371378e 100644 --- a/v1.63/usage/configuration/index.html +++ b/v1.63/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.63/usage/configuration/logging_sample_config.html b/v1.63/usage/configuration/logging_sample_config.html index 8cb9236ae4..4b4b766b70 100644 --- a/v1.63/usage/configuration/logging_sample_config.html +++ b/v1.63/usage/configuration/logging_sample_config.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

    @@ -271,5 +284,7 @@ disable_existing_loggers: false + + - \ No newline at end of file + diff --git a/v1.63/usage/configuration/user_authentication/index.html b/v1.63/usage/configuration/user_authentication/index.html index e53774b336..57ac45cc1e 100644 --- a/v1.63/usage/configuration/user_authentication/index.html +++ b/v1.63/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.63/usage/configuration/user_authentication/refresh_tokens.html b/v1.63/usage/configuration/user_authentication/refresh_tokens.html index eb359e858b..d8f1107cdc 100644 --- a/v1.63/usage/configuration/user_authentication/refresh_tokens.html +++ b/v1.63/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.63/usage/configuration/user_authentication/single_sign_on/cas.html b/v1.63/usage/configuration/user_authentication/single_sign_on/cas.html index 40def1f25c..5c3cca28de 100644 --- a/v1.63/usage/configuration/user_authentication/single_sign_on/cas.html +++ b/v1.63/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.63/usage/configuration/user_authentication/single_sign_on/index.html b/v1.63/usage/configuration/user_authentication/single_sign_on/index.html index 41fbcb0400..759556f5e9 100644 --- a/v1.63/usage/configuration/user_authentication/single_sign_on/index.html +++ b/v1.63/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.63/usage/configuration/user_authentication/single_sign_on/saml.html b/v1.63/usage/configuration/user_authentication/single_sign_on/saml.html index 4f461fda46..ca20f7a3a5 100644 --- a/v1.63/usage/configuration/user_authentication/single_sign_on/saml.html +++ b/v1.63/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.63/user_directory.html b/v1.63/user_directory.html index 10d25eaa65..4721bb91a5 100644 --- a/v1.63/user_directory.html +++ b/v1.63/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.63/website_files/theme/index.hbs b/v1.63/website_files/theme/index.hbs index 3b7a5b6163..b169323a43 100644 --- a/v1.63/website_files/theme/index.hbs +++ b/v1.63/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.63/website_files/version-picker.css b/v1.63/website_files/version-picker.css new file mode 100644 index 0000000000..28e5d5219a --- /dev/null +++ b/v1.63/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.63/website_files/version-picker.js b/v1.63/website_files/version-picker.js new file mode 100644 index 0000000000..bb35a7d896 --- /dev/null +++ b/v1.63/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.63/website_files/version.js b/v1.63/website_files/version.js new file mode 100644 index 0000000000..0594b5c438 --- /dev/null +++ b/v1.63/website_files/version.js @@ -0,0 +1 @@ +window.SYNAPSE_VERSION = 'v1.63'; diff --git a/v1.63/welcome_and_overview.html b/v1.63/welcome_and_overview.html index 6f70f20372..365f0eabf5 100644 --- a/v1.63/welcome_and_overview.html +++ b/v1.63/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.63/workers.html b/v1.63/workers.html index fbe1d0d393..2995f63a91 100644 --- a/v1.63/workers.html +++ b/v1.63/workers.html @@ -28,6 +28,7 @@ + @@ -103,6 +104,18 @@ +
    +
    +
    + + +
    + +
      + +
    +
    +

    Synapse

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

    + + - \ No newline at end of file +