Merge pull request #1 from moan0s/docs

docs: Add DNS documentation

docs/configuring-dns.md

@@ -0,0 +1,38 @@
+# Configuring DNS
+
+To reach your services, you'd need to do some DNS configuration.
+
+**We recommend** that you:
+
+- create at least one generic domain (e.g. `mash.DOMAIN`) for easily hosting various services at different subpaths (e.g. `mash.DOMAIN/miniflux`, `mash.DOMAIN/radicale`, etc.)
+
+- create additional domains (`CNAME` DNS records pointing to the main generic domain) for large services or services that explicitly require their own dedicated domain
+
+Some services (like [Uptime-kuma](services/uptime-kuma.md)) require being hosted at their own dedicated domain.
+Others, you can put on their own domain/subdomain or at subpaths on any domain you'd like.
+
+As an **example** setup, consider this one:
+
+| Service                    | Type  | Host                | Target              |
+|--------------------------- |-------|---------------------|---------------------|
+| Miniflux, Radicale, others | A     | `mash.example.com`  | `IP of your server` |
+| Nextcloud                  | CNAME | `cloud.example.com` | `mash.example.com`  |
+
+With such a setup, you could reach:
+
+- the feedreader [Miniflux](services/miniflux.md) at `https://mash.example.com/miniflux` (if you set
+`miniflux_hostname: mash.example.com` and `miniflux_path_prefix: /miniflux` in your `vars.yml`)
+
+- the [Radicale](services/radicale.md) CalDAV/CardDAV sever at `https://mash.example.com/radicale` (if you set
+`radicale_hostname: mash.example.com` and `radicale_path_prefix: /radicale` in your `vars.yml`)
+
+- Nextcloud at its own dedicated domain, at `https://cloud.example.com`
+
+Hosting services at subpaths is more convenient, because it doesn't require you to create additional DNS records and no new SSL certificates need to be retrieved. 
+
+Still, if you'd like each service to have its own dedicated domain (or subdomain), feel free to configure services that way by making sure that you set `<service>_hostname` and `<service>_path_prefix`
+accordingly in your `vars.yml`.
+
+Be mindful as to how long it will take for the DNS records to propagate.
+
+When you're done configuring DNS, proceed to [Configuring the playbook](configuring-playbook.md).

docs/configuring-playbook.md

@@ -2,7 +2,7 @@
 
 To configure the playbook, you need to have done the following things:
 
-- have a server where services services will run
+- have a server where services will run
 - [retrieved the playbook's source code](getting-the-playbook.md) to your computer
 
 You can then follow these steps inside the playbook directory:

examples/vars.yml

@@ -77,6 +77,9 @@ devture_timesync_installation_enabled: true
 
 mash_playbook_reverse_proxy_type: playbook-managed-traefik
 
+# The E-Mail address that traefik will use to obtain certificates with
+devture_traefik_config_certificatesResolvers_acme_email: yourmail@example.com
+
 ########################################################################
 #                                                                      #
 # /devture-traefik                                                     #