matrix-docker-ansible-deploy/docs/configuring-playbook-pantalaimon.md
Suguru Hirahara b0127afd0b
Replace "just run-tags install-all/setup-all,start" with "just install-all/setup-all"
Thanks to the tip by Slavi that the overhead of ensure-matrix-users-created is negligible.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-12-01 22:07:53 +09:00

1.8 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.

1. 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.

2. 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 just program are also available: just install-all or just setup-all

just install-all is useful for maintaining your setup quickly 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. For more information about just shortcuts, take a look at this page: Running just commands