From 913675c0a2cf56ce24db0e6006c7e67baa7fd6fb Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Sun, 13 Oct 2024 03:18:59 +0900 Subject: [PATCH] Update documentation for Cinny and Hydrogen Add "DNS", "Adjusting the playbook configuration", and "Installing" sections Signed-off-by: Suguru Hirahara --- docs/configuring-playbook-client-cinny.md | 22 +++++++++++++------- docs/configuring-playbook-client-hydrogen.md | 22 +++++++++++++------- 2 files changed, 30 insertions(+), 14 deletions(-) diff --git a/docs/configuring-playbook-client-cinny.md b/docs/configuring-playbook-client-cinny.md index da2175311..a3db9bc4c 100644 --- a/docs/configuring-playbook-client-cinny.md +++ b/docs/configuring-playbook-client-cinny.md @@ -4,18 +4,26 @@ This playbook can install the [cinny](https://github.com/ajbura/cinny) Matrix we Cinny is a web client focusing primarily on simple, elegant and secure interface. Cinny can be installed alongside or instead of Element. -If you'd like Cinny to be installed, add the following to your configuration file (`inventory/host_vars/matrix./vars.yml`): +## DNS -```yaml -matrix_client_cinny_enabled: true -``` - -You will also need to add a DNS record so that Cinny can be accessed. +You need to add a `cinny.DOMAIN` DNS record so that Cinny can be accessed. By default Cinny will use https://cinny.DOMAIN so you will need to create an CNAME record for `cinny`. See [Configuring DNS](configuring-dns.md). -If you would like to use a different domain, add the following to your configuration file (changing it to use your preferred domain): +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_cinny: "app.{{ matrix_domain }}" ``` + +## Adjusting the playbook configuration + +To enable Cinny, add the following configuration to your `inventory/host_vars/matrix.DOMAIN/vars.yml` file: + +```yaml +matrix_client_cinny_enabled: true +``` + +## Installing + +After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all` diff --git a/docs/configuring-playbook-client-hydrogen.md b/docs/configuring-playbook-client-hydrogen.md index 3ed4be44a..c840efad9 100644 --- a/docs/configuring-playbook-client-hydrogen.md +++ b/docs/configuring-playbook-client-hydrogen.md @@ -4,18 +4,26 @@ This playbook can install the [Hydrogen](https://github.com/element-hq/hydrogen- Hydrogen is a lightweight web client that supports mobile and legacy web browsers. Hydrogen can be installed alongside or instead of Element. -If you'd like Hydrogen to be installed, add the following to your configuration file (`inventory/host_vars/matrix./vars.yml`): +## DNS -```yaml -matrix_client_hydrogen_enabled: true -``` - -You will also need to add a DNS record so that Hydrogen can be accessed. +You need to add a `hydrogen.DOMAIN` DNS record so that Hydrogen can be accessed. By default Hydrogen will use https://hydrogen.DOMAIN so you will need to create an CNAME record for `hydrogen`. See [Configuring DNS](configuring-dns.md). -If you would like to use a different domain, add the following to your configuration file (changing it to use your preferred domain): +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_hydrogen: "helium.{{ matrix_domain }}" ``` + +## Adjusting the playbook configuration + +To enable Hydrogen, add the following configuration to your `inventory/host_vars/matrix.DOMAIN/vars.yml` file: + +```yaml +matrix_client_hydrogen_enabled: true +``` + +## Installing + +After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all`