2019-03-08 18:47:06 +00:00
---
title: "RFC2136"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: rfc2136
---
<!-- THIS DOCUMENTATION IS AUTO - GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/rfc2136/rfc2136.toml -->
<!-- THIS DOCUMENTATION IS AUTO - GENERATED. PLEASE DO NOT EDIT. -->
2019-04-17 19:32:38 +00:00
Since: v0.3.0
2019-03-08 18:47:06 +00:00
Configuration for [RFC2136 ](https://tools.ietf.org/html/rfc2136 ).
<!-- more -->
- Code: `rfc2136`
2020-12-19 15:48:31 +00:00
Here is an example bash command using the RFC2136 provider:
```bash
RFC2136_NAMESERVER=127.0.0.1 \
RFC2136_TSIG_KEY=lego \
RFC2136_TSIG_ALGORITHM=hmac-sha256. \
RFC2136_TSIG_SECRET=YWJjZGVmZGdoaWprbG1ub3BxcnN0dXZ3eHl6MTIzNDU= \
lego --email myemail@example.com --dns rfc2136 --domains my.example.org run
## ---
keyname=lego; keyfile=lego.key; tsig-keygen $keyname > $keyfile
RFC2136_NAMESERVER=127.0.0.1 \
RFC2136_TSIG_KEY="$keyname" \
RFC2136_TSIG_ALGORITHM="$( awk -F'[ ";]' '/algorithm/ { print $2 }' $keyfile )." \
RFC2136_TSIG_SECRET="$( awk -F'[ ";]' '/secret/ { print $3 }' $keyfile )" \
lego --email myemail@example.com --dns rfc2136 --domains my.example.org run
```
2019-03-08 18:47:06 +00:00
## Credentials
| Environment Variable Name | Description |
|-----------------------|-------------|
| `RFC2136_NAMESERVER` | Network address in the form "host" or "host:port" |
2020-09-29 22:27:08 +00:00
| `RFC2136_TSIG_ALGORITHM` | TSIG algorithm. See [miekg/dns#tsig.go ](https://github.com/miekg/dns/blob/master/tsig.go ) for supported values. To disable TSIG authentication, leave the `RFC2136_TSIG*` variables unset. |
2019-03-08 18:47:06 +00:00
| `RFC2136_TSIG_KEY` | Name of the secret key as defined in DNS server configuration. To disable TSIG authentication, leave the `RFC2136_TSIG*` variables unset. |
| `RFC2136_TSIG_SECRET` | Secret key payload. To disable TSIG authentication, leave the` RFC2136_TSIG*` variables unset. |
2019-03-18 16:42:54 +00:00
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here ](/lego/dns/#configuration-and-credentials ).
2019-03-08 18:47:06 +00:00
## Additional Configuration
| Environment Variable Name | Description |
|--------------------------------|-------------|
| `RFC2136_DNS_TIMEOUT` | API request timeout |
| `RFC2136_POLLING_INTERVAL` | Time between DNS propagation check |
| `RFC2136_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation |
2021-04-25 09:51:37 +00:00
| `RFC2136_SEQUENCE_INTERVAL` | Time between sequential requests |
2019-03-08 18:47:06 +00:00
| `RFC2136_TTL` | The TTL of the TXT record used for the DNS challenge |
2019-03-18 16:42:54 +00:00
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here ](/lego/dns/#configuration-and-credentials ).
2019-03-08 18:47:06 +00:00
## More information
- [API documentation ](https://tools.ietf.org/html/rfc2136 )
<!-- THIS DOCUMENTATION IS AUTO - GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/rfc2136/rfc2136.toml -->
<!-- THIS DOCUMENTATION IS AUTO - GENERATED. PLEASE DO NOT EDIT. -->
