1
0
mirror of https://github.com/StackExchange/dnscontrol.git synced 2024-05-11 05:55:12 +00:00
Jeffrey Cafferata b3e684326a DOCS: Clean up formatting and punctuation (#1776)
Co-authored-by: Tom Limoncelli <tlimoncelli@stackoverflow.com>
2022-10-27 16:17:19 -04:00

1.5 KiB

name parameters return
NewRegistrar
name
type
meta
string

NewRegistrar activates a Registrar Provider specified in creds.json. A registrar maintains the domain's registration and delegation (i.e. the nameservers for the domain). DNSControl only manages the delegation.

  • name must match the name of an entry in creds.json.
  • type specifies a valid DNS provider type identifier listed on the provider page.
    • Starting with v3.16, the type is optional. If it is absent, the TYPE field in creds.json is used instead. You can leave it out. (Thanks to JavaScript magic, you can leave it out even when there are more fields).
    • Starting with v4.0, specifying the type may be an error. Please add the TYPE field to creds.json and remove this parameter from dnsconfig.js to prepare.
  • meta is a way to send additional parameters to the provider. It is optional and only certain providers use it. See the individual provider docs for details.

This function will return an opaque string that should be assigned to a variable name for use in D directives.

Prior to v3.16:

var REG_MYNDC = NewRegistrar("mynamedotcom", "NAMEDOTCOM");
var DNS_MYAWS = NewDnsProvider("myaws", "ROUTE53");

D("example.com", REG_MYNDC, DnsProvider(DNS_MYAWS),
  A("@","1.2.3.4")
);

In v3.16 and later:

var REG_MYNDC = NewRegistrar("mynamedotcom");
var DNS_MYAWS = NewDnsProvider("myaws");

D("example.com", REG_MYNDC, DnsProvider(DNS_MYAWS),
  A("@","1.2.3.4")
);