dehydrated-mythic-dns01

KO | EN

gitlite — search

#python #java #python3 #arduino #golang #machine-learning #rust #html #flask #javascript #seismology #nodejs

dehydrated-mythic-dns01

★ 12 Open GitHub ↗

Hook script for the dehydrated Let's Encrypt client to use Mythic Beasts DNS API

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

dehydrated-mythic-dns01
=======================

These are hook scripts for the [dehydrated client](https://github.com/lukas2511/dehydrated)
for verifying Let's Encrypt SSL certificates using 
[DNS validation](https://letsencrypt.github.io/acme-spec/#rfc.section.7.4) with
the [Mythic Beasts](https://www.mythic-beasts.com) DNS API.

This hook supports both [DNS API v2](https://www.mythic-beasts.com/support/api/dnsv2) 
and the older [DNS API v1](https://www.mythic-beasts.com/support/api/dns). We recommend 
that new users use DNS API v2.

A [step-by-step guide](https://www.mythic-beasts.com/support/domains/letsencrypt_dns_01)
to using this script can be found on the [Mythic Beasts](https://www.mythic-beasts.com/)
website.

The script was originally written by [David Earl](https://github.com/davidearl).

Usage
-----

To use these scripts you will need to set a DNS API password or a v2 API token
for your domains using the [Mythic Beasts control panel](https://ctrlpanel.mythic-beasts.com)

If you're setting up tokens for the DNS API v2, you'll need to grant a permit for
a TXT record with the hostname '_acme-challenge' for each domain that requires a
certificate.

Then create the file `/etc/dehydrated/dnsapi.config.txt` containing your domain
name and API credentials.  If you're using DNS API v2, each line should consist
of a domain name, the API Key ID and the API Key Secret, separated by spaces:

````
example.org ahneeWi0aePo2siH aetaj-o2bohshaev8aiDae0Suujoow
example.com ahneeWi0aePo2siH aetaj-o2bohshaev8aiDae0Suujoow
````

If you use the same key for multiple domains, you should repeat the key details, as shown above.

If you are using DNS API v1, each line should be the domain name followed by the API Key password:

```
example.net myS3cretPassword
example.com myOtherS3cretPassword
```

To tell `dehydrated` to use the hook script, provide its path via the `-k`
option. You will also need `-t dns-01` to use DNS-01 validation:

````Shell
dehydrated -c -t dns-01 -k .../path/to/dehydrated-mythic-dns01.sh
````

Or you can set the `HOOK` and `CHALLENGETYPE` configuration variables, by
creating the file `/etc/dehydrated/conf.d/hook.sh` with this content:

````
HOOK=.../path/to/dehydrated-mythic-dns01.sh
CHALLENGETYPE=dns-01
````

If you need to combine this hook with others, take a look at
[dehydrated-code-rack](https://github.com/mythic-beasts/dehydrated-code-rack).
Link to the scripts something like this:

````Shell
for d in common clean-challenge deploy-challenge; do
    mkdir -p /etc/dehydrated/hooks/$d
    ln -s $d/mythic-dns01 /etc/dehydrated/hooks/$d
done
````

This script also supports obtaining certificates for domains not hosted
on Mythic Beasts' DNS service, by adding a CNAME on the `_acme-challenge`
subdomain, pointing to a zone that is hosted with Mythic Beasts.

For example, if you had a domain `example.com` you could add:

```
_acme-challenge.example.com CNAME example-com-acme.dns-zone-on.mythic-beasts.com
```

Then you can specify to update the CNAME target in `/etc/dehydrated/dnsapi.cname-map.txt`:
```
_acme-challenge.example.com example-com-acme.dns-zone-on.mythic-beasts.com
```

The TXT challenge response records will then be added to the CNAME target.

dehydrated-mythic-dns01

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README