Robert Kaussow
1e22a8f1d6
Author: Robert Kaussow <mail@geeklabor.de>
Date: Mon Apr 20 22:47:48 2020 +0200
rename cron related variables
188 lines
3.3 KiB
Markdown
188 lines
3.3 KiB
Markdown
---
|
|
title: certbot
|
|
type: docs
|
|
---
|
|
|
|
[](https://gitea.rknet.org/ansible/xoxys.certbot) [](https://drone.rknet.org/ansible/xoxys.certbot) [](LICENSE)
|
|
|
|
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_credentials](#certbot-credentials)
|
|
* [certbot_cron_enabled](#certbot-cron-enabled)
|
|
* [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_initial_run_enabled](#certbot-initial-run-enabled)
|
|
* [certbot_log_dir](#certbot-log-dir)
|
|
* [certbot_packages_extra](#certbot-packages-extra)
|
|
* [certbot_preferred_challenges](#certbot-preferred-challenges)
|
|
* [certbot_rsa_key_size](#certbot-rsa-key-size)
|
|
* [certbot_server](#certbot-server)
|
|
* [certbot_user](#certbot-user)
|
|
* [certbot_work_dir](#certbot-work-dir)
|
|
* [Dependencies](#dependencies)
|
|
|
|
---
|
|
|
|
## Default Variables
|
|
|
|
### certbot_command_arguments
|
|
|
|
#### Default value
|
|
|
|
```YAML
|
|
certbot_command_arguments:
|
|
- certonly
|
|
- -n -d {{ certbot_domains | join(',') }}
|
|
```
|
|
|
|
### certbot_config_dir
|
|
|
|
#### Default value
|
|
|
|
```YAML
|
|
certbot_config_dir: /etc/letsencrypt
|
|
```
|
|
|
|
### 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_credentials: []
|
|
```
|
|
|
|
### certbot_cron_enabled
|
|
|
|
Enable scheduling via cron.
|
|
|
|
#### Default value
|
|
|
|
```YAML
|
|
certbot_cron_enabled: true
|
|
```
|
|
|
|
### certbot_cron_file
|
|
|
|
Use a file under /etc/cron.d but this will only work if `certbot_user`
|
|
|
|
#### Default value
|
|
|
|
```YAML
|
|
certbot_cron_file: _unset_
|
|
```
|
|
|
|
#### Example usage
|
|
|
|
```YAML
|
|
certbot-letsencrypt
|
|
```
|
|
|
|
### certbot_cron_hour
|
|
|
|
#### Default value
|
|
|
|
```YAML
|
|
certbot_cron_hour: 3
|
|
```
|
|
|
|
### certbot_cron_minute
|
|
|
|
#### Default value
|
|
|
|
```YAML
|
|
certbot_cron_minute: 30
|
|
```
|
|
|
|
### certbot_domains
|
|
|
|
#### Default value
|
|
|
|
```YAML
|
|
certbot_domains:
|
|
- example.com
|
|
```
|
|
|
|
### certbot_email
|
|
|
|
#### Default value
|
|
|
|
```YAML
|
|
certbot_email: mail@example.com
|
|
```
|
|
|
|
### 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_preferred_challenges
|
|
|
|
#### Default value
|
|
|
|
```YAML
|
|
certbot_preferred_challenges: dns
|
|
```
|
|
|
|
### certbot_rsa_key_size
|
|
|
|
#### Default value
|
|
|
|
```YAML
|
|
certbot_rsa_key_size: 4096
|
|
```
|
|
|
|
### 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.
|