From 94c55d7368919fbdfd5f53e34862d5d02ea311d5 Mon Sep 17 00:00:00 2001 From: Robert Kaussow Date: Thu, 30 Jan 2020 22:58:49 +0100 Subject: [PATCH] cleanup readme --- README.md | 260 ++---------------------------------------------------- 1 file changed, 6 insertions(+), 254 deletions(-) diff --git a/README.md b/README.md index da9ecf1..6adcb56 100644 --- a/README.md +++ b/README.md @@ -1,262 +1,14 @@ # xoxys.certbot - -[![Build Status](https://drone.rknet.org/api/badges/ansible/xoxys.certbot/status.svg)](https://drone.rknet.org/ansible/xoxys.certbot) + +[![Build Status](https://img.shields.io/drone/build/ansible/xoxys.certbot?logo=drone&server=https%3A%2F%2Fdrone.rknet.org)](https://drone.rknet.org/ansible/xoxys.certbot) Setup certbot Let's Encrypt client -## Table of content +### License -* [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_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) - * [certbot_server](#certbot_server) - * [certbot_user](#certbot_user) - * [certbot_work_dir](#certbot_work_dir) -* [Dependencies](#dependencies) -* [License](#license) -* [Author](#author) +This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. ---- +### Maintainers and Contributors -## Default Variables - -### certbot_command_arguments - -#### 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_config_dir - -#### Default value - -```YAML -certbot_config_dir: /etc/letsencrypt -``` - -### certbot_core_networks_api_host - -#### Default value - -```YAML -certbot_core_networks_api_host: https://beta.api.core-networks.de/ -``` - -### certbot_core_networks_api_password - -#### Default value - -```YAML -certbot_core_networks_api_password: secure -``` - -### certbot_core_networks_api_user - -#### Default value - -```YAML -certbot_core_networks_api_user: myuser -``` - -### certbot_core_networks_base_dir - -#### Default value - -```YAML -certbot_core_networks_base_dir: '{{ certbot_plugin_dir }}/certbot_dns_corenetworks' -``` - -### certbot_core_networks_dns_zone - -#### 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_domains - -#### Default value - -```YAML -certbot_domains: - - example.com -``` - -### certbot_email - -#### Default value - -```YAML -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 - -```YAML -certbot_initial_run_enabled: false -``` - -### certbot_log_dir - -#### Default value - -```YAML -certbot_log_dir: /var/log/letsencrypt -``` - -### certbot_packages_extra - -#### Default value - -```YAML -certbot_packages_extra: [] -``` - -### certbot_plugin_dir - -#### Default value - -```YAML -certbot_plugin_dir: /etc/letsencrypt/plugins -``` - -### certbot_preferred_challenges - -#### Default value - -```YAML -certbot_preferred_challenges: dns -``` - -### certbot_rsa_key_size - -#### Default value - -```YAML -certbot_rsa_key_size: 4096 -``` - -### certbot_scheduler_enabled - -#### Default value - -```YAML -certbot_scheduler_enabled: true -``` - -### certbot_server - -#### Default value - -```YAML -certbot_server: https://acme-v02.api.letsencrypt.org/directory -``` - -### certbot_user - -#### Default value - -```YAML -certbot_user: root -``` - -### certbot_work_dir - -#### Default value - -```YAML -certbot_work_dir: /var/lib/letsencrypt -``` - -## Dependencies - -None. - -## License - -MIT - -## Author - -[xoxys](https://gitea.rknet.org/xoxys) +[Robert Kaussow](https://gitea.rknet.org/xoxys)