diff --git a/index.md b/index.md index e7b747b..f8fea60 100644 --- a/index.md +++ b/index.md @@ -10,22 +10,15 @@ Setup [certbot](https://certbot.eff.org/) Let's Encrypt client. * [Default Variables](#default-variables) * [certbot_command_arguments](#certbot-command-arguments) * [certbot_config_dir](#certbot-config-dir) - * [certbot_core_networks_api_host](#certbot-core-networks-api-host) - * [certbot_core_networks_api_password](#certbot-core-networks-api-password) - * [certbot_core_networks_api_user](#certbot-core-networks-api-user) - * [certbot_core_networks_base_dir](#certbot-core-networks-base-dir) - * [certbot_core_networks_dns_zone](#certbot-core-networks-dns-zone) - * [certbot_core_networks_log_level](#certbot-core-networks-log-level) - * [certbot_core_networks_plugin_enabled](#certbot-core-networks-plugin-enabled) - * [certbot_core_networks_plugin_repo](#certbot-core-networks-plugin-repo) - * [certbot_core_networks_plugin_version](#certbot-core-networks-plugin-version) + * [certbot_credentials](#certbot-credentials) + * [certbot_cron_file](#certbot-cron-file) + * [certbot_cron_hour](#certbot-cron-hour) + * [certbot_cron_minute](#certbot-cron-minute) * [certbot_domains](#certbot-domains) * [certbot_email](#certbot-email) - * [certbot_environment](#certbot-environment) * [certbot_initial_run_enabled](#certbot-initial-run-enabled) * [certbot_log_dir](#certbot-log-dir) * [certbot_packages_extra](#certbot-packages-extra) - * [certbot_plugin_dir](#certbot-plugin-dir) * [certbot_preferred_challenges](#certbot-preferred-challenges) * [certbot_rsa_key_size](#certbot-rsa-key-size) * [certbot_scheduler_enabled](#certbot-scheduler-enabled) @@ -45,13 +38,7 @@ Setup [certbot](https://certbot.eff.org/) Let's Encrypt client. ```YAML certbot_command_arguments: - certonly - - --agree-tos - - --manual - - --manual-auth-hook /path/to/authenticator.py - - --manual-cleanup-hook /path/to/cleanup.py - - --manual-public-ip-logging-ok - - -n - - -d {{ certbot_domains | join(',') }} + - -n -d {{ certbot_domains | join(',') }} ``` ### certbot_config_dir @@ -62,76 +49,46 @@ certbot_command_arguments: certbot_config_dir: /etc/letsencrypt ``` -### certbot_core_networks_api_host +### certbot_credentials + +Specify key value parairs for your credentials (e.g. plugin credentials). The credentials will be saved to `{{ certbot_config_dir }}/credentials.ini and you could add the path to `certbot_command_arguments` if required. #### Default value ```YAML -certbot_core_networks_api_host: https://beta.api.core-networks.de/ +certbot_credentials: [] ``` -### certbot_core_networks_api_password +### certbot_cron_file + +Use a file under /etc/cron.d but this will only work if `certbot_user` #### Default value ```YAML -certbot_core_networks_api_password: secure +certbot_cron_file: _unset_ ``` -### certbot_core_networks_api_user - -#### Default value +#### Example usage ```YAML -certbot_core_networks_api_user: myuser +certbot-letsencrypt ``` -### certbot_core_networks_base_dir +### certbot_cron_hour #### Default value ```YAML -certbot_core_networks_base_dir: '{{ certbot_plugin_dir }}/certbot_dns_corenetworks' +certbot_cron_hour: 3 ``` -### certbot_core_networks_dns_zone +### certbot_cron_minute #### Default value ```YAML -certbot_core_networks_dns_zone: mydomain.com -``` - -### certbot_core_networks_log_level - -#### Default value - -```YAML -certbot_core_networks_log_level: error -``` - -### certbot_core_networks_plugin_enabled - -#### Default value - -```YAML -certbot_core_networks_plugin_enabled: false -``` - -### certbot_core_networks_plugin_repo - -#### Default value - -```YAML -certbot_core_networks_plugin_repo: https://git.rknet.org/xoxys/certbot_dns_corenetworks.git -``` - -### certbot_core_networks_plugin_version - -#### Default value - -```YAML -certbot_core_networks_plugin_version: master +certbot_cron_minute: 30 ``` ### certbot_domains @@ -151,22 +108,6 @@ certbot_domains: certbot_email: mail@example.com ``` -### certbot_environment - -#### Default value - -```YAML -certbot_environment: - - name: '{{ certbot_work_dir }}' - mode: '0755' - - name: '{{ certbot_config_dir }}' - mode: '0755' - - name: '{{ certbot_log_dir }}' - mode: '0700' - - name: '{{ certbot_plugin_dir }}' - mode: '0755' -``` - ### certbot_initial_run_enabled #### Default value @@ -191,14 +132,6 @@ certbot_log_dir: /var/log/letsencrypt certbot_packages_extra: [] ``` -### certbot_plugin_dir - -#### Default value - -```YAML -certbot_plugin_dir: /etc/letsencrypt/plugins -``` - ### certbot_preferred_challenges #### Default value @@ -217,6 +150,8 @@ certbot_rsa_key_size: 4096 ### certbot_scheduler_enabled +Enable scheduling via cron. + #### Default value ```YAML