From 3c34418ebef049d5ceeac49af549f03121c8b89f Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Fri, 8 Nov 2024 13:04:51 +0900 Subject: [PATCH] Edit the note about "matrix_homeserver_implementation" variable Since a casual user might want to try another homeserver than Synapse without thinking about its consequence, it is important to clarify that it is not possible to switch homeservers once specified. Signed-off-by: Suguru Hirahara --- examples/vars.yml | 4 ++++ roles/custom/matrix-base/defaults/main.yml | 2 +- 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/examples/vars.yml b/examples/vars.yml index ff898d34b..45c631f14 100644 --- a/examples/vars.yml +++ b/examples/vars.yml @@ -13,6 +13,10 @@ matrix_domain: example.com # See: # - `roles/custom/matrix-base/defaults/main.yml` for valid options # - the `docs/configuring-playbook-IMPLEMENTATION_NAME.md` documentation page, if one is available for your implementation choice +# +# By default, we use Synapse, because it's the only full-featured Matrix server at the moment. +# +# Note that the homeserver implementation of a server will not be able to be changed without data loss. matrix_homeserver_implementation: synapse # A secret used as a base, for generating various other secrets. diff --git a/roles/custom/matrix-base/defaults/main.yml b/roles/custom/matrix-base/defaults/main.yml index 8fff9e053..13d52ced2 100644 --- a/roles/custom/matrix-base/defaults/main.yml +++ b/roles/custom/matrix-base/defaults/main.yml @@ -54,7 +54,7 @@ matrix_homeserver_enabled: true # By default, we use Synapse, because it's the only full-featured Matrix server at the moment. # # This value automatically influences other variables (`matrix_synapse_enabled`, `matrix_dendrite_enabled`, etc.). -# The homeserver implementation of an existing server cannot be changed without data loss. +# Note that the homeserver implementation of a server will not be able to be changed without data loss. matrix_homeserver_implementation: synapse # This contains a secret, which is used for generating various other secrets later on.