lzc256
/
tailscale
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

client/tailscale: document SetDNS more 

Updates #1235

Signed-off-by: Brad Fitzpatrick <bradfitz@tailscale.com>
pull/2088/head
Brad Fitzpatrick 2021-06-08 15:24:53 -07:00
parent 796e222901
commit fc5fba0fbf
1 changed files with 14 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
client/tailscale/tailscale.go
View File

@ -257,7 +257,20 @@ func Logout(ctx context.Context) error {
return err return err
} }
// SetDNS adds a DNS TXT record. // SetDNS adds a DNS TXT record for the given domain name, containing
// the provided TXT value. The intended use case is answering
// LetsEncrypt/ACME dns-01 challenges.
//
// The control plane will only permit SetDNS requests with very
// specific names and values. The name should be
// "_acme-challenge." + your node's MagicDNS name. It's expected that
// clients cache the certs from LetsEncrypt (or whichever CA is
// providing them) and only request new ones as needed; the control plane
// rate limits SetDNS requests.
//
// This is a low-level interface; it's expected that most Tailscale
// users use a higher level interface to getting/using TLS
// certificates.
func SetDNS(ctx context.Context, name, value string) error { func SetDNS(ctx context.Context, name, value string) error {
v := url.Values{} v := url.Values{}
v.Set("name", name) v.Set("name", name)