matrix-docker-ansible-deploy/docs/configuring-playbook.md
Catalan Lover 9d5902f096
Add support for D4A/Draupnir For All to the playbook. (#3204)
* Draupnir for all Role

* Draupnir for all Documentation

* Pin D4A to Develop until D4A patches are in a release.

* Update D4A Docs to mention pros and cons of D4A mode compared to normal

* Change Documentation to mention a fixed simpler provisioning flow.

Use of /plain allows us to bypass the bugs encountered during the development of this role with clients attempting to escape our wildcards causing the grief that led to using curl.

This reworded commit does still explain you can automatically inject stuff into the room if you wanted to.

* Emphasise the State of D4A mode

* Link to Draupnir-for-all docs and tweak the docs some

* Link to Draupnir-for-all from Draupnir documentation page

* Announce Draupnir-for-all

---------

Co-authored-by: Slavi Pantaleev <slavi@devture.com>
2024-03-05 16:09:52 +02:00

12 KiB

Configuring the Ansible playbook

To configure the playbook, you need to have done the following things:

You can then follow these steps inside the playbook directory:

  1. create a directory to hold your configuration (mkdir -p inventory/host_vars/matrix.<your-domain>)

  2. copy the sample configuration file (cp examples/vars.yml inventory/host_vars/matrix.<your-domain>/vars.yml)

  3. 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.

  4. copy the sample inventory hosts file (cp examples/hosts inventory/hosts)

  5. edit the inventory hosts file (inventory/hosts) to your liking

  6. (optional, advanced) you may wish to keep your inventory directory under version control with git or any other version-control system.

  7. (optional, advanced) to run Ansible against multiple servers with different sudo credentials, you can copy the sample inventory hosts yaml file for each of your hosts: (cp examples/host.yml inventory/my_host1.yml …) and use the ansible-all-hosts.sh script in the installation step.

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

Additional useful services

Core service adjustments

Server connectivity

Bridging other networks

Bots

Backups

Other specialized services