xoxys.certbot/index.md

title	type
certbot	docs

Setup certbot Let's Encrypt client.

• Default Variables
  • certbot_bin
  • certbot_command_arguments
  • certbot_config_dir
  • certbot_credentials
  • certbot_cron_enabled
  • certbot_cron_file
  • certbot_cron_hour
  • certbot_cron_minute
  • certbot_domain_groups
  • certbot_email
  • certbot_log_dir
  • certbot_max_log_backups
  • certbot_packages_extra
  • certbot_preferred_challenges
  • certbot_rsa_key_size
  • certbot_server
  • certbot_user
  • certbot_version
  • certbot_virtualenv
  • certbot_virtualenv_command
  • certbot_work_dir
• Dependencies

---

Default Variables

certbot_bin

Location of the certbot binary. Default is to ~/.local/.bin/certbot.

certbot_command_arguments

Default value

certbot_command_arguments:
  - certonly

certbot_config_dir

Default value

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

certbot_credentials: []

certbot_cron_enabled

Enable scheduling via cron.

Default value

certbot_cron_enabled: true

certbot_cron_file

Use a file under /etc/cron.d but this will only work if certbot_user has write permissions for this location.

Default value

certbot_cron_file: _unset_

Example usage

certbot-letsencrypt

certbot_cron_hour

Default value

certbot_cron_hour: '3'

certbot_cron_minute

Default value

certbot_cron_minute: '30'

certbot_domain_groups

Default value

certbot_domain_groups:
  - name: example
    domains:
      - '*.example.com'
      - example.com
    init: false

certbot_email

Default value

certbot_email: mail@example.com

certbot_log_dir

Default value

certbot_log_dir: /var/log/letsencrypt

certbot_max_log_backups

Default value

certbot_max_log_backups: 30

certbot_packages_extra

Extra packages to install with pip (e.g. DNS plugins).

Default value

certbot_packages_extra: []

certbot_preferred_challenges

Default value

certbot_preferred_challenges: dns

certbot_rsa_key_size

Default value

certbot_rsa_key_size: 4096

certbot_server

Default value

certbot_server: https://acme-v02.api.letsencrypt.org/directory

certbot_user

Default value

certbot_user: root

certbot_version

Set a fix version of the certbot package to install.

Default value

certbot_version: _unset_

certbot_virtualenv

Default value

certbot_virtualenv: /opt/python3/certbot

certbot_virtualenv_command

Default value

certbot_virtualenv_command: /usr/bin/python3 -m venv

certbot_work_dir

Default value

certbot_work_dir: /var/lib/letsencrypt

Dependencies

None.