- Installation
- Named Arguments
- Credentials
- Retrieving an API Token
- Examples
- Legal Disclaimer
- Contributing
- License
myLoc DNS authenticator plugin for Certbot.
This plugin automates the process of completing a dns-01 challenge by creating, and subsequently removing, TXT records using the myLoc API.
pip install certbot-dns-myloc
To start using DNS authentication for myLoc, pass the following arguments on certbot's command line:
| Option | Description |
|---|---|
--authenticator dns-myloc |
Select the authenticator plugin (Required) |
--dns-myloc-credentials |
myLoc Remote User credentials INI file (Required) |
--dns-myloc-propagation-seconds |
Waiting time for DNS to propagate before asking the ACME server to verify the DNS record. (Default: 10) |
An example myloc.ini file:
dns_myloc_api_token = <api token>
dns_myloc_brand = <myloc|webtropia|servdiscount>The path to this file can be provided interactively or using the
--dns-myloc-credentials command-line argument. Certbot records the
path to this file for use during renewal, but does not store the file's
contents, so if you at some point change the directory of the file make
sure your renewal configs are changed too.
Please make sure that this file can only be accessed by your user.
Go into the appropriate ZKM API management of your myLoc brand:
Click "Create" in the dashboard and set a wanted expiry date of the token and only give it API_DNS_READ and API_DNS_WRITE so the token can only manage your DNS zones.
If you cant access the API management and get send to the normal customer overview please create a support ticket to request API access.
These examples assume you have a ~/.secrets/certbot/myloc.ini file with your credentials set.
certbot certonly --authenticator dns-myloc --dns-myloc-credentials ~/.secrets/certbot/myloc.ini -d example.com
The use of this Certbot plugin is at your own risk. The authors and maintainers of this plugin are not responsible for any damages, losses, or issues that may arise from its use. By using this plugin, you acknowledge and agree to this disclaimer.
If you would like to contribute to this Certbot plugin, feel free to fork the repository, make your changes, and submit a pull request.
This Certbot plugin is open-source software, and its use is governed by the terms of its respective license. Please refer to the LICENSE file in the repository for licensing information. The legal disclaimer has been added under the Legal Disclaimer section to make it clear