github
/
certbot-dns-corenetworks
mirror of https://github.com/thegeeklab/certbot-dns-corenetworks.git
0
0
Fork 0
Code Issues Releases Activity

add basic usage and examples

This commit is contained in:
Robert Kaussow 2020-04-19 18:08:02 +02:00
parent 197cdd2b06
commit 33ded01009
1 changed files with 47 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
README.md
View File

@ -4,11 +4,57 @@
[![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/)
[![Codecov](https://img.shields.io/codecov/c/github/xoxys/certbot-dns-corenetworks)](https://codecov.io/gh/xoxys/certbot-dns-corenetworks)
[![License: MIT](https://img.shields.io/github/license/xoxys/certbot-dns-corenetworks)](LICENSE)
## 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:
| Option | Description |
|----------------------------------------------------------------------|--------------------------------------------------|
| `--authenticator certbot-dns-corenetworks:dns-corenetworks` | select the authenticator plugin (Required) |
| `--certbot-dns-corenetworks:dns-corenetworks-credentials` | Hetzner DNS API credentials INI file. (Required) |
| `--certbot-dns-corenetworks:dns-corenetworks-propagation-seconds` | Seconds to wait for the TXT record to propagate |
## Credentials
```ini
certbot_dns_corenetworks:dns_corenetworks_username = asaHB12r
certbot_dns_corenetworks:dns_corenetworks_password = secure_passwor
```
## Examples
To acquire a certificate for `example.com`
```bash
certbot certonly \\
--authenticator certbot-dns-corenetworks:dns-corenetworks \\
--certbot-dns-corenetworks:dns-corenetworks-credentials /path/to/my/credentials.ini \\
-d example.com
```
To acquire a certificate for ``*.example.com``
```bash
certbot certonly \\
--authenticator certbot-dns-corenetworks:dns-corenetworks \\
--certbot-dns-corenetworks:dns-corenetworks-credentials /path/to/my/credentials.ini \\
-d '*.example.com'
```
## License
This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## Maintainers and Contributors