From b1fd84c6ffc6896cfd64eca69775bc634d459702 Mon Sep 17 00:00:00 2001 From: jraby Date: Tue, 25 Apr 2017 22:01:22 -0400 Subject: [PATCH] Add description for RFC2136 env vars (#385) --- providers/dns/rfc2136/rfc2136.go | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/providers/dns/rfc2136/rfc2136.go b/providers/dns/rfc2136/rfc2136.go index 43a95f18..1f1af790 100644 --- a/providers/dns/rfc2136/rfc2136.go +++ b/providers/dns/rfc2136/rfc2136.go @@ -23,11 +23,13 @@ type DNSProvider struct { } // NewDNSProvider returns a DNSProvider instance configured for rfc2136 -// dynamic update. Credentials must be passed in the environment variables: -// RFC2136_NAMESERVER, RFC2136_TSIG_ALGORITHM, RFC2136_TSIG_KEY and -// RFC2136_TSIG_SECRET. To disable TSIG authentication, leave the TSIG -// variables unset. RFC2136_NAMESERVER must be a network address in the form -// "host" or "host:port". +// dynamic update. Credentials must be passed in environment variables: +// RFC2136_NAMESERVER: Network address in the form "host" or "host:port". +// RFC2136_TSIG_ALGORITHM: Defaults to hmac-md5.sig-alg.reg.int. (HMAC-MD5). +// See https://github.com/miekg/dns/blob/master/tsig.go for supported values. +// RFC2136_TSIG_KEY: Name of the secret key as defined in DNS server configuration. +// RFC2136_TSIG_SECRET: Secret key payload. +// To disable TSIG authentication, leave the RFC2136_TSIG* variables unset. func NewDNSProvider() (*DNSProvider, error) { nameserver := os.Getenv("RFC2136_NAMESERVER") tsigAlgorithm := os.Getenv("RFC2136_TSIG_ALGORITHM")