Add "DNS", "Adjusting the playbook configuration", and "Installing" sections Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>pull/3597/head
| @@ -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 is a web client focusing primarily on simple, elegant and secure interface. | ||||
| Cinny can be installed alongside or instead of Element. | 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.<your-domain>/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 | 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). | 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 | ```yaml | ||||
| matrix_server_fqn_cinny: "app.{{ matrix_domain }}" | 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` | |||||
| @@ -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 is a lightweight web client that supports mobile and legacy web browsers. | ||||
| Hydrogen can be installed alongside or instead of Element. | 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.<your-domain>/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 | 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). | 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 | ```yaml | ||||
| matrix_server_fqn_hydrogen: "helium.{{ matrix_domain }}" | 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` | |||||