# certbot-dns-vultr
This package provides a Certbot authenticator plugin
that can complete the DNS-01 challenge using the Vultr API.
## Installation
Use pip to install this package:
```
$ sudo pip3 install certbot-dns-vultr
```
Verify the installation with Certbot:
```
$ sudo certbot plugins
```
You should see `certbot-dns-vultr:dns-vultr` in the output.
## Usage
To use this plugin, set the authenticator to `certbot-dns-vultr:dns-vultr` via the `-a` or `--authenticator` flag.
You may also set this using Certbot's configuration file (defaults to `/etc/letsencrypt/cli.ini`).
You will also need to provide a credentials file with your Vultr API key, like the following:
```
certbot_dns_vultr:dns_vultr_key = YOUR_VULTR_API_KEY
```
The path to this file can be provided interactively or via the `--certbot-dns-vultr:dns-vultr-credentials` argument.
**CAUTION:**
Protect your API key as you would the password to your account.
Anyone with access to this file can make API calls on your behalf.
Be sure to **read the security tips below**.
### Arguments
- `--certbot-dns-vultr:dns-vultr-credentials` path to Vultr credentials INI file (Required)
- `--certbot-dns-vultr:dns-vultr-propagation-seconds` seconds to wait before verifying the DNS record (Default: 10)
**NOTE:** Due to a [limitation in Certbot](https://github.com/certbot/certbot/issues/4351),
these arguments *cannot* be set via Certbot's configuration file.
### Example
```
$ certbot certonly \
-a certbot-dns-vultr:dns-vultr \
--certbot-dns-vultr:dns-vultr-credentials ~/.secrets/certbot/vultr.ini \
-d example.com
```
### Security Tips
**Restrict access of your credentials file to the owner.**
You can do this using `chmod 600`.
Certbot will emit a warning if the credentials file
can be accessed by other users on your system.
**Use a separate key from your account's primary API key.**
Make a separate user under your account,
and limit its access to only allow DNS access
and the IP address of the machine(s) that will be using it.
Raw data
{
"_id": null,
"home_page": "https://github.com/lezgomatt/certbot-dns-vultr",
"name": "certbot-dns-vultr",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "",
"author": "Matt",
"author_email": "lezgomatt@gmail.com",
"download_url": "",
"platform": null,
"description": "# certbot-dns-vultr\n\nThis package provides a Certbot authenticator plugin\nthat can complete the DNS-01 challenge using the Vultr API.\n\n\n## Installation\n\nUse pip to install this package:\n```\n$ sudo pip3 install certbot-dns-vultr\n```\n\nVerify the installation with Certbot:\n```\n$ sudo certbot plugins\n```\nYou should see `certbot-dns-vultr:dns-vultr` in the output.\n\n\n## Usage\n\nTo use this plugin, set the authenticator to `certbot-dns-vultr:dns-vultr` via the `-a` or `--authenticator` flag.\nYou may also set this using Certbot's configuration file (defaults to `/etc/letsencrypt/cli.ini`).\n\nYou will also need to provide a credentials file with your Vultr API key, like the following:\n```\ncertbot_dns_vultr:dns_vultr_key = YOUR_VULTR_API_KEY\n```\nThe path to this file can be provided interactively or via the `--certbot-dns-vultr:dns-vultr-credentials` argument.\n\n**CAUTION:**\nProtect your API key as you would the password to your account.\nAnyone with access to this file can make API calls on your behalf.\nBe sure to **read the security tips below**.\n\n\n### Arguments\n\n- `--certbot-dns-vultr:dns-vultr-credentials` path to Vultr credentials INI file (Required)\n- `--certbot-dns-vultr:dns-vultr-propagation-seconds` seconds to wait before verifying the DNS record (Default: 10)\n\n**NOTE:** Due to a [limitation in Certbot](https://github.com/certbot/certbot/issues/4351),\nthese arguments *cannot* be set via Certbot's configuration file.\n\n\n### Example\n\n```\n$ certbot certonly \\\n -a certbot-dns-vultr:dns-vultr \\\n --certbot-dns-vultr:dns-vultr-credentials ~/.secrets/certbot/vultr.ini \\\n -d example.com\n```\n\n\n### Security Tips\n\n**Restrict access of your credentials file to the owner.**\nYou can do this using `chmod 600`.\nCertbot will emit a warning if the credentials file\ncan be accessed by other users on your system.\n\n**Use a separate key from your account's primary API key.**\nMake a separate user under your account,\nand limit its access to only allow DNS access\nand the IP address of the machine(s) that will be using it.\n",
"bugtrack_url": null,
"license": "Zlib",
"summary": "Vultr DNS authenticator plugin for Certbot",
"version": "1.1.0",
"project_urls": {
"Homepage": "https://github.com/lezgomatt/certbot-dns-vultr"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5b03da71df52ea53a6883e12b2d3f61f23ce92584aef7363011bae1fdd6471bc",
"md5": "22c835274759be383e55e7a49f154de7",
"sha256": "b7cae54974d8fb7173bf2ce5e8b1beed0a4b5fb3ef1e09e52dd6e3bbedb721b9"
},
"downloads": -1,
"filename": "certbot_dns_vultr-1.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "22c835274759be383e55e7a49f154de7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 5018,
"upload_time": "2023-05-29T12:29:23",
"upload_time_iso_8601": "2023-05-29T12:29:23.055708Z",
"url": "https://files.pythonhosted.org/packages/5b/03/da71df52ea53a6883e12b2d3f61f23ce92584aef7363011bae1fdd6471bc/certbot_dns_vultr-1.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-29 12:29:23",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "lezgomatt",
"github_project": "certbot-dns-vultr",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "certbot-dns-vultr"
}
JSON
