Skip to content

Latest commit

 

History

History
43 lines (29 loc) · 2.79 KB

configuring-playbook.md

File metadata and controls

43 lines (29 loc) · 2.79 KB

Configuring the playbook

Prerequisites > Configuring DNS settings > Getting the playbook > Configuring the playbook > Installing

If you've configured your DNS records and retrieved the playbook's source code to your computer, you can start configuring the playbook. To do so, follow these steps inside the playbook directory:

  1. create a directory to hold your configuration (mkdir -p inventory/host_vars/mash.example.com)

  2. copy the sample configuration file (cp examples/vars.yml inventory/host_vars/mash.example.com/vars.yml)

  3. edit the configuration file (inventory/host_vars/mash.example.com/vars.yml) to your liking. You should enable one or more services in your vars.yml file. You may also take a look at the various roles/*/ROLE_NAME_HERE/defaults/main.yml files (after importing external roles with just update into roles/galaxy) 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. The inventory directory path is ignored via .gitignore, so it won't be part of the playbook repository. You can safely create a new git repository inside that directory with git init, etc.

For a basic installation, that's all you need.

If you're installing services on the same server using another playbook (like matrix-docker-ansible-deploy) or you already have Traefik or Docker installed on the server, consult our Interoperability documentation.

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