# certbot-dns-firstdomains
First Domains DNS authenticator plugin for Certbot
An authenticator plugin for [certbot][1] to support [Let's Encrypt][2]
DNS challenges (dns-01) for domains managed by the nameservers of [Active24][3].
This plugin is based on the [ISPConfig DNS authenticator][4] by Matthias Bilger.
## Requirements
* certbot (>=0.34.0)
_Note_: it is highly recommended that you install Certbot from PyPI (`pip install certbot`),
rather than your distribution's package manager or Snap or similar - not only is the PyPI
version usually the newest available, but there have been reports of issues with the plugin
when it's installed via PyPI and Certbot is not. If anyone has ideas on how this package
could be improved to fix these compatibility issues, please post an issue, or better yet,
a pull request - any input or help is much appreciated!
## Installation
1. First install the plugin:
```shell
pip install certbot-dns-firstdomains
```
2. Configure it with your First Domains credentials:
```shell
sudo $EDITOR /etc/letsencrypt/firstdomains.ini
```
Paste the following into the configuration file:
```
certbot_dns_firstdomains:dns_firstdomains_username = "your username"
certbot_dns_firstdomains:dns_firstdomains_password = "your password"
```
3. Make sure the file is only readable by root! Otherwise all your domains might be in danger:
```shell
sudo chmod 0600 /etc/letsencrypt/firstdomains.ini
```
## Usage
Request new certificates via a certbot invocation like this:
```shell
sudo certbot certonly -a certbot-dns-firstdomains:dns-firstdomains -d sub.domain.tld -d *.wildcard.tld
```
Renewals will automatically be performed using the same authenticator and credentials by certbot.
## Command Line Options
```
--certbot-dns-firstdomains:dns-firstdomains-credentials PATH_TO_CREDENTIALS
Path to First Domains account credentials INI file
(default: /etc/letsencrypt/firstdomains.ini)
--certbot-dns-firstdomains:dns-firstdomains-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 300.
```
## Removal
```shell
sudo pip uninstall certbot-dns-firstdomains
```
## Development
When releasing a new version, commit all changes, create an appropriate Git tag, and then run
`./release.sh` from the project directory. This will check and prepare your environment,
push the latest code to GitHub, build the distribution package and upload it to PyPI.
[1]: https://certbot.eff.org/
[2]: https://letsencrypt.org/
[4]: https://github.com/m42e/certbot-dns-ispconfig
Raw data
{
"_id": null,
"home_page": null,
"name": "certbot-dns-firstdomains",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "certbot, letsencrypt, dns-01, plugin, authenticator",
"author": null,
"author_email": "Luke McIntyre <hatharry@hotmail.com>",
"download_url": "https://files.pythonhosted.org/packages/e3/31/ce3208403e57c560c4846127718f745d176f504c5cc247f3bf7e829b98c5/certbot_dns_firstdomains-1.0.tar.gz",
"platform": null,
"description": "# certbot-dns-firstdomains\nFirst Domains DNS authenticator plugin for Certbot\n\nAn authenticator plugin for [certbot][1] to support [Let's Encrypt][2] \nDNS challenges (dns-01) for domains managed by the nameservers of [Active24][3].\n\nThis plugin is based on the [ISPConfig DNS authenticator][4] by Matthias Bilger.\n\n## Requirements\n* certbot (>=0.34.0)\n\n_Note_: it is highly recommended that you install Certbot from PyPI (`pip install certbot`),\nrather than your distribution's package manager or Snap or similar - not only is the PyPI\nversion usually the newest available, but there have been reports of issues with the plugin\nwhen it's installed via PyPI and Certbot is not. If anyone has ideas on how this package\ncould be improved to fix these compatibility issues, please post an issue, or better yet,\na pull request - any input or help is much appreciated!\n\n## Installation\n1. First install the plugin:\n ```shell\n pip install certbot-dns-firstdomains\n ```\n\n2. Configure it with your First Domains credentials:\n ```shell\n sudo $EDITOR /etc/letsencrypt/firstdomains.ini\n ```\n Paste the following into the configuration file:\n ```\n certbot_dns_firstdomains:dns_firstdomains_username = \"your username\"\n certbot_dns_firstdomains:dns_firstdomains_password = \"your password\"\n ```\n\n3. Make sure the file is only readable by root! Otherwise all your domains might be in danger:\n ```shell\n sudo chmod 0600 /etc/letsencrypt/firstdomains.ini\n ```\n\n## Usage\nRequest new certificates via a certbot invocation like this:\n\n```shell\nsudo certbot certonly -a certbot-dns-firstdomains:dns-firstdomains -d sub.domain.tld -d *.wildcard.tld\n```\n\nRenewals will automatically be performed using the same authenticator and credentials by certbot.\n\n## Command Line Options\n```\n --certbot-dns-firstdomains:dns-firstdomains-credentials PATH_TO_CREDENTIALS\n Path to First Domains account credentials INI file \n (default: /etc/letsencrypt/firstdomains.ini)\n\n --certbot-dns-firstdomains:dns-firstdomains-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 300.\n```\n\n## Removal\n\n```shell\nsudo pip uninstall certbot-dns-firstdomains\n```\n\n## Development\n\nWhen releasing a new version, commit all changes, create an appropriate Git tag, and then run\n`./release.sh` from the project directory. This will check and prepare your environment,\npush the latest code to GitHub, build the distribution package and upload it to PyPI.\n\n\n[1]: https://certbot.eff.org/\n[2]: https://letsencrypt.org/\n[4]: https://github.com/m42e/certbot-dns-ispconfig\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "First Domains DNS Authenticator plugin for Certbot",
"version": "1.0",
"project_urls": {
"Bug Tracker": "https://github.com/hatharry/certbot-dns-firstdomains/issues",
"Homepage": "https://github.com/hatharry/certbot-dns-firstdomains",
"Repository": "https://github.com/hatharry/certbot-dns-firstdomains.git"
},
"split_keywords": [
"certbot",
" letsencrypt",
" dns-01",
" plugin",
" authenticator"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4e68624b616d53cf5a259ff9da011b6529d08c01d350783ace0a92419f131503",
"md5": "4c931f0902a052cd99a8a4d3dad602db",
"sha256": "0a0edd87ccb74434527a4b7dc7b7bc867774444e250189c2de2cd76b8f3987ff"
},
"downloads": -1,
"filename": "certbot_dns_firstdomains-1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4c931f0902a052cd99a8a4d3dad602db",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 5585,
"upload_time": "2024-11-12T11:54:09",
"upload_time_iso_8601": "2024-11-12T11:54:09.094010Z",
"url": "https://files.pythonhosted.org/packages/4e/68/624b616d53cf5a259ff9da011b6529d08c01d350783ace0a92419f131503/certbot_dns_firstdomains-1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e331ce3208403e57c560c4846127718f745d176f504c5cc247f3bf7e829b98c5",
"md5": "a8ead3e6711ec0baef3358b1a9b1f8e7",
"sha256": "9d589a701d1407af4ce3d8d90c5c2390ac1270e72c6afc74c9a216849735dfb8"
},
"downloads": -1,
"filename": "certbot_dns_firstdomains-1.0.tar.gz",
"has_sig": false,
"md5_digest": "a8ead3e6711ec0baef3358b1a9b1f8e7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 5098,
"upload_time": "2024-11-12T11:54:11",
"upload_time_iso_8601": "2024-11-12T11:54:11.860160Z",
"url": "https://files.pythonhosted.org/packages/e3/31/ce3208403e57c560c4846127718f745d176f504c5cc247f3bf7e829b98c5/certbot_dns_firstdomains-1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-12 11:54:11",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "hatharry",
"github_project": "certbot-dns-firstdomains",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "certbot-dns-firstdomains"
}
JSON
