Certbot

Learn about actions >

• deploy

  Run the post-renew deploy hook for a domain.

  Params

  • domain string

    Domain to run the deploy hook for, this must be the primary domain on a certificate that has already been acquired by this unit.

  Required

  domain

• get-certificate

  Acquire a certificate from an ACME service.

  Params

  • agree-tos boolean

    Agree to the terms-of-service. If using Let's Encrypt these can be found at https://letsencrypt.org/repository/. If this is not provided the value of agree-tos in the charm configuration will be used.

  • aws-access-key-id string

    AWS_ACCESS_KEY_ID used to authenticate access to the DNS API when using the dns-route53 plugin. For details please see https://certbot-dns-route53.readthedocs.io/en/stable/#credentials. If this is not provided the value of dns-route53-aws-access-key-id in the charm configuration will be used.

  • aws-secret-access-key string

    AWS_SECRET_ACCESS_KEY used to authenticate access to the DNS API when using the dns-route53 plugin. For details please see https://certbot-dns-route53.readthedocs.io/en/stable/#credentials. If this is not provided the value of dns-route53-aws-secret-access-key in the charm configuration will be used.

  • credentials string

    Base64 encoded credential file used by the plugin to access the DNS API. The contents of this file will be plugin-specific, see the <plugin-name>-credentials fields in the charm configuration for more details. If this is not specified then the plugin-specific field in the charm configuration will be used.

  • domains string

    The domains to create the certificate for. This comma-separated list contains all the domains to add to the certificate. The first domain will be the subject of the certificate. Any additional values will be added to the certificate as alternative names. If this is not provided the value of domain in the charm configuration will be used.

  • email string

    Email address to register the certificates under. If this is not provided the value of email in the charm configuration will be used.

  • plugin string

    Name of the plugin to use to acquire the certificate. If this is not specified then the value of plugin in the charm configuration will be used.

  • propagation-seconds integer

    The number of seconds to wait for DNS to propagate before asking the ACME server to verify the DNS record, if appropriate. If this is not provided the value of propagation-seconds in the charm configuration will be used.