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

# Configuring the Ansible playbook

Once you have your server and you have [configured your DNS records](configuring-dns.md#configuring-dns), you can proceed with configuring this playbook, so that it knows what to install and where.

You can follow these steps:

- 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

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

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

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

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

- [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 Appservice IRC bridging](configuring-playbook-bridge-appservice-irc.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
			`Once you have your server and you have [configured your DNS records](configuring-dns.md#configuring-dns), you can proceed with configuring this playbook, so that it knows what to install and where.`

			`You can follow these steps:`

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

Add documentation about Telemetry configuration 2018-11-01 17:21:38 +01:00			`- [Enabling Telemetry for your Matrix server](configuring-playbook-telemetry.md) (optional)`

Updated "Controlling Matrix federation" link Missing file ending results in 404 2018-11-04 00:30:17 +01:00			`- [Controlling Matrix federation](configuring-playbook-federation.md) (optional)`
Add support for controlling Matrix federation 2018-10-25 17:02:04 +02:00
Add email-sending support 2018-08-14 13:11:41 +02:00			`- [Adjusting email-sending settings](configuring-playbook-email.md) (optional)`

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

Add mxisd Identity Server support 2018-08-15 09:23:22 +02:00			`- [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. 2018-12-23 10:00:12 +01:00			`- [Adjusting SSL certificate retrieval](configuring-playbook-ssl-certificates.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			`- [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
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)`

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
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
			`- [Setting up Appservice IRC bridging](configuring-playbook-bridge-appservice-irc.md) (optional)`