finallycoffee/matrix-docker-ansible-deploy
finallycoffee/matrix-docker-ansible-deploy
5
1
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Document new base-domain root-path redirection behavior

Browse Source
This commit is contained in:
Slavi Pantaleev 2024-02-03 08:05:52 +02:00
parent 6e2bcc7932
commit 76a265f9a1
2 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
CHANGELOG.md
View File

@ -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 # 2024-01-20
## Support for more efficient (specialized) Synapse workers ## Support for more efficient (specialized) Synapse workers

4
docs/configuring-playbook-base-domain-serving.md
View File

@ -42,6 +42,10 @@ matrix_static_files_container_labels_base_domain_enabled: true
# Prevent the default index.html file from being installed # Prevent the default index.html file from being installed
matrix_static_files_file_index_html_enabled: false 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. With this configuration, Ansible will no longer mess around with the `/matrix/static-files/public/index.html` file.