2021-05-21 09:43:04 +00:00
# Configuring Hydrogen (optional)
2023-12-15 10:18:18 +00:00
This playbook can install the [Hydrogen ](https://github.com/element-hq/hydrogen-web ) Matrix web client for you.
2024-10-19 07:55:58 +00:00
Hydrogen is a lightweight web client that supports mobile and legacy web browsers. It can be installed alongside or instead of Element.
2021-05-21 09:43:04 +00:00
2024-10-20 20:07:51 +00:00
## Adjusting the playbook configuration
2021-05-21 09:43:04 +00:00
2024-10-20 20:07:51 +00:00
To enable Hydrogen, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:
2021-05-21 09:43:04 +00:00
```yaml
2024-10-20 20:07:51 +00:00
matrix_client_hydrogen_enabled: true
2021-05-21 09:43:04 +00:00
```
2024-10-12 18:18:59 +00:00
2024-10-20 20:07:51 +00:00
### Adjusting the Hydrogen URL
2024-10-12 18:18:59 +00:00
2024-10-20 20:07:51 +00:00
By default, this playbook installs Hydrogen on the `hydrogen.` subdomain (`hydrogen.example.com`) and requires you to [adjust your DNS records ](#adjusting-dns-records ).
By tweaking the `matrix_client_hydrogen_hostname` and `matrix_client_hydrogen_path_prefix` variables, you can easily make the service available at a **different hostname and/or path** than the default one.
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-20 20:07:51 +00:00
# Switch to the domain used for Matrix services (`matrix.example.com`),
# so we won't need to add additional DNS records for Hydrogen.
matrix_client_hydrogen_hostname: "{{ matrix_server_fqn_matrix }}"
# Expose under the /hydrogen subpath
matrix_client_hydrogen_path_prefix: /hydrogen
2024-10-12 18:18:59 +00:00
```
2024-10-20 20:07:51 +00:00
## Adjusting DNS records
Once you've decided on the domain and path, **you may need to adjust your DNS** records to point the Hydrogen domain to the Matrix server.
By default, you will need to create a CNAME record for `hydrogen` . See [Configuring DNS ](configuring-dns.md ) for details about DNS changes.
If you've decided to reuse the `matrix.` domain, you won't need to do any extra DNS configuration.
2024-10-12 18:18:59 +00:00
## Installing
After configuring the playbook, run the [installation ](installing.md ) command: `just install-all` or `just setup-all`