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.
How to use
1. Install
First, install certbot and the plugin using pip:
pip install certbot certbot-dns-cpanel
2. Configure
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:authenticator_url = https://cpanel.exemple.com:2083
# The cPanel username
certbot_dns_cpanel:authenticator_username = user
# The cPanel password
certbot_dns_cpanel:authenticator_password = hunter2
3. Run
You can now run certbot using the plugin and feeding the credentials file.
For exemple, to get a certificate for exemple.com and www.exemple.com:
certbot certonly \
--authenticator certbot-dns-cpanel:authenticator \
--certbot-dns-cpanel:authenticator-credentials /path/to/credentials.ini \
-d exemple.com \
-d www.exemple.com
To create a wildcard certificate *.exemple.com and install it on an apache server, the installer plugin must be specified with the --installer
option.
You will need to install the apache plugin if it's not already present on your system.
pip install certbot-apache
certbot run \
--apache \
--authenticator certbot-dns-cpanel:authenticator \
--installer apache \
--certbot-dns-cpanel:authenticator-credentials /path/to/credentials.ini \
-d '*.exemple.com'
The certbot documentation has some additionnal informations about combining authenticator and installer plugins: https://certbot.eff.org/docs/using.html#getting-certificates-and-choosing-plugins
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.1.0-2-py3-none-any.whl (4.7 kB) | File type Wheel | Python version py3 | Upload date | Hashes View |
Filename, size certbot-dns-cpanel-0.1.0-2.tar.gz (4.1 kB) | File type Source | Python version None | Upload date | Hashes View |
Hashes for certbot_dns_cpanel-0.1.0-2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | cec44f8c39b53c5dc78b8591905a5201c9106a84c5ae71088569b23eb1678157 |
|
MD5 | 31da045b3f33f08d6e19af92a25cecad |
|
BLAKE2-256 | 10ff7b49f094b68eee483d7e47d97ea9ad2ba1e8f0dfbad8b88330abf8196165 |
Hashes for certbot-dns-cpanel-0.1.0-2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f3eac317852220ec4c73024203ffd972b4ca78854d717cb2c5d5438a89c90a55 |
|
MD5 | 21656136e72254e980090aebc1b7bf43 |
|
BLAKE2-256 | a92d2ba882a31e7ee19750b00c3c69edd72a01dc340ce78f4803207e12e3cfb0 |