usegalaxy-eu / ansible-certbot

Ansible Role: Certbot (for Let's Encrypt)

Installs and configures Certbot (for Let's Encrypt).

Requirements

If installing from source, Git is required. You can install Git using the geerlingguy.git role.

Role Variables

The variable certbot_install_from_source controls whether to install Certbot from Git or package management. The latter is the default, so the variable defaults to no.

certbot_auto_renew: true
certbot_auto_renew_user: "{{ ansible_user }}"
certbot_auto_renew_hour: 3
certbot_auto_renew_minute: 30

By default, this role configures a cron job to run under the provided user account at the given hour and minute, every day. The defaults run certbot renew (or certbot-auto renew) via cron every day at 03:30:00 by the user you use in your Ansible playbook. It's preferred that you set a custom user/hour/minute so the renewal is during a low-traffic period and done by a non-root user account.

Source Installation from Git

You can install Certbot from it's Git source repository if desired. This might be useful in several cases, but especially when older distributions don't have Certbot packages available (e.g. CentOS < 7, Ubuntu < 16.10 and Debian < 8).

certbot_install_from_source: no
certbot_repo: https://github.com/certbot/certbot.git
certbot_version: master
certbot_keep_updated: yes

Certbot Git repository options. To install from source, set certbot_install_from_source to yes. This clones the configured certbot_repo, respecting the certbot_version setting. If certbot_keep_updated is set to yes, the repository is updated every time this role runs.

certbot_dir: /opt/certbot

The directory inside which Certbot will be cloned.

DNS providers

If you use a DNS provider such as Cloudflare or similar, the following variables are available:

certbot_dns_provider: cloudflare
certbot_dns_credentials:
    api_token: your_dns_provider_api_token
certbot_dns_provider_propagation_seconds: 60

Valid options for certbot_dns_credentials vary by DNS provider. See certbot --help all for details.

Dependencies

None.

Example Playbook

- hosts: servers

  vars:
    certbot_auto_renew_user: your_username_here
    certbot_auto_renew_minute: 20
    certbot_auto_renew_hour: 5
    # certbot_agree_tos: "--agree-tos" # Uncomment me to agree
  roles:
    - geerlingguy.certbot

After installation, you can create certificates using the certbot (or certbot-auto) script, which by default is installed inside the configured certbot_dir (when using Git). Here are some example commands to configure certificates with Certbot:

# Automatically add certs for all Apache virtualhosts (use with caution!).
/opt/certbot/certbot-auto --apache

# Generate certs, but don't modify Apache configuration (safer).
/opt/certbot/certbot-auto --apache certonly

By default, this role adds a cron job that will renew all installed certificates once per day at the hour and minute of your choosing.

You can test the auto-renewal (without actually renewing the cert) with the command:

/opt/certbot/certbot-auto renew --dry-run

See full documentation and options on the Certbot website.

License

MIT / BSD

Author Information

• This role was created in 2016 by Jeff Geerling, author of Ansible for DevOps.
• It has been further modified and maintained by Galaxy Europe

ansible-certbot's Issues

Support SNI

Currently the role combines all of the domains in certbot_domains into a single execution of certbot certonly ... -d {{ ','.join(certbot_domains) }}, which gets you a single cert with multiple subjectAltNames. It's desirable in some cases to use SNI instead and thus get multiple certs (which themselves may have subjectAltNames).

This could be done in a multitude of ways, maybe the simplest would be a new variable:

certbot_sni_domains:
  example.org:
    - example.org
    - www.example.org
  example.com:  # no sANs

This should just need to run the certbot certonly task in request-cert.yml once per dict key in order to generate the certs.

certbot_agree_tos is not documented or has no default

The role fail to run because the certbot_agree_tos is not documented or has no default, I had to figure out myself to set the variable to --agree-tos on my host variables.

Default post-renewal script content not especially useful for everyone

I like the idea to have the possibility to write some custom post-renewal scripts but I don't understand the purpose of this code especially if you renew multiple domains certificates as only the first one will be copied.

Maybe adding some condition here will help create a cleaner scripts for those who don't want this part ?

# Chai
cp {{ certbot_letsencrypt_dir }}/live/{{ certbot_hostname_override | default(certbot_domains[0]) }}/fullchain.pem /etc/ssl/certs/fullchain.pem
chmod 644           /etc/ssl/certs/fullchain.pem
chown root:{{ certbot_ssl_group | default('') }} /etc/ssl/certs/fullchain.pem
# Cert
cp {{ certbot_letsencrypt_dir }}/live/{{ certbot_hostname_override | default(certbot_domains[0]) }}/cert.pem      /etc/ssl/certs/cert.pem
chmod 644           /etc/ssl/certs/cert.pem
chown root:{{ certbot_ssl_group | default('') }} /etc/ssl/certs/cert.pem
# Privkey
cp {{ certbot_letsencrypt_dir }}/live/{{ certbot_hostname_override | default(certbot_domains[0]) }}/privkey.pem   /etc/ssl/private/privkey.pem
chmod 640           /etc/ssl/private/privkey.pem
chown root:{{ certbot_ssl_group | default('') }} /etc/ssl/private/privkey.pem