diff --git a/README.md b/README.md index 49b4301..e8e937b 100644 --- a/README.md +++ b/README.md @@ -9,13 +9,14 @@ Deploy Lego ACME client to manage Lets Encrypt certificates. - [Requirements](#requirements) - [Default Variables](#default-variables) - - [lego_acme_account\_\_email](#lego_acme_account__email) + - [lego_acme_account_email](#lego_acme_account_email) - [lego_acme_server](#lego_acme_server) - [lego_certificates](#lego_certificates) - [lego_cloudflare_api_token](#lego_cloudflare_api_token) - [lego_cron_enabled](#lego_cron_enabled) - [lego_cron_hour](#lego_cron_hour) - [lego_cron_minute](#lego_cron_minute) + - [lego_dns_resolvers](#lego_dns_resolvers) - [lego_key_type](#lego_key_type) - [lego_version](#lego_version) - [Dependencies](#dependencies) @@ -30,12 +31,18 @@ Deploy Lego ACME client to manage Lets Encrypt certificates. ## Default Variables -### lego_acme_account\_\_email +### lego_acme_account_email #### Default value ```YAML -lego_acme_account__email: '' +lego_acme_account_email: _unset_ +``` + +#### Example usage + +```YAML +lego_acme_account_email: user@example.com ``` ### lego_acme_server @@ -57,7 +64,13 @@ lego_certificates: [] #### Example usage ```YAML - +lego_certificates: + - name: example + domains: + - example.com + - www.example.com + hook: | + #!/bin/env bash ``` ### lego_cloudflare_api_token @@ -65,7 +78,13 @@ lego_certificates: [] #### Default value ```YAML -lego_cloudflare_api_token: '' +lego_cloudflare_api_token: _unset_ +``` + +#### Example usage + +```YAML +lego_cloudflare_api_token: _dhTdcj9g9s7gcpbN7qsh9CR3RMVHdM7v ``` ### lego_cron_enabled @@ -92,6 +111,14 @@ lego_cron_hour: '2' lego_cron_minute: '0' ``` +### lego_dns_resolvers + +#### Default value + +```YAML +lego_dns_resolvers: [] +``` + ### lego_key_type #### Default value