matrix-docker-ansible-deploy/docs/configuring-playbook-pantalaimon.md
Suguru Hirahara 3dc0e3f5ef
Update docs: adopt common expressions to encourage readers to check projects' documentation
- Replace links to the documentation with ones to projects' README files, if these have been linked to the project directly

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-12-17 18:50:53 +09:00

1.9 KiB

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

The default configuration should suffice. For advanced configuration, you can override the variables documented in the role's defaults.

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.