pub-solar/matrix-docker-ansible-deploy
5
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity
matrix-docker-ansible-deploy/docs/configuring-playbook.md
Slavi Pantaleev 733b806833 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 07:23:42 +02:00

2.3 KiB
Raw Blame History

Configuring the Ansible playbook

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 at roles/matrix-server/defaults/main.yml 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 below.

When you're done with all the configuration you'd like to do, continue with Installing.

Other configuration options