Skip to content

Latest commit

 

History

History
113 lines (74 loc) · 4.74 KB

README.md

File metadata and controls

113 lines (74 loc) · 4.74 KB
Raw

Build Status Ansible Galaxy License

Ansible LetsEncrypt

A role to automate LetsEncrypt certificates.

Stability: beta.

Ansible version required: 2.x

What does it do?

This role will pull in the official Certbot client, install it and issue or renew a certificate with your chosen domain.

Functionality as follows:

  • Tested on Ubuntu 14.04 and Debian 8, Debian 9
  • One domain per role include only
  • Runs in certonly mode only

PR's are welcome to include more functionality.

Installation

You can install the role directly from Galaxy as follows:

ansible-galaxy install jaywink.letsencrypt

Details

Cerbot client location and version

Ubuntu 14.04, Debian 8
  • The client will be installed in /opt/certbot as root
  • Each run will pull in the Certbot client code from a proven release version. You can set a specific Certbot version using the variable letsencrypt_certbot_version.
Debian 9
  • The client will be installed via APT into the standard platform location according to the latest version in the repositories.

Things to know

  • A list of services to be stopped before and (re-)started after obtaining a new certificate can be configured using the variable letsencrypt_pause_services.

  • certonly mode is used, which means no automatic web server installation

  • After cert issuing, you can find it in /etc/letsencrypt/live/<domainname>

    • Tip, use this in your Apache2 config, for example, in your main role. Just make sure not to try and start Apache2 with the virtualhost active without the LetsEncrypt role running first!

      SSLCertificateFile /etc/letsencrypt/live/{{ letsencrypt_domain }}/cert.pem
SSLCertificateKeyFile /etc/letsencrypt/live/{{ letsencrypt_domain }}/privkey.pem
SSLCertificateChainFile /etc/letsencrypt/live/{{ letsencrypt_domain }}/chain.pem

  • Note! If this role fails in the cert request part, you might have stopped services - take care!

  • If the cert has been requested before, this role will automatically try to renew it, if possible. Disable this functionality by setting letsencrypt_force_renew to false. No renewal will be attempted in this case if cert is not due for renewal.

  • A www. subdomain will automatically be requested along with the certificate.

    • To disable this behaviour, set letsencrypt_request_www to false in your vars.

Requirements

Tested with the following:

  • Ubuntu 14.04 and Debian 8, Debian 9
  • Apache2 and Nginx
  • Ansible 2.x

Role Variables

Required

  • letsencrypt_domain - Domain the certificate is for.
  • letsencrypt_email - Your email as certificate owner.

Optional

  • letsencrypt_certbot_args - Additional command line args to be passed to Certbot-- will be combined with letsencrypt_certbot_default_args. See the Certbot docs for arguments you may pass.
  • letsencrypt_certbot_default_args - Please see defaults/main.yml what the default arguments are. Also, you could add To override all the arguments to Certbot, for example to use another plugin, set them using this variable.
  • letsencrypt_certbot_verbose - Make Certbot output to console (default true).
  • letsencrypt_certbot_version - Set specific Certbot version, for example a git tag or branch. Note that the lowest version of Certbot we support is 0.6.0. Has no effect on Debian 9.
  • letsencrypt_force_renew - Whether to attempt renewal always, default to true.
  • letsencrypt_pause_services - List of services to stop/start while calling Certbot.
  • letsencrypt_request_www - Request www. automatically (default true).

Example Playbook

This role works best when included just before your main site role, for example. Or it can be used in an individual playbook, for example as below.

This role should become root on the target host.

---
- hosts: myhost
  become: yes
  become_user: root
  roles:
    - role: ansible-letsencrypt
      letsencrypt_email: email@example.com
      letsencrypt_domain: example.com
      letsencrypt_pause_services:
        - apache2

License

MIT

Author Information

Jason Robinson (@jaywink) - mail@jasonrobinson.me - https://jasonrobinson.me - https://twitter.com/jaywink

Special thanks to Stefan Grönke (@gronke) for his work on expanding this role.

See CONTRIBUTORS for a full list of contributors.