matrix-docker-ansible-deploy/docs/configuring-playbook-federation.md
Slavi Pantaleev 733b806833 Annotate certain features as optional/advanced
We've had some people get confused into installing
Matrix Corporal and having pain with that.

With this documentation change, we try to make it clearer
that it's an advanced feature not to be touched unless
you know what you're doing.

On a similar note, we also make sure other things are properly
labeled as "(optional)" and/or "(advanced)".
2018-11-26 07:23:42 +02:00

984 B

Controlling Matrix federation (optional)

By default, your server federates with the whole Matrix network. That is, people on your server can communicate with people on any other Matrix server.

Federating only with select servers

To make your server only federate with servers of your choosing, add this to your configuration file (inventory/matrix.<your-domain>/vars.yml):

matrix_synapse_federation_domain_whitelist:
- example.com
- another.com

If you wish to disable federation, you can do that with an empty list ([]), or better yet by completely disabling federation (see below).

Disabling federation

To completely disable federation, isolating your server from the rest of the Matrix network, add this to your configuration file (inventory/matrix.<your-domain>/vars.yml):

matrix_synapse_federation_enabled: false

With that, your server's users will only be able to talk among themselves, but not to anyone who is on another server.