matrix-docker-ansible-deploy/docs/configuring-playbook-client-hydrogen.md
Suguru Hirahara 913675c0a2
Update documentation for Cinny and Hydrogen
Add "DNS", "Adjusting the playbook configuration", and "Installing" sections

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-13 03:38:55 +09:00

1.1 KiB

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. Hydrogen can be installed alongside or instead of Element.

DNS

You need to add a hydrogen.DOMAIN DNS record so that Hydrogen can be accessed. By default Hydrogen will use https://hydrogen.DOMAIN so you will need to create an CNAME record for hydrogen. See Configuring DNS.

If you would like to use a different domain, add the following configuration to your inventory/host_vars/matrix.DOMAIN/vars.yml file (changing it to use your preferred domain):

 matrix_server_fqn_hydrogen: "helium.{{ matrix_domain }}"

Adjusting the playbook configuration

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

matrix_client_hydrogen_enabled: true

Installing

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