From c3e6e0a2ad536b9f0fea20fcfed24843db7a2986 Mon Sep 17 00:00:00 2001 From: Maksim <18454392+silentdigit@users.noreply.github.com> Date: Tue, 10 Dec 2019 23:42:03 +1100 Subject: [PATCH] readme update --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 83b209d..06ca0dc 100755 --- a/README.md +++ b/README.md @@ -7,7 +7,8 @@ Variables: * `DUCKDNS_TOKEN`: Duck DNS account token (obtained from [Duck DNS](https://www.duckdns.org)) * `DUCKDNS_DOMAIN`: Full Duck DNS domain (e.g. `test.duckdns.org`) * `LETSENCRYPT_EMAIL`: Email used for certificate renewal notifications (optional) -* `LETSENCRYPT_WILDCARD`: `true` or `false`, indicating whether the SSL certificate should be for all subdomains of `DUCKDNS_DOMAIN` (i.e. `*.test.duckdns.org`), or just the main domain (i.e. `test.duckdns.org`) (default: `false`) +* `LETSENCRYPT_WILDCARD`: `true` or `false`, indicating whether the SSL certificate should be for subdomains *only* of `DUCKDNS_DOMAIN` (i.e. `*.test.duckdns.org`), or for the main domain *only* (i.e. `test.duckdns.org`) (default: `false`) +* `TESTING`: `true` or `false`, indicating whether a staging SSL certificate should be generated or not (default: `false`) **Note:** The format of `DUCKDNS_DOMAIN` should be the same regardless of the value of `LETSENCRYPT_WILDCARD`. @@ -18,4 +19,4 @@ Volumes: **Note:** If a hosted volume is used, the volume should be mounted in an unused directory in another container to prevent access conflicts. ### TODO: -* Implement tests so `depends_on` can be used in docker-compose to prevent other containers from initialising until certificates are ready +- [ ] Implement tests so `depends_on` can be used in docker-compose to prevent other containers from initialising until certificates are ready