certbot-dns-hetzner 4.0.0a0

This certbot plugin for dns-01 challenge for Hetzner.

Hetzner DNS Authenticator certbot plugin

This certbot plugin automates the process of completing a dns-01 challenge by creating, and subsequently removing, TXT records using the Hetzner Cloud API.

Requirements

Install

Install this package via pip in the same python environment where you installed your certbot.

pip install certbot-dns-hetzner

Usage

To start using DNS authentication for the Hetzner DNS or cloud API, pass the following arguments on certbot's command line:

Option	Description
--authenticator dns-hetzner	select the authenticator plugin (Required)
--dns-hetzner-credentials	Hetzner DNS API credentials INI file. (Required)
--dns-hetzner-propagation-seconds	Seconds to wait for the TXT record to propagate

Please make sure to use the absolute path for the credentials file - some users experienced problems with relative paths.

Version 4.x only supports Hetzner Cloud API

Version 3.x selects either the old DNS API or the new cloud API depending on the provided credentials.
Note: Make sure to use the correct credentials for the different domains. Only one API is working for one domain.

Pre 3.x only the Hetzner DNS API is supported.

Credentials

Generate an API token as described here.

An example credentials.ini file:

dns_hetzner_api_token = nohnah4zoo9Kiejee9aGh0thoopee2sa

Examples

To acquire a certificate for example.com

certbot certonly \\
 --authenticator dns-hetzner \\
 --dns-hetzner-credentials /path/to/my/hetzner.ini \\
 -d example.com

To acquire a certificate for *.example.com

   certbot certonly \\
     --authenticator dns-hetzner \\
     --dns-hetzner-credentials /path/to/my/hetzner.ini \\
     -d '*.example.com'

Troubleshooting

Plugin not showing up

If certbot plugins does not show the installed plugin, you might need to set CERTBOT_PLUGIN_PATH.

CERTBOT_PLUGIN_PATH=/usr/local/lib/python3.X/site-packages/ certbot renew

See letsencrypt community thread

Renewing certificate fails

Please ensure to use an absolute path for the credentials file - some users experienced problems with relative paths.

Not working with snap

We did not nor plan to support snap - it was created from this repo.
Feel free to start a new snap package yourself - we would happily link it here.

Thanks to

Of course certbot, which examples and documentation I used to implement this plugin. And to https://github.com/m42e/certbot-dns-ispconfig which served as an excellent example and README template as well.

and of course to all contributors and people raising issues.