# certbot-dns-active24
Active24 DNS authenticator plugin for Certbot
An authenticator plugin for [certbot](https://certbot.eff.org/) to support [Let's Encrypt](https://letsencrypt.org/)
DNS challenges (dns-01) for domains managed by the nameservers of [Active24](https://www.active24.cz).
This plugin is based on the [Reg.ru DNS authenticator](https://github.com/free2er/certbot-regru) by Max Pryakhin.
## Requirements
* certbot (>=0.21.1)
_Note_: it is highly recommended that you install Certbot from PyPI (`pip install certbot`), rather than APT -
the version of Certbot distributed through official package manager repositories is usually pretty old compared
to PyPI (for example at the time of writing this, Debian 10 Buster provides Certbot version 0.31.0, whereas
the version availiable through PyPI is 1.12.0).
## Installation
1. First install the plugin:
```
pip install certbot-dns-active24
```
2. Configure it with your Active24 credentials:
```
sudo $EDITOR /etc/letsencrypt/active24.ini
```
Paste the following into the configuration file:
```
dns_active24_token="your-token"
```
3. Make sure the file is only readable by root! Otherwise all your domains might be in danger:
```
sudo chmod 0600 /etc/letsencrypt/active24.ini
```
## Usage
Request new certificates via a certbot invocation like this:
sudo certbot certonly -a dns-active24 -d sub.domain.tld -d *.wildcard.tld
Renewals will automatically be performed using the same authenticator and credentials by certbot.
## Note on parameter naming
For reasons beyond my comprehension some Certbot installations don't recognise the plugin when you specify it using
the abovementioned `-a dns-active24`. If Certbot complains that it can't find the plugin under that name, you need
to prefix it with the full plugin name. And even that isn't as straightforward as one could hope, because you need
to prefix both the plugin name on the command line and the plugin options in the config file, but each time with
a different variation of the prefix:
* In the config file you need to use `underscore_delimited_plugin_name`, so e.g. `certbot_dns_active24:dns_active24_token="your-token"`
* On the command line you need to use `dash-delimited-plugin-name`, so e.g. `-a certbot-dns-active24:dns-active24`
If you know how this can be fixed to work consistently across all installations, please reach out and help me do it via issue #7.
## Command Line Options
```
--dns-active24-credentials PATH_TO_CREDENTIALS
Path to Active24 account credentials INI file
(default: /etc/letsencrypt/active24.ini)
--dns-active24-propagation-seconds SECONDS
The number of seconds to wait for DNS record changes
to propagate before asking the ACME server to verify
the DNS record. Default 0. Do not use this, the plugin
actually checks the authoritative nameservers repeatedly
to ensure the changes have propagated, regardless of
this setting.
```
See also `certbot --help dns-active24` for further information.
## Removal
```
sudo pip uninstall certbot-dns-active24
```
## Development
When releasing a new version, run `./release.sh <type>` from the project directory; `<type>` can be
either `major`, `minor` or `patch`. This will update the `__version__` constant in `certbot_dns_active24/__init__.py`,
commit the change and create an appropriate Git tag; next it will push these changes to the upstream repository,
cleanup the `dist` directory, run `python setup.py sdist`, install `twine` if it isn't already installed and
upload the latest release to PyPI.
Raw data
{
"_id": null,
"home_page": "https://github.com/jahudka/certbot-dns-active24",
"name": "certbot-dns-active24",
"maintainer": "",
"docs_url": null,
"requires_python": ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*",
"maintainer_email": "",
"keywords": "certbot letsencrypt dns-01 plugin",
"author": "Dan Kadera",
"author_email": "me@subsonic.cz",
"download_url": "https://files.pythonhosted.org/packages/35/cb/6a59516be49670d659266441e5b6c87aa980e1b21f2936ad0330d017f59d/certbot-dns-active24-1.5.0.tar.gz",
"platform": null,
"description": "# certbot-dns-active24\nActive24 DNS authenticator plugin for Certbot\n\nAn authenticator plugin for [certbot](https://certbot.eff.org/) to support [Let's Encrypt](https://letsencrypt.org/) \nDNS challenges (dns-01) for domains managed by the nameservers of [Active24](https://www.active24.cz).\n\nThis plugin is based on the [Reg.ru DNS authenticator](https://github.com/free2er/certbot-regru) by Max Pryakhin.\n\n## Requirements\n* certbot (>=0.21.1)\n\n_Note_: it is highly recommended that you install Certbot from PyPI (`pip install certbot`), rather than APT -\nthe version of Certbot distributed through official package manager repositories is usually pretty old compared\nto PyPI (for example at the time of writing this, Debian 10 Buster provides Certbot version 0.31.0, whereas\nthe version availiable through PyPI is 1.12.0).\n\n## Installation\n1. First install the plugin:\n ```\n pip install certbot-dns-active24\n ```\n\n2. Configure it with your Active24 credentials:\n ```\n sudo $EDITOR /etc/letsencrypt/active24.ini\n ```\n Paste the following into the configuration file:\n ```\n dns_active24_token=\"your-token\"\n ```\n\n3. Make sure the file is only readable by root! Otherwise all your domains might be in danger:\n ```\n sudo chmod 0600 /etc/letsencrypt/active24.ini\n ```\n\n## Usage\nRequest new certificates via a certbot invocation like this:\n\n sudo certbot certonly -a dns-active24 -d sub.domain.tld -d *.wildcard.tld\n\nRenewals will automatically be performed using the same authenticator and credentials by certbot.\n\n## Note on parameter naming\nFor reasons beyond my comprehension some Certbot installations don't recognise the plugin when you specify it using\nthe abovementioned `-a dns-active24`. If Certbot complains that it can't find the plugin under that name, you need\nto prefix it with the full plugin name. And even that isn't as straightforward as one could hope, because you need\nto prefix both the plugin name on the command line and the plugin options in the config file, but each time with\na different variation of the prefix:\n\n* In the config file you need to use `underscore_delimited_plugin_name`, so e.g. `certbot_dns_active24:dns_active24_token=\"your-token\"`\n* On the command line you need to use `dash-delimited-plugin-name`, so e.g. `-a certbot-dns-active24:dns-active24`\n\nIf you know how this can be fixed to work consistently across all installations, please reach out and help me do it via issue #7.\n\n## Command Line Options\n```\n --dns-active24-credentials PATH_TO_CREDENTIALS\n Path to Active24 account credentials INI file \n (default: /etc/letsencrypt/active24.ini)\n\n --dns-active24-propagation-seconds SECONDS\n The number of seconds to wait for DNS record changes\n to propagate before asking the ACME server to verify\n the DNS record. Default 0. Do not use this, the plugin\n actually checks the authoritative nameservers repeatedly\n to ensure the changes have propagated, regardless of\n this setting.\n```\n\nSee also `certbot --help dns-active24` for further information.\n\n## Removal\n ```\n sudo pip uninstall certbot-dns-active24\n ```\n\n## Development\n\nWhen releasing a new version, run `./release.sh <type>` from the project directory; `<type>` can be\neither `major`, `minor` or `patch`. This will update the `__version__` constant in `certbot_dns_active24/__init__.py`,\ncommit the change and create an appropriate Git tag; next it will push these changes to the upstream repository,\ncleanup the `dist` directory, run `python setup.py sdist`, install `twine` if it isn't already installed and\nupload the latest release to PyPI. \n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Active24 DNS authenticator plugin for Certbot",
"version": "1.5.0",
"split_keywords": [
"certbot",
"letsencrypt",
"dns-01",
"plugin"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "35cb6a59516be49670d659266441e5b6c87aa980e1b21f2936ad0330d017f59d",
"md5": "652a2fc83b3fe1b01920a63a9470368a",
"sha256": "827e4dcc11696fdbcf783029ed40a70cbeb19c83fb1313c037c7bc093113ef72"
},
"downloads": -1,
"filename": "certbot-dns-active24-1.5.0.tar.gz",
"has_sig": false,
"md5_digest": "652a2fc83b3fe1b01920a63a9470368a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*",
"size": 8453,
"upload_time": "2023-01-16T10:10:21",
"upload_time_iso_8601": "2023-01-16T10:10:21.186739Z",
"url": "https://files.pythonhosted.org/packages/35/cb/6a59516be49670d659266441e5b6c87aa980e1b21f2936ad0330d017f59d/certbot-dns-active24-1.5.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-16 10:10:21",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "jahudka",
"github_project": "certbot-dns-active24",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "certbot-dns-active24"
}
JSON
