matrix-docker-ansible-deploy/docs/configuring-playbook-client-hydrogen.md

30 lines
1.1 KiB
Markdown
Raw Normal View History

2021-05-21 17:43:04 +08:00
# Configuring Hydrogen (optional)
This playbook can install the [Hydrogen](https://github.com/element-hq/hydrogen-web) Matrix web client for you.
2021-05-21 17:43:04 +08:00
Hydrogen is a lightweight web client that supports mobile and legacy web browsers.
Hydrogen can be installed alongside or instead of Element.
## DNS
2021-05-21 17:43:04 +08:00
You need to add a `hydrogen.example.com` DNS record so that Hydrogen can be accessed.
By default Hydrogen will use https://hydrogen.example.com so you will need to create an CNAME record
for `hydrogen`. See [Configuring DNS](configuring-dns.md).
2021-05-21 17:43:04 +08:00
If you would like to use a different domain, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file (changing it to use your preferred domain):
2021-05-21 17:43:04 +08:00
```yaml
matrix_server_fqn_hydrogen: "helium.{{ matrix_domain }}"
2021-05-21 17:43:04 +08:00
```
## Adjusting the playbook configuration
To enable Hydrogen, add the following configuration to your `inventory/host_vars/matrix.example.com/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`