2020-04-19 15:57:48 +00:00
# certbot-dns-corenetworks
2021-01-17 14:23:46 +00:00
[![Build Status ](https://img.shields.io/drone/build/thegeeklab/certbot-dns-corenetworks?logo=drone&server=https%3A%2F%2Fdrone.thegeeklab.de )](https://drone.thegeeklab.de/thegeeklab/certbot-dns-corenetworks)
2020-04-19 15:57:48 +00:00
[![Python Version ](https://img.shields.io/pypi/pyversions/certbot-dns-corenetworks.svg )](https://pypi.org/project/certbot-dns-corenetworks/)
[![PyPi Status ](https://img.shields.io/pypi/status/certbot-dns-corenetworks.svg )](https://pypi.org/project/certbot-dns-corenetworks/)
[![PyPi Release ](https://img.shields.io/pypi/v/certbot-dns-corenetworks.svg )](https://pypi.org/project/certbot-dns-corenetworks/)
2020-09-24 19:19:25 +00:00
[![Codecov ](https://img.shields.io/codecov/c/github/thegeeklab/certbot-dns-corenetworks )](https://codecov.io/gh/thegeeklab/certbot-dns-corenetworks)
[![GitHub contributors ](https://img.shields.io/github/contributors/thegeeklab/certbot-dns-corenetworks )](https://github.com/thegeeklab/certbot-dns-corenetworks/graphs/contributors)
2021-01-01 22:49:54 +00:00
[![License: MIT ](https://img.shields.io/github/license/thegeeklab/certbot-dns-corenetworks )](https://github.com/thegeeklab/certbot-dns-corenetworks/blob/main/LICENSE)
2020-04-19 15:57:48 +00:00
2020-04-19 16:08:02 +00:00
## Install
Install this package via pip in the same python environment where you installed your certbot.
```console
pip install certbot-dns-corenetworks
```
## Usage
To start using DNS authentication for the Core Networks DNS API, pass the following arguments on certbot's command line:
2021-01-17 14:10:33 +00:00
| Option | Description |
| ---------------------------------------- | ------------------------------------------------ |
2021-01-01 23:09:37 +00:00
| `--authenticator dns-corenetworks` | select the authenticator plugin (Required) |
| `--dns-corenetworks-credentials` | Hetzner DNS API credentials INI file. (Required) |
| `--dns-corenetworks-propagation-seconds` | Seconds to wait for the TXT record to propagate |
2020-04-19 16:08:02 +00:00
## Credentials
```ini
2021-01-01 23:09:37 +00:00
dns_corenetworks_username = asaHB12r
dns_corenetworks_password = secure_passwor
2020-04-19 16:08:02 +00:00
```
## Examples
To acquire a certificate for `example.com`
```bash
2021-01-01 22:39:20 +00:00
certbot certonly \
2021-01-01 23:09:37 +00:00
--authenticator dns-corenetworks \
--dns-corenetworks-credentials /path/to/my/credentials.ini \
2020-04-19 16:08:02 +00:00
-d example.com
```
2021-01-01 22:39:20 +00:00
To acquire a certificate for `*.example.com`
2020-04-19 16:08:02 +00:00
```bash
2021-01-01 22:39:20 +00:00
certbot certonly \
2021-01-01 23:09:37 +00:00
--authenticator dns-corenetworks \
--dns-corenetworks-credentials /path/to/my/credentials.ini \
2020-04-19 16:08:02 +00:00
-d '*.example.com'
```
2020-09-24 19:19:25 +00:00
## Contributors
2020-04-19 15:57:48 +00:00
2021-01-01 22:43:22 +00:00
Special thanks goes to all [contributors ](https://github.com/thegeeklab/certbot-dns-corenetworks/graphs/contributors ). If you would like to contribute,
please see the [instructions ](https://github.com/thegeeklab/certbot-dns-corenetworks/blob/main/CONTRIBUTING.md ).
2020-04-19 15:57:48 +00:00
2020-09-24 19:19:25 +00:00
## License
2020-04-19 15:57:48 +00:00
2021-01-01 22:49:54 +00:00
This project is licensed under the MIT License - see the [LICENSE ](https://github.com/thegeeklab/certbot-dns-corenetworks/blob/main/LICENSE ) file for details.