matrix-docker-ansible-deploy/docs/configuring-playbook-pantalaimon.md

Setting up Pantalaimon (E2EE aware proxy daemon) (optional)

The playbook can install and configure the pantalaimon E2EE aware proxy daemon for you.

See the project's documentation to learn what it does and why it might be useful to you.

This role exposes Pantalaimon's API only within the container network, so bots and clients installed on the same machine can use it. In particular the Draupnir and Mjolnir roles (and possibly others) can use it.

Adjusting the playbook configuration

Add the following configuration to your inventory/host_vars/matrix.example.com/vars.yml file (adapt to your needs):

matrix_pantalaimon_enabled: true

Extending the configuration

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

Take a look at:

• roles/custom/matrix-pantalaimon/defaults/main.yml for some variables that you can customize via your vars.yml file. You can override settings (even those that don't have dedicated playbook variables) using the matrix_pantalaimon_configuration variable

Installing

After configuring the playbook, run it 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-pantalaimon.

The default logging level for this component is Warning. If you want to increase the verbosity, add the following configuration to your vars.yml file and re-run the playbook:

# Pantalaimon log level, case-insensitive (Error, Warning, Info, Debug)
matrix_pantalaimon_log_level: Debug