Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>pull/3595/head
| @@ -75,7 +75,7 @@ The `etherpad.<your-domain>` subdomain may be necessary, because this playbook c | |||||
| The `hydrogen.<your-domain>` subdomain may be necessary, because this playbook could install the [Hydrogen](https://github.com/element-hq/hydrogen-web) web client. The installation of Hydrogen is disabled by default, it is not a core required component. To learn how to install it, see our [configuring Hydrogen guide](configuring-playbook-client-hydrogen.md). If you do not wish to set up Hydrogen, feel free to skip the `hydrogen.<your-domain>` DNS record. | The `hydrogen.<your-domain>` subdomain may be necessary, because this playbook could install the [Hydrogen](https://github.com/element-hq/hydrogen-web) web client. The installation of Hydrogen is disabled by default, it is not a core required component. To learn how to install it, see our [configuring Hydrogen guide](configuring-playbook-client-hydrogen.md). If you do not wish to set up Hydrogen, feel free to skip the `hydrogen.<your-domain>` DNS record. | ||||
| The `cinny.<your-domain>` subdomain may be necessary, because this playbook could install the [Cinny](https://github.com/ajbura/cinny) web client. The installation of cinny is disabled by default, it is not a core required component. To learn how to install it, see our [configuring cinny guide](configuring-playbook-client-cinny.md). If you do not wish to set up cinny, feel free to skip the `cinny.<your-domain>` DNS record. | |||||
| The `cinny.<your-domain>` subdomain may be necessary, because this playbook could install the [Cinny](https://github.com/ajbura/cinny) web client. The installation of Cinny is disabled by default, it is not a core required component. To learn how to install it, see our [configuring Cinny guide](configuring-playbook-client-cinny.md). If you do not wish to set up Cinny, feel free to skip the `cinny.<your-domain>` DNS record. | |||||
| The `wsproxy.<your-domain>` subdomain may be necessary, because this playbook could install the [wsproxy](https://github.com/mautrix/wsproxy) web client. The installation of wsproxy is disabled by default, it is not a core required component. To learn how to install it, see our [configuring wsproxy guide](configuring-playbook-bridge-mautrix-wsproxy.md). If you do not wish to set up wsproxy, feel free to skip the `wsproxy.<your-domain>` DNS record. | The `wsproxy.<your-domain>` subdomain may be necessary, because this playbook could install the [wsproxy](https://github.com/mautrix/wsproxy) web client. The installation of wsproxy is disabled by default, it is not a core required component. To learn how to install it, see our [configuring wsproxy guide](configuring-playbook-bridge-mautrix-wsproxy.md). If you do not wish to set up wsproxy, feel free to skip the `wsproxy.<your-domain>` DNS record. | ||||
| @@ -1,17 +1,17 @@ | |||||
| # Configuring Cinny (optional) | # Configuring Cinny (optional) | ||||
| This playbook can install the [cinny](https://github.com/ajbura/cinny) Matrix web client for you. | This playbook can install the [cinny](https://github.com/ajbura/cinny) Matrix web client for you. | ||||
| cinny is a web client focusing primarily on simple, elegant and secure interface. | |||||
| cinny can be installed alongside or instead of Element. | |||||
| 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.<your-domain>/vars.yml`): | |||||
| If you'd like Cinny to be installed, add the following to your configuration file (`inventory/host_vars/matrix.<your-domain>/vars.yml`): | |||||
| ```yaml | ```yaml | ||||
| matrix_client_cinny_enabled: true | matrix_client_cinny_enabled: true | ||||
| ``` | ``` | ||||
| You will also need to add a 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 | |||||
| You will also need to add a 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). | 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 to your configuration file (changing it to use your preferred domain): | ||||
| @@ -141,7 +141,7 @@ matrix_client_cinny_self_check_validate_certificates: true | |||||
| # config.json | # config.json | ||||
| matrix_client_cinny_default_hs_url: "" | matrix_client_cinny_default_hs_url: "" | ||||
| # Default cinny configuration template which covers the generic use case. | |||||
| # Default Cinny configuration template which covers the generic use case. | |||||
| # You can customize it by controlling the various variables inside it. | # You can customize it by controlling the various variables inside it. | ||||
| # | # | ||||
| # For a more advanced customization, you can extend the default (see `matrix_client_cinny_configuration_extension_json`) | # For a more advanced customization, you can extend the default (see `matrix_client_cinny_configuration_extension_json`) | ||||
| @@ -151,7 +151,7 @@ matrix_client_cinny_default_hs_url: "" | |||||
| # This is unlike what it does when looking up YAML template files (no automatic parsing there). | # This is unlike what it does when looking up YAML template files (no automatic parsing there). | ||||
| matrix_client_cinny_configuration_default: "{{ lookup('template', 'templates/config.json.j2') }}" | matrix_client_cinny_configuration_default: "{{ lookup('template', 'templates/config.json.j2') }}" | ||||
| # Your custom JSON configuration for cinny should go to `matrix_client_cinny_configuration_extension_json`. | |||||
| # Your custom JSON configuration for Cinny should go to `matrix_client_cinny_configuration_extension_json`. | |||||
| # This configuration extends the default starting configuration (`matrix_client_cinny_configuration_default`). | # This configuration extends the default starting configuration (`matrix_client_cinny_configuration_default`). | ||||
| # | # | ||||
| # You can override individual variables from the default configuration, or introduce new ones. | # You can override individual variables from the default configuration, or introduce new ones. | ||||
| @@ -162,6 +162,6 @@ matrix_client_cinny_configuration_extension_json: '{}' | |||||
| matrix_client_cinny_configuration_extension: "{{ matrix_client_cinny_configuration_extension_json | from_json if matrix_client_cinny_configuration_extension_json | from_json is mapping else {} }}" | matrix_client_cinny_configuration_extension: "{{ matrix_client_cinny_configuration_extension_json | from_json if matrix_client_cinny_configuration_extension_json | from_json is mapping else {} }}" | ||||
| # Holds the final cinny configuration (a combination of the default and its extension). | |||||
| # Holds the final Cinny configuration (a combination of the default and its extension). | |||||
| # You most likely don't need to touch this variable. Instead, see `matrix_client_cinny_configuration_default`. | # You most likely don't need to touch this variable. Instead, see `matrix_client_cinny_configuration_default`. | ||||
| matrix_client_cinny_configuration: "{{ matrix_client_cinny_configuration_default | combine(matrix_client_cinny_configuration_extension, recursive=True) }}" | matrix_client_cinny_configuration: "{{ matrix_client_cinny_configuration_default | combine(matrix_client_cinny_configuration_extension, recursive=True) }}" | ||||