From fa1d92f85d288aeff14b4ec3a4a759cd53d20689 Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Fri, 18 Oct 2024 19:06:05 +0900 Subject: [PATCH] Update docs/configuring-playbook.md - Mention "base domain" - Fix list numbering - Add a blank line Signed-off-by: Suguru Hirahara --- docs/configuring-playbook.md | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/docs/configuring-playbook.md b/docs/configuring-playbook.md index d79c9491e..e737d5063 100644 --- a/docs/configuring-playbook.md +++ b/docs/configuring-playbook.md @@ -8,21 +8,22 @@ 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.example.com`) +1. create a directory to hold your configuration (`mkdir -p inventory/host_vars/matrix.example.com` where `example.com` is your "base domain") -1. copy the sample configuration file (`cp examples/vars.yml inventory/host_vars/matrix.example.com/vars.yml`) +2. copy the sample configuration file (`cp examples/vars.yml inventory/host_vars/matrix.example.com/vars.yml`) -1. edit the configuration file (`inventory/host_vars/matrix.example.com/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. +3. edit the configuration file (`inventory/host_vars/matrix.example.com/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. -1. copy the sample inventory hosts file (`cp examples/hosts inventory/hosts`) +4. copy the sample inventory hosts file (`cp examples/hosts inventory/hosts`) -1. edit the inventory hosts file (`inventory/hosts`) to your liking +5. edit the inventory hosts file (`inventory/hosts`) to your liking -2. (optional, advanced) you may wish to keep your `inventory` directory under version control with [git](https://git-scm.com/) or any other version-control system. +6. (optional, advanced) you may wish to keep your `inventory` directory under version control with [git](https://git-scm.com/) or any other version-control system. -3. (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`](../bin/ansible-all-hosts.sh) script [in the installation step](installing.md). +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`](../bin/ansible-all-hosts.sh) script [in the installation step](installing.md). 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).