a2111dece7
* add FluffyChat * capitalization * Update group_vars/matrix_servers Co-authored-by: Slavi Pantaleev <slavi@devture.com> * fix link in readme --------- Co-authored-by: Slavi Pantaleev <slavi@devture.com>
3.1 KiB
Setting up FluffyChat Web (optional)
The playbook can install and configure the FluffyChat Web Matrix client for you.
FluffyChat Web is a cute messenger for Matrix based.
💡 Note: the latest version of FluffyChat Web is also available on the web, hosted by 3rd parties. If you trust giving your credentials to the following 3rd party Single Page Application, you can consider using it from there:
- fluffychat.im, hosted by the FluffyChat developers
Adjusting DNS records
By default, this playbook installs FluffyChat Web on the fluffychat. subdomain (fluffychat.example.com) and requires you to create a CNAME record for fluffychat, which targets matrix.example.com.
When setting, replace example.com with your own.
Adjusting the playbook configuration
To enable FluffyChat Web, add the following configuration to your inventory/host_vars/matrix.example.com/vars.yml file:
matrix_client_fluffychat_enabled: true
Adjusting the FluffyChat Web URL (optional)
By tweaking the matrix_client_fluffychat_hostname and matrix_client_fluffychat_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 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 FluffyChat Web.
matrix_client_fluffychat_hostname: "{{ matrix_server_fqn_matrix }}"
# Expose under the /fluffychat subpath
matrix_client_fluffychat_path_prefix: /fluffychat
After changing the domain, you may need to adjust your DNS records to point the FluffyChat Web domain to the Matrix server.
If you've decided to reuse the matrix. domain, you won't need to do any extra DNS configuration.
Installing
After configuring the playbook and potentially 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-fluffychat.