Encourage use of host_var yaml files

For now, there are not too many variables to set per host. However, this will
likely change in future commits, with a greater number of variables needing to
be configured. Therefore, this commit encourages the user to define these
variables in a yaml file, which will be more cleanly scalable.

1 files changed, 19 insertions, 1 deletions

diff --git a/README.md b/README.md
index d0b650b..0943edd 100644
--- a/README.md
+++ b/README.md
@@ -76,7 +76,25 @@ Create an inventory file in `inventory/staging.ini` like the following:
 
 ```ini
 [xmpp_server]
-staging.koyo.haus virtual_host=staging.koyo.haus
+staging.koyo.haus
+```
+
+### Set variables in inventory files
+
+Now, create a directory like the following for each of the hosts you have
+defined: `inventory/host_vars/staging.koyo.haus/vars.yaml`
+
+```
+inventory/
+├── host_vars
+│   └── staging.koyo.haus
+│       └── vars.yaml
+└── staging.ini
+```
+
+```yaml
+certbot_email: an email address letsencrypt should use if renewal fails
+virtual_host: the domain of the JID you'd like to use, e.g. koyo.haus
 ```
 
 ### Run the playbook on your staging hosts