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

Setting up Sable (optional)

The playbook can install and configure the Sable Matrix web client for you.

Sable is a web client focusing primarily on simple, elegant and secure interface. It can be installed alongside or instead of Element Web, Cinny and others.

Adjusting DNS records

By default, this playbook installs Sable on the sable. subdomain (sable.example.com) and requires you to create a CNAME record for sable, which targets matrix.example.com.

When setting, replace example.com with your own.

Adjusting the playbook configuration

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

sable_enabled: true

Adjusting the Sable URL (optional)

By tweaking the sable_hostname variable, you can easily make the service available at a different hostname than the default one.

Example additional configuration for your vars.yml file:

# Switch to a different domain (`app.example.com`) than the default one (`sable.example.com`)
sable_hostname: "app.{{ matrix_domain }}"

# Expose under the /sable subpath
# sable_path_prefix: /sable

After changing the domain, you may need to adjust your DNS records to point the Sable domain to the Matrix server.

Note: while there is a sable_path_prefix variable for changing the path where Sable is served, overriding it is not possible, because Sable requires an application rebuild (with a tweaked build config) to be functional under a custom path. You’d need to serve Sable at a dedicated subdomain.

Extending the configuration

There are some additional things you may wish to configure about the component.

Take a look at:

• roles/galaxy/sable/defaults/main.yml for some variables that you can customize via your vars.yml file
• roles/galaxy/sable/templates/config.json.j2 for the component’s default configuration. You can override settings (even those that don’t have dedicated playbook variables) using the sable_configuration_extension_json variable

Installing

After configuring the playbook and adjusting your DNS records, run the playbook with playbook tags as below:

ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start

The shortcut commands with the just program are also available: just install-all or just setup-all

just install-all is useful for maintaining your setup quickly (2x-5x faster than just setup-all) when its components remain unchanged. If you adjust your vars.yml to remove other components, you’d need to run just setup-all, or these components will still remain installed. Note these shortcuts run the ensure-matrix-users-created tag too.

Troubleshooting

As with all other services, you can find the logs in systemd-journald by logging in to the server with SSH and running journalctl -fu matrix-client-sable.