From 13346030f302ba5a55cec530b0d38d3b47f26d5a Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Tue, 14 Jan 2025 22:50:47 +0900 Subject: [PATCH] Update docs for Cinny and Dimension: adopt the common note Signed-off-by: Suguru Hirahara --- docs/configuring-playbook-client-cinny.md | 5 ++++- docs/configuring-playbook-dimension.md | 2 +- 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/docs/configuring-playbook-client-cinny.md b/docs/configuring-playbook-client-cinny.md index 63f47c3c4..de1bd6324 100644 --- a/docs/configuring-playbook-client-cinny.md +++ b/docs/configuring-playbook-client-cinny.md @@ -31,11 +31,14 @@ Example additional configuration for your `vars.yml` file: ```yaml # Switch to a different domain (`app.example.com`) than the default one (`cinny.example.com`) matrix_client_cinny_hostname: "app.{{ matrix_domain }}" + +# Expose under the /cinny subpath +# matrix_client_cinny_path_prefix: /cinny ``` After changing the domain, **you may need to adjust your DNS** records to point the Cinny domain to the Matrix server. -**Note**: while a `matrix_client_cinny_path_prefix` variable exists for tweaking the path-prefix, it's [not supported anymore](https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/3701), because Cinny requires an application rebuild (with a tweaked build config) to be functional under a custom path. +**Note**: while there is a `matrix_client_cinny_path_prefix` variable for changing the path where Cinny is served, overriding it is [not possible](https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/3701), because Cinny requires an application rebuild (with a tweaked build config) to be functional under a custom path. You'd need to serve Cinny at a dedicated subdomain. ## Installing diff --git a/docs/configuring-playbook-dimension.md b/docs/configuring-playbook-dimension.md index 716b4ddcd..7d1c0ce3f 100644 --- a/docs/configuring-playbook-dimension.md +++ b/docs/configuring-playbook-dimension.md @@ -83,7 +83,7 @@ After changing the domain, **you may need to adjust your DNS** records to point If you've decided to reuse the `matrix.` domain, you won't need to do any extra DNS configuration. -**Note**: While there is a `matrix_dimension_path_prefix` variable for changing the path where Dimension is served, overriding it is not possible due to [this Dimension issue](https://github.com/turt2live/matrix-dimension/issues/510). You must serve Dimension at a dedicated subdomain. +**Note**: while there is a `matrix_dimension_path_prefix` variable for changing the path where Dimension is served, overriding it is not possible due to [this Dimension issue](https://github.com/turt2live/matrix-dimension/issues/510). You'd need to serve Dimension at a dedicated subdomain. ## Installing