A Synergy Wholesale DNS plugin for Cerbot to authenticate and retrieve Lets Encrypt certificates
Project description
certbot-dns-synergy-wholesale
A Synergy Wholesale DNS plugin for Cerbot to authenticate and retrieve Lets Encrypt certificates. Automates the process of completing a dns-01
challenge by creating, and subsequently removing, TXT
records
Installation
# create a virtual environment, to avoid conflicts
python3 -m venv /some/path
# use the pip in the virtual environment to install or update
/some/path/bin/pip install -U certbot-dns-synergy-wholesale
# use the cerbot from the virtualenv, to avoid accidentally
# using one from a different environment that does not have this library
/some/path/bin/certbot
Named Arguments
To start using DNS authentication for Synergy Wholesale, pass the following arguments on certbot's command line:
Option | Description |
---|---|
--authenticator dns-synergy-wholesale |
select the authenticator plugin (Required) |
--dns-synergy-wholesale-credentials FILE |
credentials INI file. (Required) |
Credentials
Use of this plugin requires a configuration file containing API credentials, obtained from your manage.synergywholesale.com.
Warning: You must whitelist the IP address from where certbot will run, Otherwise you'll run into API errors.
Remember this file will need to have 600 permissions.
An example credentials.ini
file:
dns_synergy_wholesale_reseller_id = 1
dns_synergy_wholesale_api_key = abc123
Examples
To acquire a single certificate for both example.com
and *.example.com
certbot certonly \
--authenticator dns-synergy-wholesale \
--dns-synergy-wholesale-credentials /path/to/credentials.ini \
-d 'example.com' \
-d '*.example.com'
You can also add addtional paramaters such as --keep-until-expiring --non-interactive --expand
for automation. More information here
Docker
You can build a docker image from source using the included Dockerfile
or pull the latest version directly from Docker Hub:
docker pull alamellama/certbot-dns-synergy-wholesale
Once that's finished, the application can be run as follows:
docker run --rm \
-v /var/lib/letsencrypt:/var/lib/letsencrypt \
-v /etc/letsencrypt:/etc/letsencrypt \
--cap-drop=all \
alamellama/certbot-dns-synergy-wholesale certbot certonly \
--authenticator dns-synergy-wholesale \
--dns-synergy-wholesale-credentials /var/lib/letsencrypt/credentials.ini \
--keep-until-expiring --non-interactive --expand \
--server https://acme-v02.api.letsencrypt.org/directory \
--agree-tos --email "webmaster@example.com" \
-d example.com -d '*.example.com'
You may want to change the volumes /var/lib/letsencrypt
and /etc/letsencrypt
to local directories where the certificates and configuration should be stored.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for certbot_dns_synergy_wholesale-1.0.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 18e66bb1645f8bce60f4911aaa27cf7e98e54f1d66e86be7087cb66b77693150 |
|
MD5 | 2432ca0a19a7d93eaaba0bc2476959f9 |
|
BLAKE2b-256 | 9f66e9988692c6ac200f78e3dddaa3edafc3668138e6f14d69771a6afbb7a918 |
Hashes for certbot_dns_synergy_wholesale-1.0.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 00d43d7f126aa2c300159c8892d7b5bb9e39b7eb7740107e2fe1d4d850bd1afd |
|
MD5 | 1efccd2f81e8df4bc89eeb1eca7ed45f |
|
BLAKE2b-256 | 92783b94bc02dd97e08d3f43420386d2900b0e7e91f601d1f1b30689a737b3da |