Skip to content

Commit

Permalink
Add description for RFC2136 env vars (#385)
Browse files Browse the repository at this point in the history
  • Loading branch information
jraby authored and mholt committed Apr 26, 2017
1 parent 5dfe609 commit b1fd84c
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions providers/dns/rfc2136/rfc2136.go
Original file line number Diff line number Diff line change
Expand Up @@ -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")
Expand Down

0 comments on commit b1fd84c

Please sign in to comment.