2024-09-27 18:40:51 +00:00
|
|
|
# xoxys.lego
|
2024-09-27 19:22:06 +00:00
|
|
|
|
|
|
|
|
[](https://ci.rknet.org/repos/ansible/xoxys.lego)
|
|
|
|
|
[](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)
|
2024-09-27 23:05:11 +00:00
|
|
|
- [lego_acme_account_email](#lego_acme_account_email)
|
2024-09-27 19:22:06 +00:00
|
|
|
- [lego_acme_server](#lego_acme_server)
|
|
|
|
|
- [lego_certificates](#lego_certificates)
|
|
|
|
|
- [lego_cloudflare_api_token](#lego_cloudflare_api_token)
|
2024-09-27 19:42:04 +00:00
|
|
|
- [lego_cron_enabled](#lego_cron_enabled)
|
|
|
|
|
- [lego_cron_hour](#lego_cron_hour)
|
|
|
|
|
- [lego_cron_minute](#lego_cron_minute)
|
2024-09-27 23:05:11 +00:00
|
|
|
- [lego_dns_resolvers](#lego_dns_resolvers)
|
2024-09-27 19:42:04 +00:00
|
|
|
- [lego_key_type](#lego_key_type)
|
2024-09-27 19:22:06 +00:00
|
|
|
- [lego_version](#lego_version)
|
|
|
|
|
- [Dependencies](#dependencies)
|
|
|
|
|
- [License](#license)
|
|
|
|
|
- [Author](#author)
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
## Requirements
|
|
|
|
|
|
|
|
|
|
- Minimum Ansible version: `2.10`
|
|
|
|
|
|
|
|
|
|
## Default Variables
|
|
|
|
|
|
2024-09-27 23:05:11 +00:00
|
|
|
### lego_acme_account_email
|
2024-09-27 19:22:06 +00:00
|
|
|
|
|
|
|
|
#### Default value
|
|
|
|
|
|
|
|
|
|
```YAML
|
2024-09-27 23:05:11 +00:00
|
|
|
lego_acme_account_email: _unset_
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
#### Example usage
|
|
|
|
|
|
|
|
|
|
```YAML
|
|
|
|
|
lego_acme_account_email: user@example.com
|
2024-09-27 19:22:06 +00:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### 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
|
2024-09-27 23:05:11 +00:00
|
|
|
lego_certificates:
|
|
|
|
|
- name: example
|
|
|
|
|
domains:
|
|
|
|
|
- example.com
|
|
|
|
|
- www.example.com
|
|
|
|
|
hook: |
|
|
|
|
|
#!/bin/env bash
|
2024-09-27 19:22:06 +00:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### lego_cloudflare_api_token
|
|
|
|
|
|
|
|
|
|
#### Default value
|
|
|
|
|
|
|
|
|
|
```YAML
|
2024-09-27 23:05:11 +00:00
|
|
|
lego_cloudflare_api_token: _unset_
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
#### Example usage
|
|
|
|
|
|
|
|
|
|
```YAML
|
|
|
|
|
lego_cloudflare_api_token: _dhTdcj9g9s7gcpbN7qsh9CR3RMVHdM7v
|
2024-09-27 19:22:06 +00:00
|
|
|
```
|
|
|
|
|
|
2024-09-27 19:42:04 +00:00
|
|
|
### lego_cron_enabled
|
|
|
|
|
|
|
|
|
|
#### Default value
|
|
|
|
|
|
|
|
|
|
```YAML
|
|
|
|
|
lego_cron_enabled: true
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### lego_cron_hour
|
|
|
|
|
|
|
|
|
|
#### Default value
|
|
|
|
|
|
|
|
|
|
```YAML
|
|
|
|
|
lego_cron_hour: '2'
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### lego_cron_minute
|
|
|
|
|
|
|
|
|
|
#### Default value
|
|
|
|
|
|
|
|
|
|
```YAML
|
|
|
|
|
lego_cron_minute: '0'
|
|
|
|
|
```
|
|
|
|
|
|
2024-09-27 23:05:11 +00:00
|
|
|
### lego_dns_resolvers
|
|
|
|
|
|
|
|
|
|
#### Default value
|
|
|
|
|
|
|
|
|
|
```YAML
|
|
|
|
|
lego_dns_resolvers: []
|
|
|
|
|
```
|
|
|
|
|
|
2024-09-27 19:42:04 +00:00
|
|
|
### lego_key_type
|
|
|
|
|
|
|
|
|
|
#### Default value
|
|
|
|
|
|
|
|
|
|
```YAML
|
|
|
|
|
lego_key_type: ec256
|
|
|
|
|
```
|
|
|
|
|
|
2024-09-27 19:22:06 +00:00
|
|
|
### lego_version
|
|
|
|
|
|
|
|
|
|
#### Default value
|
|
|
|
|
|
|
|
|
|
```YAML
|
|
|
|
|
lego_version: 4.18.0
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Dependencies
|
|
|
|
|
|
|
|
|
|
None.
|
|
|
|
|
|
|
|
|
|
## License
|
|
|
|
|
|
|
|
|
|
MIT
|
|
|
|
|
|
|
|
|
|
## Author
|
|
|
|
|
|
|
|
|
|
[Robert Kaussow](https://gitea.rknet.org/xoxys)
|
