From 76a265f9a1b9024810f2e67cdff09786a6dfc01a Mon Sep 17 00:00:00 2001 From: Slavi Pantaleev Date: Sat, 3 Feb 2024 08:05:52 +0200 Subject: [PATCH] Document new base-domain root-path redirection behavior --- CHANGELOG.md | 11 +++++++++++ docs/configuring-playbook-base-domain-serving.md | 4 ++++ 2 files changed, 15 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 0e8ece22b..7a9473760 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,14 @@ +# 2024-01-31 + +## (Backward-compatibility break) Minor changes necessary for some people serving a static website at the base domain + +This only affects people who are [Serving a static website at the base domain](./docs/configuring-playbook-base-domain-serving.md#serving-a-static-website-at-the-base-domain), but not managing its `index.html` through the playbook. + +That is, for people who have `matrix_static_files_file_index_html_enabled: false` in their `vars.yml` configuration, the playbook has a new default behavior. Since the playbook is not managing the `index.html` file, it will default to a more sensible way of handling the base domain - redirecting `https://DOMAIN/` to `https://matrix.DOMAIN/`, instead of serving a 404 page. + +If you are managing your static website by yourself (by dropping files into `/matrix/static-files/public` somehow), then you probably don't wish for such redirection to happen. You can disable it by adding `matrix_static_files_container_labels_base_domain_enabled: false` to your `vars.yml` configuration file. + + # 2024-01-20 ## Support for more efficient (specialized) Synapse workers diff --git a/docs/configuring-playbook-base-domain-serving.md b/docs/configuring-playbook-base-domain-serving.md index f1cf992d1..d070abc59 100644 --- a/docs/configuring-playbook-base-domain-serving.md +++ b/docs/configuring-playbook-base-domain-serving.md @@ -42,6 +42,10 @@ matrix_static_files_container_labels_base_domain_enabled: true # Prevent the default index.html file from being installed matrix_static_files_file_index_html_enabled: false + +# Disable the automatic redirectin of `https://DOMAIN/` to `https://matrix.DOMAIN/`. +# This gets automatically enabled when you disable `matrix_static_files_file_index_html_enabled`, as we're doing above. +matrix_static_files_container_labels_base_domain_enabled: false ``` With this configuration, Ansible will no longer mess around with the `/matrix/static-files/public/index.html` file.