2024-10-22 17:36:24 +00:00
# Setting up Cinny (optional)
2022-01-05 16:33:21 +00:00
2024-10-27 02:11:48 +00:00
This playbook can install the [Cinny ](https://github.com/ajbura/cinny ) Matrix web client for you.
2024-10-19 07:55:58 +00:00
Add "Web" to Element and SchildiChat web application (#3755)
* Replace "Element" with "Element Web"
- If Element indicates the web application, then it is changed to Element Web.
- If it indicates clients branded with Element such as Element desktop, web, mobile clients, then it is changed to Element clients.
- If it is combined with location sharing functionality, it is not changed.
with other some changes, including:
- Change "app.element.io" anchor link to "https://github.com/element-hq/element-web" on README.md, following other documentation files
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Replace "SchildiChat" with "SchildiChat Web"
- If SchildiChat indicates the web application, then it is changed to SchildiChat Web.
- If it indicates clients branded with SchildiChat such as SchildiChat desktop, web, mobile clients, then it is changed to SchildiChat clients.
- If it is combined with location sharing functionality, it is not changed.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Rename configuring-playbook-client-schildichat.md to configuring-playbook-client-schildichat-web.md
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Rename configuring-playbook-client-element.md to configuring-playbook-client-element-web.md
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
---------
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
Co-authored-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-07 14:31:26 +00:00
Cinny is a web client focusing primarily on simple, elegant and secure interface. It can be installed alongside or instead of Element Web.
2022-01-05 16:33:21 +00:00
2024-10-20 20:07:51 +00:00
## Adjusting the playbook configuration
2022-01-05 16:33:21 +00:00
2024-10-20 20:07:51 +00:00
To enable Cinny, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:
2022-01-05 16:33:21 +00:00
```yaml
2024-10-20 20:07:51 +00:00
matrix_client_cinny_enabled: true
2022-01-05 16:33:21 +00:00
```
2024-10-12 18:18:59 +00:00
2024-10-20 20:07:51 +00:00
### Adjusting the Cinny URL
2024-10-12 18:18:59 +00:00
2024-10-20 20:07:51 +00:00
By default, this playbook installs Cinny on the `cinny.` subdomain (`cinny.example.com`) and requires you to [adjust your DNS records ](#adjusting-dns-records ).
2024-10-30 07:53:03 +00:00
By tweaking the `matrix_client_cinny_hostname` variable, you can easily make the service available at a **different hostname** than the default one.
While a `matrix_client_cinny_path_prefix` variable exists for tweaking the path-prefix, it's [not supported anymore ](https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/3701 ), because Cinny requires an application rebuild (with a tweaked build config) to be functional under a custom path.
2024-10-20 20:07:51 +00:00
Example additional configuration for your `inventory/host_vars/matrix.example.com/vars.yml` file:
2024-10-12 18:18:59 +00:00
```yaml
2024-10-30 07:53:03 +00:00
# Switch to a different domain (`app.example.com`) than the default one (`cinny.example.com`)
matrix_client_cinny_hostname: "app.{{ matrix_domain }}"
2024-10-12 18:18:59 +00:00
```
2024-10-20 20:07:51 +00:00
## Adjusting DNS records
2024-10-30 07:53:03 +00:00
Once you've decided on the domain, **you may need to adjust your DNS** records to point the Cinny domain to the Matrix server.
2024-10-20 20:07:51 +00:00
By default, you will need to create a CNAME record for `cinny` . See [Configuring DNS ](configuring-dns.md ) for details about DNS changes.
2024-10-30 07:53:03 +00:00
If you've adjusted `matrix_client_cinny_hostname` , you will need to adjust your DNS configuration accordingly.
2024-10-20 20:07:51 +00:00
2024-10-12 18:18:59 +00:00
## Installing
2024-10-30 07:53:03 +00:00
After configuring the playbook and [adjusting your DNS records ](#adjusting-dns-records ), run the [installation ](installing.md ) command: `just install-all` or `just setup-all`