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

Configuring Hydrogen (optional)

This playbook can install the Hydrogen Matrix web client for you.

Hydrogen is a lightweight web client that supports mobile and legacy web browsers. It can be installed alongside or instead of Element.

Adjusting the playbook configuration

To enable Hydrogen, add the following configuration to your inventory/host_vars/matrix.example.com/vars.yml file:

matrix_client_hydrogen_enabled: true

Adjusting the Hydrogen URL

By default, this playbook installs Hydrogen on the hydrogen. subdomain (hydrogen.example.com) and requires you to adjust your 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:

# 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

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 for details about DNS changes.

If you've decided to reuse the matrix. domain, you won't need to do any extra DNS configuration.

Installing

After configuring the playbook, run the installation command: just install-all or just setup-all