Once you have your server and you have configured your DNS records, 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 atroles/matrix-server/defaults.main.yml
and see if there's something you'd like to copy over and override in yourvars.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 below.
When you're done with all the configuration you'd like to do, continue with Installing.
-
Adjusting email-sending settings (optional)
-
Storing Matrix media files on Amazon S3 (optional)
-
Using an external PostgreSQL server (optional)
-
Using your own webserver, instead of this playbook's nginx proxy (optional)
-
Setting up the REST authentication password provider module (optional)
-
Setting up the Shared Secret Auth password provider module (optional)
-
Setting up Matrix Corporal (optional)
-
Setting up Mautrix Telegram bridging (optional)