|
|
|
# acme4netvs documentation
|
|
|
|
|
|
|
|
To obtain TLS certificates using the [DNS-01]() challenge of the [ACME protocol]() (as
|
|
|
|
used by [Let's Encrypt]()) an [ACME client]() needs to create specific DNS records.
|
|
|
|
acme4netvs provides plugins for a selected set of ACME clients that perform these
|
|
|
|
DNS-01 challenges against KIT's DNS infrastructure.
|
|
|
|
To obtain TLS certificates using the
|
|
|
|
[DNS-01](https://letsencrypt.org/docs/challenge-types/#dns-01-challenge)
|
|
|
|
challenge of the [ACME protocol](https://en.wikipedia.org/wiki/Automated_Certificate_Management_Environment)
|
|
|
|
(as used by [Let's Encrypt](https://letsencrypt.org)) an
|
|
|
|
[ACME client](https://letsencrypt.org/docs/client-options/) needs to create
|
|
|
|
specific DNS records. acme4netvs provides plugins for a selected set of ACME
|
|
|
|
clients that perform these DNS-01 challenges against KIT's DNS infrastructure.
|
|
|
|
|
|
|
|
This plugin creates and deletes the required records to then DNS-01 challenge
|
|
|
|
using the [NETVS]() [API]() (v3.1 and later).
|
|
|
|
This plugin creates and deletes the required records for DNS-01 challenges
|
|
|
|
using the [NETVS API](https://netvs.scc.kit.edu) ([v3.1](https://netvs.scc.kit.edu/swagger) and later).
|
|
|
|
|
|
|
|
## getting started
|
|
|
|
|
|
|
|
Please follow these steps.
|
|
|
|
Please follow these steps…
|
|
|
|
|
|
|
|
### Choose an ACME client
|
|
|
|
### 1. Choose an ACME client
|
|
|
|
|
|
|
|
Let's encrypt maintains a [list of ACME clients](). acme4netvs currently
|
|
|
|
Let's encrypt maintains a [list of ACME
|
|
|
|
clients](https://letsencrypt.org/docs/client-options/). acme4netvs currently
|
|
|
|
supports these clients out-of-the-box:
|
|
|
|
|
|
|
|
* [certbot]()
|
|
|
|
* [dehydrated]()
|
|
|
|
* [certbot](https://certbot.eff.org/)
|
|
|
|
* [dehydrated](https://dehydrated.io/)
|
|
|
|
|
|
|
|
These plugins only differ in their calling convention. To use other ACME
|
|
|
|
clients users may either write their own wrapper scripts or open an issue in
|
| ... | ... | |
| ... | ... | |