From 4b21a62a19389932a24cb5b37bb3b54b307f3ae3 Mon Sep 17 00:00:00 2001 From: Slavi Pantaleev Date: Thu, 30 Mar 2023 17:33:44 +0300 Subject: [PATCH] Minor Traefik docs improvements --- docs/services/traefik.md | 5 +++++ examples/vars.yml | 4 ++-- 2 files changed, 7 insertions(+), 2 deletions(-) diff --git a/docs/services/traefik.md b/docs/services/traefik.md index ab0f001..8d26a70 100644 --- a/docs/services/traefik.md +++ b/docs/services/traefik.md @@ -20,6 +20,9 @@ To enable this service, add the following configuration to your `vars.yml` file mash_playbook_reverse_proxy_type: playbook-managed-traefik +# The email address that Traefik will pass to Let's Encrypt when obtaining SSL certificates +devture_traefik_config_certificatesResolvers_acme_email: your-email@example.com + # Or, if you'd like to install Traefik yourself: # # mash_playbook_reverse_proxy_type: other-traefik-container @@ -31,3 +34,5 @@ mash_playbook_reverse_proxy_type: playbook-managed-traefik # # ######################################################################## ``` + +Enabling the Traefik service, as shown above, automatically installs a [tecnativa/docker-socket-proxy](https://github.com/Tecnativa/docker-socket-proxy) service/container (powered by the [com.devture.ansible.role.container_socket_proxy](https://github.com/devture/com.devture.ansible.role.container_socket_proxy) Ansible role) to improve security by not mounting a Docker socket into the Traefik container. diff --git a/examples/vars.yml b/examples/vars.yml index d478ef2..90fa27b 100644 --- a/examples/vars.yml +++ b/examples/vars.yml @@ -73,8 +73,8 @@ 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 +# The email address that Traefik will pass to Let's Encrypt when obtaining SSL certificates +devture_traefik_config_certificatesResolvers_acme_email: your-email@example.com ######################################################################## # #