TLS certificate hooks

check_letsencrypt_expiries_post.sh

This hook is executed after the periodic ACME system checks for TLS certificates have finished. The periodic task issues certificates for new domains and subdomains or renews existing certificates.

Environment variables:

Name	Value example	Comment
renewed	15	Number of new TLS certificates successfully issued.
failed	0	Number of failed TLS certificate issue operations.

letsencrypt_(pre|post).sh

These custom scripts are used for before/after calls to letsencrypt.sh.

Environment variables

• acme-challenge-dir: location of the acme-challenge directory for domain validation
• username: owner of domain
• domain: target domain
• action (request|renew|revoke): Let's Encrypt action
• keysize : key size passed to letsencrypt.sh

The hook letsencrypt_post.sh also has:

• exit_code : exit code of letsencrypt.sh

ssl_save_(pre|post).sh

These hooks are called before/after an SSL is saved.

Environment variables

• username: user
• domain: domain.com
• type(server|create|paste): type of data saved possible values
  • server: domain uses server certificate
  • paste: paste certificate data. This also includes:
    • certificate: private key and certificate separated by a line
  • create: create self-signed certificate or certificate request or Let's Encrypt certificate. This also includes
    • keysize: key size used
    • encryption: which encryption algorithm is used
    • request(yes|no|letsencrypt): make certificate request(yes), or Let's Encrypt request(letsencrypt) or create self-signed certificate(no)
      • for self-singed or certificate request, certificate data is provided:
        • country
        • province
        • city
        • company
        • division
        • name
        • email
      • for Let's Encrypt certificate:
        • wildcard(yes|no): create wildcard Let's Encrypt certificate
        • le_select[X]: Domain names to include into Certificate. le_wc_select[X] format used when Let's Encrypt wildcard is selected