diff --git a/README.md b/README.md index 052d3b4..defe998 100644 --- a/README.md +++ b/README.md @@ -1 +1,85 @@ # xoxys.lego + +[![Build Status](https://ci.rknet.org/api/badges/ansible/xoxys.lego/status.svg)](https://ci.rknet.org/repos/ansible/xoxys.lego) +[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg?label=license)](https://gitea.rknet.org/ansible/xoxys.lego/src/branch/main/LICENSE) + +Deploy Lego ACME client to manage Lets Encrypt certificates. + +## Table of content + +- [Requirements](#requirements) +- [Default Variables](#default-variables) + - [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_version](#lego_version) +- [Dependencies](#dependencies) +- [License](#license) +- [Author](#author) + +--- + +## Requirements + +- Minimum Ansible version: `2.10` + +## Default Variables + +### lego_acme_account\_\_email + +#### Default value + +```YAML +lego_acme_account__email: '' +``` + +### lego_acme_server + +#### Default value + +```YAML +lego_acme_server: https://acme-v02.api.letsencrypt.org +``` + +### lego_certificates + +#### Default value + +```YAML +lego_certificates: [] +``` + +#### Example usage + +```YAML + +``` + +### lego_cloudflare_api_token + +#### Default value + +```YAML +lego_cloudflare_api_token: '' +``` + +### lego_version + +#### Default value + +```YAML +lego_version: 4.18.0 +``` + +## Dependencies + +None. + +## License + +MIT + +## Author + +[Robert Kaussow](https://gitea.rknet.org/xoxys)