matrix-docker-ansible-deploy/docs/configuring-playbook-synapse-auto-accept-invite.md
Suguru Hirahara 6995f3990e
Edit line breaks in sentences and paragraphs
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-23 01:13:23 +09:00

2.7 KiB

Setting up Synapse Auto Invite Accept (optional)

The playbook can install and configure synapse-auto-invite-accept for you.

See that project's documentation to learn what it does and why it might be useful to you. In short, it automatically accepts room invites. You can specify that only 1:1 room invites are auto-accepted. Defaults to false if not specified.

Note: Synapse v1.109.0, the same feature has been merged into Synapse (see the Native alternative section below). You'd better use the native feature, instead of the synapse-auto-invite-accept 3rd party module.

Configuration

If you decide that you'd like to let this playbook install the [synapse-auto-invite-accept](https://github.com/matrix-org/synapse-auto-accept-invite module for you, add the following configuration to your inventory/host_vars/matrix.example.com/vars.yml file:

matrix_synapse_ext_synapse_auto_accept_invite_enabled: true

matrix_synapse_ext_synapse_auto_accept_invite_accept_invites_only_direct_messages: true

Synapse worker deployments

In a workerized Synapse deployment it is possible to run this module on a worker to reduce the load on the main process (Default is null). For example, add this to your configuration:

matrix_synapse_ext_synapse_auto_accept_invite_worker_to_run_on: 'matrix-synapse-worker-generic-0'

There might be an issue with federation.

Native alternative

Since Synapse v1.109.0, the functionality provided by the synapse-auto-invite-accept 3rd party module has been made part of Synapse.

Here's example configuration for using the native Synapse feature:

matrix_synapse_auto_accept_invites_enabled: true

# Default settings below. Uncomment and adjust this part if necessary.
# matrix_synapse_auto_accept_invites_only_for_direct_messages: false
# matrix_synapse_auto_accept_invites_only_from_local_users: false

# If workers are enabled, you may delegate usage to a specific worker.
# matrix_synapse_auto_accept_invites_worker_to_run_on: 'matrix-synapse-worker-generic-0'