2018-08-15 09:19:31 +02:00
# Configuring the Ansible playbook
2018-08-08 09:07:02 +02:00
2019-03-10 17:02:17 +02:00
To configure the playbook, you need to have done the following things:
2018-08-08 09:07:02 +02:00
2019-03-10 17:02:17 +02: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:
2018-08-08 09:07:02 +02:00
2021-03-06 20:35:12 +02:00
1. create a directory to hold your configuration (`mkdir inventory/host_vars/matrix.< your-domain > `)
2018-08-08 09:07:02 +02:00
2021-03-06 20:35:12 +02:00
1. copy the sample configuration file (`cp examples/vars.yml inventory/host_vars/matrix.< your-domain > /vars.yml`)
2018-08-08 09:07:02 +02:00
2021-03-06 20:35:12 +02:00
1. 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.
2018-08-08 09:07:02 +02:00
2021-03-06 20:35:12 +02:00
1. copy the sample inventory hosts file (`cp examples/hosts inventory/hosts`)
2018-08-08 09:07:02 +02:00
2021-03-06 20:35:12 +02:00
1. edit the inventory hosts file (`inventory/hosts`) to your liking
2018-08-08 09:07:02 +02:00
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
2019-04-19 08:54:18 +02:00
### Additional useful services
2018-11-01 18:21:38 +02:00
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 ))
2018-10-25 17:02:04 +02:00
2020-03-24 18:26:52 +02:00
- [Setting up the Jitsi video-conferencing platform ](configuring-playbook-jitsi.md ) (optional)
2021-01-26 17:19:28 +02:00
- [Setting up Dynamic DNS ](configuring-playbook-dynamic-dns.md ) (optional)
2019-04-19 08:54:18 +02:00
2021-02-12 14:02:53 +02:00
- [Enabling metrics and graphs (Prometheus, Grafana) for your Matrix server ](configuring-playbook-prometheus-grafana.md ) (optional)
2019-04-19 08:54:18 +02:00
### Core service adjustments
2018-08-14 13:11:41 +02:00
2019-08-22 08:49:22 +02:00
- [Configuring Synapse ](configuring-playbook-synapse.md ) (optional)
2020-07-17 10:31:20 +02:00
- [Configuring Element ](configuring-playbook-client-element.md ) (optional)
2019-08-25 09:37:05 +02:00
2018-08-08 09:10:16 +02:00
- [Storing Matrix media files on Amazon S3 ](configuring-playbook-s3.md ) (optional)
2018-08-08 09:07:02 +02:00
- [Using an external PostgreSQL server ](configuring-playbook-external-postgres.md ) (optional)
2020-01-07 20:04:26 +02:00
- [Adjusting ma1sd Identity Server configuration ](configuring-playbook-ma1sd.md ) (optional)
2018-08-15 09:23:22 +02:00
2018-12-23 11:00:12 +02:00
- [Adjusting SSL certificate retrieval ](configuring-playbook-ssl-certificates.md ) (optional, advanced)
2019-03-12 22:27:18 +02:00
- [Serving your base domain using this playbook's nginx server ](configuring-playbook-base-domain-serving.md ) (optional)
2019-10-04 10:07:37 +02:00
- [Configure Nginx (optional, advanced) ](configuring-playbook-nginx.md ) (optional, advanced)
2019-04-17 13:42:09 +02:00
2018-11-26 07:23:42 +02:00
- [Using your own webserver, instead of this playbook's nginx proxy ](configuring-playbook-own-webserver.md ) (optional, advanced)
2018-08-17 08:02:12 +02:00
2019-04-19 08:57:41 +02:00
- [Adjusting TURN server configuration ](configuring-playbook-turn.md ) (optional, advanced)
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
2020-07-22 07:10:26 +02:00
- [Setting up Synapse Admin ](configuring-playbook-synapse-admin.md ) (optional)
2020-09-01 12:46:05 +02:00
- [Setting up matrix-registration ](configuring-playbook-matrix-registration.md ) (optional)
2018-11-26 07:23:42 +02:00
- [Setting up the REST authentication password provider module ](configuring-playbook-rest-auth.md ) (optional, advanced)
2018-08-20 16:11:55 +02:00
2018-11-26 07:23:42 +02:00
- [Setting up the Shared Secret Auth password provider module ](configuring-playbook-shared-secret-auth.md ) (optional, advanced)
2018-08-21 12:34:34 +02:00
2018-11-28 11:21:03 +02:00
- [Setting up the LDAP password provider module ](configuring-playbook-ldap-auth.md ) (optional, advanced)
2019-09-09 07:13:06 +02:00
- [Setting up Synapse Simple Antispam ](configuring-playbook-synapse-simple-antispam.md ) (optional, advanced)
2018-11-26 07:23:42 +02:00
- [Setting up Matrix Corporal ](configuring-playbook-matrix-corporal.md ) (optional, advanced)
2018-09-07 22:35:04 +02:00
2019-04-19 08:54:18 +02:00
### Bridging other networks
2018-10-26 18:44:58 +02:00
- [Setting up Mautrix Telegram bridging ](configuring-playbook-bridge-mautrix-telegram.md ) (optional)
2018-11-04 01:30:17 +02:00
- [Setting up Mautrix Whatsapp bridging ](configuring-playbook-bridge-mautrix-whatsapp.md ) (optional)
2019-01-31 07:37:23 +02:00
2019-05-08 16:33:09 +02:00
- [Setting up Mautrix Facebook bridging ](configuring-playbook-bridge-mautrix-facebook.md ) (optional)
2019-08-21 06:24:58 +02:00
- [Setting up Mautrix Hangouts bridging ](configuring-playbook-bridge-mautrix-hangouts.md ) (optional)
2021-02-19 20:37:36 +02:00
- [Setting up Mautrix Instagram bridging ](configuring-playbook-bridge-mautrix-instagram.md ) (optional)
2020-10-25 19:44:19 +02:00
- [Setting up Mautrix Signal bridging ](configuring-playbook-bridge-mautrix-signal.md ) (optional)
2019-01-31 07:37:23 +02:00
- [Setting up Appservice IRC bridging ](configuring-playbook-bridge-appservice-irc.md ) (optional)
2019-03-03 19:22:52 +02:00
- [Setting up Appservice Discord bridging ](configuring-playbook-bridge-appservice-discord.md ) (optional)
2019-06-10 16:52:48 +02:00
- [Setting up Appservice Slack bridging ](configuring-playbook-bridge-appservice-slack.md ) (optional)
2019-08-21 06:34:20 +02:00
2020-01-14 16:02:37 +02:00
- [Setting up Appservice Webhooks bridging ](configuring-playbook-bridge-appservice-webhooks.md ) (optional)
2020-04-09 08:33:30 +02:00
- [Setting up MX Puppet Skype bridging ](configuring-playbook-bridge-mx-puppet-skype.md ) (optional)
2020-04-23 17:03:36 +02:00
- [Setting up MX Puppet Slack bridging ](configuring-playbook-bridge-mx-puppet-slack.md ) (optional)
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)
2020-07-01 18:01:14 +02:00
- [Setting up MX Puppet Discord bridging ](configuring-playbook-bridge-mx-puppet-discord.md ) (optional)
2021-02-13 17:55:54 +02:00
- [Setting up MX Puppet GroupMe bridging ](configuring-playbook-bridge-mx-puppet-groupme.md ) (optional)
2020-07-03 11:10:57 +02:00
- [Setting up MX Puppet Steam bridging ](configuring-playbook-bridge-mx-puppet-steam.md ) (optional)
2019-08-05 12:06:49 +02:00
- [Setting up Email2Matrix ](configuring-playbook-email2matrix.md ) (optional)
2020-05-23 13:14:24 +02:00
2020-09-01 12:47:58 +02:00
- [Setting up Matrix SMS bridging ](configuring-playbook-bridge-matrix-bridge-sms.md ) (optional)
2020-07-20 13:13:08 +02:00
### Bots
- [Setting up matrix-reminder-bot ](configuring-playbook-bot-matrix-reminder-bot.md ) (optional)
2021-03-16 07:54:26 +02:00
- [Setting up Go-NEB ](configuring-playbook-bot-go-neb.md ) (optional)
2021-03-20 13:31:34 +02:00
### Other specialized services
- [Setting up the Sygnal push gateway ](configuring-playbook-sygnal.md ) (optional)