From 195eed8c5e1ad00f379ffe11df8cb00927dd5ff0 Mon Sep 17 00:00:00 2001 From: DroneShipper Date: Fri, 22 Nov 2019 23:11:54 +0000 Subject: [PATCH] [SKIP CI] update readme --- README.md | 166 +++++++++++++++++++++++++++--------------------------- 1 file changed, 83 insertions(+), 83 deletions(-) diff --git a/README.md b/README.md index c0396b6..da9ecf1 100644 --- a/README.md +++ b/README.md @@ -8,30 +8,30 @@ Setup certbot Let's Encrypt client ## Table of content * [Default Variables](#default-variables) - * [certbot_packages_extra](#certbot_packages_extra) - * [certbot_initial_run_enabled](#certbot_initial_run_enabled) - * [certbot_work_dir](#certbot_work_dir) + * [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_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_environment](#certbot_environment) - * [certbot_user](#certbot_user) * [certbot_preferred_challenges](#certbot_preferred_challenges) - * [certbot_server](#certbot_server) - * [certbot_email](#certbot_email) * [certbot_rsa_key_size](#certbot_rsa_key_size) - * [certbot_domains](#certbot_domains) - * [certbot_command_arguments](#certbot_command_arguments) * [certbot_scheduler_enabled](#certbot_scheduler_enabled) - * [certbot_core_networks_plugin_enabled](#certbot_core_networks_plugin_enabled) - * [certbot_core_networks_plugin_repo](#certbot_core_networks_plugin_repo) - * [certbot_core_networks_base_dir](#certbot_core_networks_base_dir) - * [certbot_core_networks_plugin_version](#certbot_core_networks_plugin_version) - * [certbot_core_networks_api_host](#certbot_core_networks_api_host) - * [certbot_core_networks_api_user](#certbot_core_networks_api_user) - * [certbot_core_networks_api_password](#certbot_core_networks_api_password) - * [certbot_core_networks_dns_zone](#certbot_core_networks_dns_zone) - * [certbot_core_networks_log_level](#certbot_core_networks_log_level) + * [certbot_server](#certbot_server) + * [certbot_user](#certbot_user) + * [certbot_work_dir](#certbot_work_dir) * [Dependencies](#dependencies) * [License](#license) * [Author](#author) @@ -40,213 +40,213 @@ Setup certbot Let's Encrypt client ## Default Variables -### certbot_packages_extra +### certbot_command_arguments #### Default value ```YAML -certbot_packages_extra: [] +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(',') }} ``` -### certbot_initial_run_enabled +### certbot_config_dir #### Default value ```YAML -certbot_initial_run_enabled: false +certbot_config_dir: /etc/letsencrypt ``` -### certbot_work_dir +### certbot_core_networks_api_host #### Default value ```YAML -certbot_work_dir: /var/lib/letsencrypt +certbot_core_networks_api_host: https://beta.api.core-networks.de/ ``` -### certbot_config_dir +### certbot_core_networks_api_password #### Default value ```YAML -certbot_config_dir: /etc/letsencrypt +certbot_core_networks_api_password: secure ``` -### certbot_log_dir +### certbot_core_networks_api_user #### Default value ```YAML -certbot_log_dir: /var/log/letsencrypt +certbot_core_networks_api_user: myuser ``` -### certbot_plugin_dir +### certbot_core_networks_base_dir #### Default value ```YAML -certbot_plugin_dir: /etc/letsencrypt/plugins +certbot_core_networks_base_dir: '{{ certbot_plugin_dir }}/certbot_dns_corenetworks' ``` -### certbot_environment +### certbot_core_networks_dns_zone #### 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_core_networks_dns_zone: mydomain.com ``` -### certbot_user +### certbot_core_networks_log_level #### Default value ```YAML -certbot_user: root +certbot_core_networks_log_level: error ``` -### certbot_preferred_challenges +### certbot_core_networks_plugin_enabled #### Default value ```YAML -certbot_preferred_challenges: dns +certbot_core_networks_plugin_enabled: false ``` -### certbot_server +### certbot_core_networks_plugin_repo #### Default value ```YAML -certbot_server: https://acme-v02.api.letsencrypt.org/directory +certbot_core_networks_plugin_repo: https://git.rknet.org/xoxys/certbot_dns_corenetworks.git ``` -### certbot_email +### certbot_core_networks_plugin_version #### Default value ```YAML -certbot_email: mail@example.com +certbot_core_networks_plugin_version: master ``` -### certbot_rsa_key_size +### certbot_domains #### Default value ```YAML -certbot_rsa_key_size: 4096 +certbot_domains: + - example.com ``` -### certbot_domains +### certbot_email #### Default value ```YAML -certbot_domains: - - example.com +certbot_email: mail@example.com ``` -### certbot_command_arguments +### certbot_environment #### Default value ```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(',') }} +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_scheduler_enabled +### certbot_initial_run_enabled #### Default value ```YAML -certbot_scheduler_enabled: true +certbot_initial_run_enabled: false ``` -### certbot_core_networks_plugin_enabled +### certbot_log_dir #### Default value ```YAML -certbot_core_networks_plugin_enabled: false +certbot_log_dir: /var/log/letsencrypt ``` -### certbot_core_networks_plugin_repo +### certbot_packages_extra #### Default value ```YAML -certbot_core_networks_plugin_repo: https://git.rknet.org/xoxys/certbot_dns_corenetworks.git +certbot_packages_extra: [] ``` -### certbot_core_networks_base_dir +### certbot_plugin_dir #### Default value ```YAML -certbot_core_networks_base_dir: '{{ certbot_plugin_dir }}/certbot_dns_corenetworks' +certbot_plugin_dir: /etc/letsencrypt/plugins ``` -### certbot_core_networks_plugin_version +### certbot_preferred_challenges #### Default value ```YAML -certbot_core_networks_plugin_version: master +certbot_preferred_challenges: dns ``` -### certbot_core_networks_api_host +### certbot_rsa_key_size #### Default value ```YAML -certbot_core_networks_api_host: https://beta.api.core-networks.de/ +certbot_rsa_key_size: 4096 ``` -### certbot_core_networks_api_user +### certbot_scheduler_enabled #### Default value ```YAML -certbot_core_networks_api_user: myuser +certbot_scheduler_enabled: true ``` -### certbot_core_networks_api_password +### certbot_server #### Default value ```YAML -certbot_core_networks_api_password: secure +certbot_server: https://acme-v02.api.letsencrypt.org/directory ``` -### certbot_core_networks_dns_zone +### certbot_user #### Default value ```YAML -certbot_core_networks_dns_zone: mydomain.com +certbot_user: root ``` -### certbot_core_networks_log_level +### certbot_work_dir #### Default value ```YAML -certbot_core_networks_log_level: error +certbot_work_dir: /var/lib/letsencrypt ``` ## Dependencies