matrix-docker-ansible-deploy/docs/configuring-playbook-synapse-simple-antispam.md
Suguru Hirahara 424e5c6646
Update docs/configuring-playbook-synapse-simple-antispam.md: add the section for installing
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-03-04 20:49:21 +09:00

1.8 KiB

Setting up Synapse Simple Antispam (optional, advanced)

The playbook can install and configure synapse-simple-antispam for you.

It lets you fight invite-spam by automatically blocking invitiations from a list of servers specified by you (blacklisting).

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

Adjusting the playbook configuration

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

matrix_synapse_ext_spam_checker_synapse_simple_antispam_enabled: true

matrix_synapse_ext_spam_checker_synapse_simple_antispam_config_blocked_homeservers:
- example.com
- example.net

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.