Certbot

Learn about configurations >

• agree-tos | boolean

  Agree to the terms-of-service. If using Let's Encrypt these can be found at https://letsencrypt.org/repository/

• cert-path | string

  Path to which the certificate will be copied. If this path is an existing directory then the certificate will be copied into a file named <domain>.crt in that directory.

• chain-path | string

  Path to which the certificate chain will be copied. If this path is an existing directory then the certificate chain will be copied into a file named <domain>_chain.pem in that directory.

• combined-path | string

  Path to which the combined full certificate chain and private key will be copied. If this path is an existing directory then the combined full certificate chain and key will be copied into a file named <domain>.pem in that directory.

• deploy-command | string

  Command to run to deploy a certificate following a successful acquisition or renewal.

• dns-google-credentials | string

  Base64 encoded credential file used by the dns-google plugin to access the DNS system. For details of this file please see https://certbot-dns-google.readthedocs.io/en/stable/#credentials

• dns-rfc2136-credentials | string

  Base64 encoded credential file used by the dns-rfc2136 plugin to access the DNS system. For details of this file please see https://certbot-dns-rfc2136.readthedocs.io/en/stable/#credentials

• dns-route53-aws-access-key-id | string

  AWS_ACCESS_KEY_ID used by dns-route53 plugin to authenticate access to the DNS API. For details please see https://certbot-dns-route53.readthedocs.io/en/stable/#credentials

• dns-route53-aws-secret-access-key | string

  AWS_ACCESS_SECRET_KEY used by dns-route53 plugin to authenticate access to the DNS API. For details please see https://certbot-dns-route53.readthedocs.io/en/stable/#credentials

• 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 names will be added to the certificate as alternative names.

• email | string

  Email address to register the certificates under.

• fullchain-path | string

  Path to which the full certificate chain will be copied. If this path is an existing directory then the full certificate chain will be copied into a file named <domain>_fullchain.pem in that directory.

• key-path | string

  Path to which the private key will be copied. If this path is an existing directory then the private key will be copied into a file named <domain>.key in that directory.

• plugin | string

  The authenticator plugin to use to obtain (and renew) the ceritificate. The currently supported plugins are dns-google, dns-rfc2136 & dns-route53.

• propagation-seconds | int

  Default: 60

  The number of seconds to wait for DNS to propagate before asking the ACME server to verify the DNS record.