From 97889d8c339541ed5b135a359e81ae1cbc2f7f28 Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Sun, 13 Oct 2024 03:29:34 +0900 Subject: [PATCH] Update documentation for SchildiChat Add "DNS", "Adjusting the playbook configuration", and "Installing" Signed-off-by: Suguru Hirahara --- ...configuring-playbook-client-schildichat.md | 25 +++++++++++++------ 1 file changed, 18 insertions(+), 7 deletions(-) diff --git a/docs/configuring-playbook-client-schildichat.md b/docs/configuring-playbook-client-schildichat.md index b059d78f4..733901920 100644 --- a/docs/configuring-playbook-client-schildichat.md +++ b/docs/configuring-playbook-client-schildichat.md @@ -6,18 +6,26 @@ SchildiChat can be installed alongside or instead of Element. **WARNING**: SchildiChat Web is based on Element-web, but its releases are lagging behind. As an example (from 2024-02-26), SchildiChat Web is 22 releases behind (it being based on element-web `v1.11.36`, while element-web is now on `v1.11.58`). Element-web frequently suffers from security issues, so running something based on an ancient Element-web release is **dangerous**. Use SchildiChat Web at your own risk! +## DNS -## Enabling SchildiChat +You need to add a `schildichat.DOMAIN` DNS record so that SchildiChat can be accessed. +By default SchildiChat will use https://schildichat.DOMAIN so you will need to create an CNAME record +for `schildichat`. See [Configuring DNS](configuring-dns.md). -If you'd like for the playbook to install SchildiChat, you can enable it in your configuration file (`inventory/host_vars/matrix./vars.yml`): +If you would like to use a different domain, add the following configuration to your `inventory/host_vars/matrix.DOMAIN/vars.yml` file (changing it to use your preferred domain): + +```yaml + matrix_server_fqn_schildichat: "sc.{{ matrix_domain }}" +``` + +## Adjusting the playbook configuration + +To enable SchildiChat, add the following configuration to your `inventory/host_vars/matrix.DOMAIN/vars.yml` file: ```yaml matrix_client_schildichat_enabled: true ``` - -## Configuring SchildiChat settings - The playbook provides some customization variables you could use to change schildichat's settings. Their defaults are defined in [`roles/custom/matrix-client-schildichat/defaults/main.yml`](../roles/custom/matrix-client-schildichat/defaults/main.yml) and they ultimately end up in the generated `/matrix/schildichat/config.json` file (on the server). This file is generated from the [`roles/custom/matrix-client-schildichat/templates/config.json.j2`](../roles/custom/matrix-client-schildichat/templates/config.json.j2) template. @@ -32,8 +40,7 @@ Alternatively, **if there is no pre-defined variable** for an schildichat settin - or, if extending the configuration is still not powerful enough for your needs, you can **override the configuration completely** using `matrix_client_schildichat_configuration_default` (or `matrix_client_schildichat_configuration`). You can find information about this in [`roles/custom/matrix-client-schildichat/defaults/main.yml`](../roles/custom/matrix-client-schildichat/defaults/main.yml). - -## Themes +### Themes To change the look of schildichat, you can define your own themes manually by using the `matrix_client_schildichat_setting_defaults_custom_themes` setting. @@ -42,3 +49,7 @@ Or better yet, you can automatically pull it all themes provided by the [aaronra If you make your own theme, we encourage you to submit it to the **aaronraimist/element-themes** project, so that the whole community could easily enjoy it. Note that for a custom theme to work well, all schildichat instances that you use must have the same theme installed. + +## Installing + +After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all`