From 6e36d67e525170e990e2ac35fac8a1cf4fcc79d4 Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Sun, 29 Dec 2024 09:52:40 -0500 Subject: [PATCH] Update docs for Element Web and SchildiChat Web: reorganization Signed-off-by: Suguru Hirahara --- ...configuring-playbook-client-element-web.md | 34 ++++++++++--------- ...iguring-playbook-client-schildichat-web.md | 18 +++++----- 2 files changed, 27 insertions(+), 25 deletions(-) diff --git a/docs/configuring-playbook-client-element-web.md b/docs/configuring-playbook-client-element-web.md index b037bfdc1..2ce3e373a 100644 --- a/docs/configuring-playbook-client-element-web.md +++ b/docs/configuring-playbook-client-element-web.md @@ -7,22 +7,7 @@ By default, this playbook installs the [Element Web](https://github.com/element- - [app.element.io](https://app.element.io/), hosted by [Element](https://element.io/) - [app.etke.cc](https://app.etke.cc/), hosted by [etke.cc](https://etke.cc/) -## Disabling Element Web - -If you'd like for the playbook to not install Element Web (or to uninstall it if it was previously installed), add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file: - -```yaml -matrix_client_element_enabled: false -``` - -## Extending the configuration - -There are some additional things you may wish to configure about the component. - -Take a look at: - -- `roles/custom/matrix-client-element/defaults/main.yml` for some variables that you can customize via your `vars.yml` file -- `roles/custom/matrix-client-element/templates/config.json.j2` for the component's default configuration. You can override settings (even those that don't have dedicated playbook variables) using the `matrix_client_element_configuration_extension_json` variable +## Adjusting the playbook configuration ### Themes @@ -51,6 +36,15 @@ matrix_client_element_hostname: "{{ matrix_server_fqn_matrix }}" matrix_client_element_path_prefix: /element ``` +### Extending the configuration + +There are some additional things you may wish to configure about the component. + +Take a look at: + +- `roles/custom/matrix-client-element/defaults/main.yml` for some variables that you can customize via your `vars.yml` file +- `roles/custom/matrix-client-element/templates/config.json.j2` for the component's default configuration. You can override settings (even those that don't have dedicated playbook variables) using the `matrix_client_element_configuration_extension_json` variable + ## Adjusting DNS records Once you've decided on the domain and path, **you may need to adjust your DNS** records to point the Element Web domain to the Matrix server. @@ -59,6 +53,14 @@ By default, you will need to create a CNAME record for `element`. See [Configuri If you've decided to reuse the `matrix.` domain, you won't need to do any extra DNS configuration. +## Disabling Element Web + +If you'd like for the playbook to not install Element Web (or to uninstall it if it was previously installed), add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file: + +```yaml +matrix_client_element_enabled: false +``` + ## Installing After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below: diff --git a/docs/configuring-playbook-client-schildichat-web.md b/docs/configuring-playbook-client-schildichat-web.md index 9015f8b89..ca9dcbfb4 100644 --- a/docs/configuring-playbook-client-schildichat-web.md +++ b/docs/configuring-playbook-client-schildichat-web.md @@ -16,15 +16,6 @@ To enable SchildiChat Web, add the following configuration to your `inventory/ho matrix_client_schildichat_enabled: true ``` -## Extending the configuration - -There are some additional things you may wish to configure about the component. - -Take a look at: - -- `roles/custom/matrix-client-schildichat/defaults/main.yml` for some variables that you can customize via your `vars.yml` file -- `roles/custom/matrix-client-schildichat/templates/config.json.j2` for the component's default configuration. You can override settings (even those that don't have dedicated playbook variables) using the `matrix_client_schildichat_configuration_extension_json` variable - ### Themes To change the look of SchildiChat Web, you can define your own themes manually by using the `matrix_client_schildichat_setting_defaults_custom_themes` setting. @@ -52,6 +43,15 @@ matrix_client_schildichat_hostname: "{{ matrix_server_fqn_matrix }}" matrix_client_schildichat_path_prefix: /schildichat ``` +### Extending the configuration + +There are some additional things you may wish to configure about the component. + +Take a look at: + +- `roles/custom/matrix-client-schildichat/defaults/main.yml` for some variables that you can customize via your `vars.yml` file +- `roles/custom/matrix-client-schildichat/templates/config.json.j2` for the component's default configuration. You can override settings (even those that don't have dedicated playbook variables) using the `matrix_client_schildichat_configuration_extension_json` variable + ## Adjusting DNS records Once you've decided on the domain and path, **you may need to adjust your DNS** records to point the SchildiChat Web domain to the Matrix server.