certbot plugin to allow acme dns-01 authentication of a name managed in cPanel.
Project description
certbot-dns-cpanel
Plugin to allow acme dns-01 authentication of a name managed in cPanel. Useful for automating and creating a Let's Encrypt certificate (wildcard or not) for a service with a name managed by cPanel, but installed on a server not managed in cPanel.
Named Arguments
Argument | Description |
---|---|
--certbot-dns-cpanel:cpanel-credentials <file> | cPanel credentials INI file (required) |
--certbot-dns-cpanel:cpanel-propagation-seconds <seconds> | The number of seconds to wait for DNS to propagate before asking the ACME server to verify the DNS record (Default: 30) |
Install
pip install certbot-dns-cpanel
Credentials
Download the file credentials.ini.exemple
and rename it to credentials.ini
. Edit it to set your cPanel url, username and password.
# The url cPanel url
# include the scheme and the port number (usually 2083 for https)
certbot_dns_cpanel:cpanel_url = https://cpanel.exemple.com:2083
# The cPanel username
certbot_dns_cpanel:cpanel_username = user
# The cPanel password
certbot_dns_cpanel:cpanel_password = hunter2
Exemple
You can now run certbot using the plugin and feeding the credentials file.
For exemple, to get a wildcard certificate for *.exemple.com and exemple.com:
certbot certonly \ --authenticator certbot-dns-cpanel:cpanel \ --certbot-dns-cpanel:cpanel-credentials /path/to/credentials.ini \ -d 'exemple.com' \ -d '*.exemple.com'
You can also specify a installer plugin with the --installer
option.
certbot run \ --authenticator certbot-dns-cpanel:cpanel \ --installer apache \ --certbot-dns-cpanel:cpanel-credentials /path/to/credentials.ini \ -d 'exemple.com' \ -d '*.exemple.com'
Docker
A docker image badjware/certbot-dns-cpanel, based on certbot/certbot is provided for your convenience:
docker run -it \ -v /path/to/credentials.ini:/tmp/credentials.ini \ badjware/certbot-dns-cpanel \ certonly \ --authenticator certbot-dns-cpanel:cpanel \ --certbot-dns-cpanel:cpanel-credentials /tmp/credentials.ini \ -d 'exemple.com' \ -d '*.exemple.com'
Additional documentation
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Filename, size | File type | Python version | Upload date | Hashes |
---|---|---|---|---|
Filename, size certbot_dns_cpanel-0.2.2-py2.py3-none-any.whl (8.5 kB) | File type Wheel | Python version py2.py3 | Upload date | Hashes View |
Filename, size certbot-dns-cpanel-0.2.2.tar.gz (4.5 kB) | File type Source | Python version None | Upload date | Hashes View |
Hashes for certbot_dns_cpanel-0.2.2-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | be418293c50f8ea417a0dec7a93e8cccd847d0f34283c3fcf80b5de2b4ebc4ed |
|
MD5 | ff3480f23eafdbe371e9fb054dace868 |
|
BLAKE2-256 | c87b130c158ff800992da345ddb927b532e7ec3765f92effb1f543accccd0f71 |