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))

- [Setting up the Jitsi video-conferencing platform](configuring-playbook-jitsi.md) (optional)

- [Setting Dynamic DNS](configuring-playbook-dynamic-dns.md) (optional)

### Core service adjustments

- [Configuring Synapse](configuring-playbook-synapse.md) (optional)

- [Configuring Element](configuring-playbook-client-element.md) (optional)

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

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

- [Adjusting ma1sd Identity Server configuration](configuring-playbook-ma1sd.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)

- [Configure Nginx (optional, advanced)](configuring-playbook-nginx.md) (optional, advanced)

- [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 Synapse Admin](configuring-playbook-synapse-admin.md) (optional)

- [Setting up matrix-registration](configuring-playbook-matrix-registration.md) (optional)

- [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 Synapse Simple Antispam](configuring-playbook-synapse-simple-antispam.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 Mautrix Hangouts bridging](configuring-playbook-bridge-mautrix-hangouts.md) (optional)

- [Setting up Mautrix Signal bridging](configuring-playbook-bridge-mautrix-signal.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 Appservice Slack bridging](configuring-playbook-bridge-appservice-slack.md) (optional)

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

- [Setting up MX Puppet Skype bridging](configuring-playbook-bridge-mx-puppet-skype.md) (optional)

- [Setting up MX Puppet Slack bridging](configuring-playbook-bridge-mx-puppet-slack.md) (optional)

- [Setting up MX Puppet Instagram bridging](configuring-playbook-bridge-mx-puppet-instagram.md) (optional)

- [Setting up MX Puppet Twitter bridging](configuring-playbook-bridge-mx-puppet-twitter.md) (optional)

- [Setting up MX Puppet Discord bridging](configuring-playbook-bridge-mx-puppet-discord.md) (optional)

- [Setting up MX Puppet Steam bridging](configuring-playbook-bridge-mx-puppet-steam.md) (optional)

- [Setting up Email2Matrix](configuring-playbook-email2matrix.md) (optional)

- [Setting up Matrix SMS bridging](configuring-playbook-bridge-matrix-bridge-sms.md) (optional)


### Bots

- [Setting up matrix-reminder-bot](configuring-playbook-bot-matrix-reminder-bot.md) (optional)
Minor wording improvements 2018-08-15 09:19:31 +02:00			`# Configuring the Ansible playbook`
Split README into a bunch of files in docs/ 2018-08-08 09:07:02 +02:00
Improve documentation about getting the playbook 2019-03-10 16:02:17 +01:00			`To configure the playbook, you need to have done the following things:`
Split README into a bunch of files in docs/ 2018-08-08 09:07:02 +02:00
Improve documentation about getting the playbook 2019-03-10 16:02:17 +01:00			`- 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/ 2018-08-08 09:07:02 +02:00
			- 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. 2019-01-12 16:53:00 +01:00			- 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/ 2018-08-08 09:07:02 +02:00
			- 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. 2019-04-19 08:54:18 +02:00			`### Additional useful services`
Add documentation about Telemetry configuration 2018-11-01 17:21:38 +01:00
Split additional configuration options in groups It's too many configuration options to keep them in a single list. Trying to put some order. 2019-04-19 08:54:18 +02:00			`- [Setting up the Dimension Integration Manager](configuring-playbook-dimension.md) (optional, but recommended; after [installing](installing.md))`
Add support for controlling Matrix federation 2018-10-25 17:02:04 +02:00
Add Jitsi reference to Configuring Playbook docs page 2020-03-24 17:26:52 +01:00			`- [Setting up the Jitsi video-conferencing platform](configuring-playbook-jitsi.md) (optional)`

Updates to reviewer comments 2020-11-08 02:34:16 +01:00			`- [Setting Dynamic DNS](configuring-playbook-dynamic-dns.md) (optional)`
Split additional configuration options in groups It's too many configuration options to keep them in a single list. Trying to put some order. 2019-04-19 08:54:18 +02:00
			`### Core service adjustments`
Add email-sending support 2018-08-14 13:11:41 +02:00
Make Synapse configuration extensible 2019-08-22 08:49:22 +02:00			`- [Configuring Synapse](configuring-playbook-synapse.md) (optional)`

Riot is now Element Fixes #586 (Github Issue) 2020-07-17 10:31:20 +02:00			`- [Configuring Element](configuring-playbook-client-element.md) (optional)`
Make Riot-web configuration extensible Fixes #71 (Github Issue). 2019-08-25 09:37:05 +02:00
Improve wording a bit 2018-08-08 09:10:16 +02:00			`- [Storing Matrix media files on Amazon S3](configuring-playbook-s3.md) (optional)`
Split README into a bunch of files in docs/ 2018-08-08 09:07:02 +02:00
			`- [Using an external PostgreSQL server](configuring-playbook-external-postgres.md) (optional)`

Replace mxisd with ma1sd in docs, fixing URLs 2020-01-07 19:04:26 +01:00			`- [Adjusting ma1sd Identity Server configuration](configuring-playbook-ma1sd.md) (optional)`
Add mxisd Identity Server support 2018-08-15 09:23:22 +02:00
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. 2018-12-23 10:00:12 +01:00			`- [Adjusting SSL certificate retrieval](configuring-playbook-ssl-certificates.md) (optional, advanced)`

Add support for serving base domain via matrix-nginx-proxy 2019-03-12 21:27:18 +01:00			`- [Serving your base domain using this playbook's nginx server](configuring-playbook-base-domain-serving.md) (optional)`

Fix spelling ngnix -> nginx 2019-10-04 10:07:37 +02:00			`- [Configure Nginx (optional, advanced)](configuring-playbook-nginx.md) (optional, advanced)`
add ngnix-status to config add doc 2019-04-17 13:42:09 +02:00
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 06:23:42 +01:00			`- [Using your own webserver, instead of this playbook's nginx proxy](configuring-playbook-own-webserver.md) (optional, advanced)`
Add matrix-synapse-rest-auth support 2018-08-17 08:02:12 +02:00
Add TURN server configuration documentation 2019-04-19 08:57:41 +02:00			`- [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. 2019-04-19 08:54:18 +02:00
			`### 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`

Add synapse-admin support Fixes #562 (Github Issue) 2020-07-22 07:10:26 +02:00			`- [Setting up Synapse Admin](configuring-playbook-synapse-admin.md) (optional)`

Add matrix-registration support 2020-09-01 12:46:05 +02:00			`- [Setting up matrix-registration](configuring-playbook-matrix-registration.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)". 2018-11-26 06:23:42 +01:00			`- [Setting up the REST authentication password provider module](configuring-playbook-rest-auth.md) (optional, advanced)`
Add support for matrix-synapse-shared-secret-auth 2018-08-20 16:11:55 +02:00
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 06:23:42 +01:00			`- [Setting up the Shared Secret Auth password provider module](configuring-playbook-shared-secret-auth.md) (optional, advanced)`
Add support for matrix-corporal 2018-08-21 12:34:34 +02:00
Add LDAP auth password provider documentation and changelog description 2018-11-28 10:21:03 +01:00			`- [Setting up the LDAP password provider module](configuring-playbook-ldap-auth.md) (optional, advanced)`

Add support for Synapse Simple Antispam Fixes #255 (Github Issue). 2019-09-09 07:13:06 +02:00			`- [Setting up Synapse Simple Antispam](configuring-playbook-synapse-simple-antispam.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)". 2018-11-26 06:23:42 +01:00			`- [Setting up Matrix Corporal](configuring-playbook-matrix-corporal.md) (optional, advanced)`
Update README 2018-09-07 22:35:04 +02:00
Split additional configuration options in groups It's too many configuration options to keep them in a single list. Trying to put some order. 2019-04-19 08:54:18 +02:00
			`### Bridging other networks`

Update documentation 2018-10-26 18:44:58 +02:00			`- [Setting up Mautrix Telegram bridging](configuring-playbook-bridge-mautrix-telegram.md) (optional)`

Updated "Controlling Matrix federation" link Missing file ending results in 404 2018-11-04 00:30:17 +01:00			`- [Setting up Mautrix Whatsapp bridging](configuring-playbook-bridge-mautrix-whatsapp.md) (optional)`
Add support for matrix-appservice-irc 2019-01-31 06:37:23 +01:00
Add mautrix-facebook doc 2019-05-08 16:33:09 +02:00			`- [Setting up Mautrix Facebook bridging](configuring-playbook-bridge-mautrix-facebook.md) (optional)`

Update changelog and documentation 2019-08-21 06:24:58 +02:00			`- [Setting up Mautrix Hangouts bridging](configuring-playbook-bridge-mautrix-hangouts.md) (optional)`

added docs 2020-10-25 18:44:19 +01:00			`- [Setting up Mautrix Signal bridging](configuring-playbook-bridge-mautrix-signal.md) (optional)`

Add support for matrix-appservice-irc 2019-01-31 06:37:23 +01:00			`- [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. 2019-03-03 18:22:52 +01:00
			`- [Setting up Appservice Discord bridging](configuring-playbook-bridge-appservice-discord.md) (optional)`
Added Slack role 2019-06-10 16:52:48 +02:00
			`- [Setting up Appservice Slack bridging](configuring-playbook-bridge-appservice-slack.md) (optional)`
Merge branch 'master' into master 2019-08-21 06:34:20 +02:00
Announce Appservice Webhooks support Related to #339 (Github Pull Request). 2020-01-14 15:02:37 +01:00			`- [Setting up Appservice Webhooks bridging](configuring-playbook-bridge-appservice-webhooks.md) (optional)`

Announce Skype bridging 2020-04-09 08:33:30 +02:00			`- [Setting up MX Puppet Skype bridging](configuring-playbook-bridge-mx-puppet-skype.md) (optional)`

Announce mx-puppet-slack support Related to #454 (Github Pull Request). 2020-04-23 17:03:36 +02:00			`- [Setting up MX Puppet Slack bridging](configuring-playbook-bridge-mx-puppet-slack.md) (optional)`

Announce mx-puppet-instagram and mx-puppet-twitter support Related to #551 and #555 (Github Pull Requests). 2020-06-30 16:51:56 +02:00			`- [Setting up MX Puppet Instagram bridging](configuring-playbook-bridge-mx-puppet-instagram.md) (optional)`

			`- [Setting up MX Puppet Twitter bridging](configuring-playbook-bridge-mx-puppet-twitter.md) (optional)`

Announce mx-puppet-discord bridging support Related to #540 (Github Pull Request). 2020-07-01 18:01:14 +02:00			`- [Setting up MX Puppet Discord bridging](configuring-playbook-bridge-mx-puppet-discord.md) (optional)`

Announce mx-puppet-steam bridging support Related to #557 (Github Pull Request). 2020-07-03 11:10:57 +02:00			`- [Setting up MX Puppet Steam bridging](configuring-playbook-bridge-mx-puppet-steam.md) (optional)`

Add Email2Matrix support 2019-08-05 12:06:49 +02:00			`- [Setting up Email2Matrix](configuring-playbook-email2matrix.md) (optional)`
matrix-sms-bridge: added docs, added seperate service for database, pr comments 2020-05-23 13:14:24 +02:00
Relocate docs page for consistency 2020-09-01 12:47:58 +02:00			`- [Setting up Matrix SMS bridging](configuring-playbook-bridge-matrix-bridge-sms.md) (optional)`
Add support for matrix-reminder-bot 2020-07-20 13:13:08 +02:00

			`### Bots`

			`- [Setting up matrix-reminder-bot](configuring-playbook-bot-matrix-reminder-bot.md) (optional)`