matrix-docker-ansible-deploy/docs/configuring-playbook.md

# Configuring the Ansible playbook

To configure the playbook, you need to have done the following things:

- have a server where Matrix services will run
- [configured your DNS records](configuring-dns.md)
- [retrieved the playbook's source code](getting-the-playbook.md) to your computer

You can then follow these steps inside the playbook directory:

- create a directory to hold your configuration (`mkdir inventory/host_vars/matrix.<your-domain>`)

- copy the sample configuration file (`cp examples/host-vars.yml inventory/host_vars/matrix.<your-domain>/vars.yml`)

- edit the configuration file (`inventory/host_vars/matrix.<your-domain>/vars.yml`) to your liking. You may also take a look at the various `roles/ROLE_NAME_HERE/defaults/main.yml` files and see if there's something you'd like to copy over and override in your `vars.yml` configuration file.

- copy the sample inventory hosts file (`cp examples/hosts inventory/hosts`)

- edit the inventory hosts file (`inventory/hosts`) to your liking


For a basic Matrix installation, that's all you need.
For a more custom setup, see the [Other configuration options](#other-configuration-options) below.

When you're done with all the configuration you'd like to do, continue with [Installing](installing.md).


## Other configuration options

### Additional useful services

- [Setting up the Dimension Integration Manager](configuring-playbook-dimension.md) (optional, but recommended; after [installing](installing.md))


### Core service adjustments

- [Storing Matrix media files on Amazon S3](configuring-playbook-s3.md) (optional)

- [Using an external PostgreSQL server](configuring-playbook-external-postgres.md) (optional)

- [Adjusting mxisd Identity Server configuration](configuring-playbook-mxisd.md) (optional)

- [Adjusting SSL certificate retrieval](configuring-playbook-ssl-certificates.md) (optional, advanced)

- [Serving your base domain using this playbook's nginx server](configuring-playbook-base-domain-serving.md) (optional)

- [Using your own webserver, instead of this playbook's nginx proxy](configuring-playbook-own-webserver.md) (optional, advanced)

- [Adjusting TURN server configuration](configuring-playbook-turn.md) (optional, advanced)


### Server connectivity

- [Enabling Telemetry for your Matrix server](configuring-playbook-telemetry.md) (optional)

- [Controlling Matrix federation](configuring-playbook-federation.md) (optional)

- [Adjusting email-sending settings](configuring-playbook-email.md) (optional)


### Authentication and user-related

- [Setting up the REST authentication password provider module](configuring-playbook-rest-auth.md) (optional, advanced)

- [Setting up the Shared Secret Auth password provider module](configuring-playbook-shared-secret-auth.md) (optional, advanced)

- [Setting up the LDAP password provider module](configuring-playbook-ldap-auth.md) (optional, advanced)

- [Setting up Matrix Corporal](configuring-playbook-matrix-corporal.md) (optional, advanced)


### Bridging other networks

- [Setting up Mautrix Telegram bridging](configuring-playbook-bridge-mautrix-telegram.md) (optional)

- [Setting up Mautrix Whatsapp bridging](configuring-playbook-bridge-mautrix-whatsapp.md) (optional)

- [Setting up Mautrix Facebook bridging](configuring-playbook-bridge-mautrix-facebook.md) (optional)

- [Setting up Appservice IRC bridging](configuring-playbook-bridge-appservice-irc.md) (optional)

- [Setting up Appservice Discord bridging](configuring-playbook-bridge-appservice-discord.md) (optional)

- [Setting up Email2Matrix](configuring-playbook-email2matrix.md) (optional)
Minor wording improvements 6 years ago			`# Configuring the Ansible playbook`
Split README into a bunch of files in docs/ 6 years ago
Improve documentation about getting the playbook 6 years ago			`To configure the playbook, you need to have done the following things:`
Split README into a bunch of files in docs/ 6 years ago
Improve documentation about getting the playbook 6 years ago			`- have a server where Matrix services will run`
			`- [configured your DNS records](configuring-dns.md)`
			`- [retrieved the playbook's source code](getting-the-playbook.md) to your computer`

			`You can then follow these steps inside the playbook directory:`
Split README into a bunch of files in docs/ 6 years ago
			- create a directory to hold your configuration (`mkdir inventory/host_vars/matrix.<your-domain>`)

			- copy the sample configuration file (`cp examples/host-vars.yml inventory/host_vars/matrix.<your-domain>/vars.yml`)

Split playbook into multiple roles As suggested in #63 (Github issue), splitting the playbook's logic into multiple roles will be beneficial for maintainability. This patch realizes this split. Still, some components affect others, so the roles are not really independent of one another. For example: - disabling mxisd (`matrix_mxisd_enabled: false`), causes Synapse and riot-web to reconfigure themselves with other (public) Identity servers. - enabling matrix-corporal (`matrix_corporal_enabled: true`) affects how reverse-proxying (by `matrix-nginx-proxy`) is done, in order to put matrix-corporal's gateway server in front of Synapse We may be able to move away from such dependencies in the future, at the expense of a more complicated manual configuration, but it's probably not worth sacrificing the convenience we have now. As part of this work, the way we do "start components" has been redone now to use a loop, as suggested in #65 (Github issue). This should make restarting faster and more reliable. 6 years ago			- edit the configuration file (`inventory/host_vars/matrix.<your-domain>/vars.yml`) to your liking. You may also take a look at the various `roles/ROLE_NAME_HERE/defaults/main.yml` files and see if there's something you'd like to copy over and override in your `vars.yml` configuration file.
Split README into a bunch of files in docs/ 6 years ago
			- copy the sample inventory hosts file (`cp examples/hosts inventory/hosts`)

			- edit the inventory hosts file (`inventory/hosts`) to your liking


			`For a basic Matrix installation, that's all you need.`
			`For a more custom setup, see the [Other configuration options](#other-configuration-options) below.`

			`When you're done with all the configuration you'd like to do, continue with [Installing](installing.md).`


			`## Other configuration options`

Split additional configuration options in groups It's too many configuration options to keep them in a single list. Trying to put some order. 6 years ago			`### Additional useful services`
Add documentation about Telemetry configuration 6 years ago
Split additional configuration options in groups It's too many configuration options to keep them in a single list. Trying to put some order. 6 years ago			`- [Setting up the Dimension Integration Manager](configuring-playbook-dimension.md) (optional, but recommended; after [installing](installing.md))`
Add support for controlling Matrix federation 6 years ago
Split additional configuration options in groups It's too many configuration options to keep them in a single list. Trying to put some order. 6 years ago
			`### Core service adjustments`
Add email-sending support 6 years ago
Improve wording a bit 6 years ago			`- [Storing Matrix media files on Amazon S3](configuring-playbook-s3.md) (optional)`
Split README into a bunch of files in docs/ 6 years ago
			`- [Using an external PostgreSQL server](configuring-playbook-external-postgres.md) (optional)`

Add mxisd Identity Server support 6 years ago			`- [Adjusting mxisd Identity Server configuration](configuring-playbook-mxisd.md) (optional)`

Add support for 2 more SSL certificate retrieval methods Adds support for managing certificates manually and for having the playbook generate self-signed certificates for you. With this, Let's Encrypt usage is no longer required. Fixes Github issue #50. 6 years ago			`- [Adjusting SSL certificate retrieval](configuring-playbook-ssl-certificates.md) (optional, advanced)`

Add support for serving base domain via matrix-nginx-proxy 6 years ago			`- [Serving your base domain using this playbook's nginx server](configuring-playbook-base-domain-serving.md) (optional)`

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)". 6 years ago			`- [Using your own webserver, instead of this playbook's nginx proxy](configuring-playbook-own-webserver.md) (optional, advanced)`
Add matrix-synapse-rest-auth support 6 years ago
Add TURN server configuration documentation 6 years ago			`- [Adjusting TURN server configuration](configuring-playbook-turn.md) (optional, advanced)`

Split additional configuration options in groups It's too many configuration options to keep them in a single list. Trying to put some order. 6 years ago
			`### Server connectivity`

			`- [Enabling Telemetry for your Matrix server](configuring-playbook-telemetry.md) (optional)`

			`- [Controlling Matrix federation](configuring-playbook-federation.md) (optional)`

			`- [Adjusting email-sending settings](configuring-playbook-email.md) (optional)`


			`### Authentication and user-related`

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)". 6 years ago			`- [Setting up the REST authentication password provider module](configuring-playbook-rest-auth.md) (optional, advanced)`
Add support for matrix-synapse-shared-secret-auth 6 years ago
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)". 6 years ago			`- [Setting up the Shared Secret Auth password provider module](configuring-playbook-shared-secret-auth.md) (optional, advanced)`
Add support for matrix-corporal 6 years ago
Add LDAP auth password provider documentation and changelog description 6 years ago			`- [Setting up the LDAP password provider module](configuring-playbook-ldap-auth.md) (optional, advanced)`

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)". 6 years ago			`- [Setting up Matrix Corporal](configuring-playbook-matrix-corporal.md) (optional, advanced)`
Update README 6 years ago
Split additional configuration options in groups It's too many configuration options to keep them in a single list. Trying to put some order. 6 years ago
			`### Bridging other networks`

Update documentation 6 years ago			`- [Setting up Mautrix Telegram bridging](configuring-playbook-bridge-mautrix-telegram.md) (optional)`

Updated "Controlling Matrix federation" link Missing file ending results in 404 6 years ago			`- [Setting up Mautrix Whatsapp bridging](configuring-playbook-bridge-mautrix-whatsapp.md) (optional)`
Add support for matrix-appservice-irc 6 years ago
Add mautrix-facebook doc 6 years ago			`- [Setting up Mautrix Facebook bridging](configuring-playbook-bridge-mautrix-facebook.md) (optional)`

Add support for matrix-appservice-irc 6 years ago			`- [Setting up Appservice IRC bridging](configuring-playbook-bridge-appservice-irc.md) (optional)`
Add matrix-appservice-discord bridge Bridge is setup to work on the matrix side with this, but the discord invite link is not automatically generated. 6 years ago
			`- [Setting up Appservice Discord bridging](configuring-playbook-bridge-appservice-discord.md) (optional)`
Add Email2Matrix support 5 years ago
			`- [Setting up Email2Matrix](configuring-playbook-email2matrix.md) (optional)`