mirror of
https://github.com/StackExchange/dnscontrol.git
synced 2024-05-11 05:55:12 +00:00
DOCS: Improve consistency in code examples in language reference (#2439)
Co-authored-by: Tom Limoncelli <tal@whatexit.org>
This commit is contained in:
committed by
GitHub
parent
0bf24d0282
commit
7977a7b81c
@ -56,7 +56,7 @@ if (view == "external") {
|
||||
|
||||
/// ...much later...
|
||||
|
||||
D("example.org", REG_NAMECOM, DnsProvider(DNS_NAMECOM), DnsProvider(DNS_BIND),
|
||||
D("example.com", REG_NAMECOM, DnsProvider(DNS_NAMECOM), DnsProvider(DNS_BIND),
|
||||
A("sitea", host01, TTL(1800)),
|
||||
A("siteb", host01, TTL(1800)),
|
||||
A("sitec", host02, TTL(1800)),
|
||||
|
@ -23,7 +23,7 @@ D("example.com", REG_MY_PROVIDER, DnsProvider(DSP_MY_PROVIDER),
|
||||
```javascript
|
||||
var mailTTL = TTL("1h");
|
||||
|
||||
D("example.com", registrar,
|
||||
D("example.com", REG_MY_PROVIDER,
|
||||
NAMESERVER_TTL("10m"), // On domain apex NS RRs
|
||||
DefaultTTL("5m"), // Default for a domain
|
||||
|
||||
@ -107,9 +107,9 @@ D("example.com", REG_MY_PROVIDER, DnsProvider(DSP_R53),
|
||||
## Use SPF_BUILDER to add comments to SPF records ##
|
||||
{% code title="dnsconfig.js" %}
|
||||
```javascript
|
||||
D("example.tld", REG_MY_PROVIDER, DSP, ...
|
||||
D("example.com", REG_MY_PROVIDER, DnsProvider(DSP_MY_PROVIDER),
|
||||
A("@", "10.2.2.2"),
|
||||
MX("@", "example.tld."),
|
||||
MX("@", "example.com."),
|
||||
SPF_BUILDER({
|
||||
label: "@",
|
||||
overflow: "_spf%d",
|
||||
|
@ -36,7 +36,7 @@ This example redirects the bare (aka apex, or naked) domain to www:
|
||||
{% code title="dnsconfig.js" %}
|
||||
```javascript
|
||||
D("example.com", REG_MY_PROVIDER, DnsProvider(DSP_MY_PROVIDER),
|
||||
CF_REDIRECT("mydomain.com/*", "https://www.mydomain.com/$1"),
|
||||
CF_REDIRECT("example.com/*", "https://www.example.com/$1"),
|
||||
);
|
||||
```
|
||||
{% endcode %}
|
||||
|
@ -29,7 +29,7 @@ managed by DNSControl and those that aren't.
|
||||
{% code title="dnsconfig.js" %}
|
||||
```javascript
|
||||
D("example.com", REG_MY_PROVIDER, DnsProvider(DSP_MY_PROVIDER),
|
||||
CF_TEMP_REDIRECT("example.mydomain.com/*", "https://otherplace.yourdomain.com/$1"),
|
||||
CF_TEMP_REDIRECT("example.example.com/*", "https://otherplace.yourdomain.com/$1"),
|
||||
);
|
||||
```
|
||||
{% endcode %}
|
||||
|
@ -13,8 +13,8 @@ See [`IGNORE()`](../domain/IGNORE.md) for more information.
|
||||
|
||||
## Syntax
|
||||
|
||||
```
|
||||
D("example.com", ...
|
||||
```javascript
|
||||
D("example.com", REG_MY_PROVIDER, DnsProvider(DSP_MY_PROVIDER),
|
||||
DISABLE_IGNORE_SAFETY_CHECK,
|
||||
...
|
||||
TXT("myhost", "mytext"),
|
||||
|
@ -70,7 +70,7 @@ General examples:
|
||||
|
||||
{% code title="dnsconfig.js" %}
|
||||
```javascript
|
||||
D("example.com", ...
|
||||
D("example.com", REG_MY_PROVIDER, DnsProvider(DSP_MY_PROVIDER),
|
||||
IGNORE("foo"), // matches any records on foo.example.com
|
||||
IGNORE("baz", "A"), // matches any A records on label baz.example.com
|
||||
IGNORE("*", "MX", "*"), // matches all MX records
|
||||
@ -86,7 +86,7 @@ Ignore Let's Encrypt (ACME) validation records:
|
||||
|
||||
{% code title="dnsconfig.js" %}
|
||||
```javascript
|
||||
D("example.com", ...
|
||||
D("example.com", REG_MY_PROVIDER, DnsProvider(DSP_MY_PROVIDER),
|
||||
IGNORE("_acme-challenge", "TXT"),
|
||||
IGNORE("_acme-challenge.**", "TXT"),
|
||||
END);
|
||||
@ -97,7 +97,7 @@ Ignore DNS records typically inserted by Microsoft ActiveDirectory:
|
||||
|
||||
{% code title="dnsconfig.js" %}
|
||||
```javascript
|
||||
D("example.com", ...
|
||||
D("example.com", REG_MY_PROVIDER, DnsProvider(DSP_MY_PROVIDER),
|
||||
IGNORE("_gc", "SRV"), // General Catalog
|
||||
IGNORE("_gc.**", "SRV"), // General Catalog
|
||||
IGNORE("_kerberos", "SRV"), // Kerb5 server
|
||||
@ -128,7 +128,7 @@ using DNSControl notation for the records. Pretend some other system inserted th
|
||||
|
||||
{% code title="dnsconfig.js" %}
|
||||
```javascript
|
||||
D("example.com", ...
|
||||
D("example.com", REG_MY_PROVIDER, DnsProvider(DSP_MY_PROVIDER),
|
||||
A("@", "151.101.1.69"),
|
||||
A("www", "151.101.1.69"),
|
||||
A("foo", "1.1.1.1"),
|
||||
@ -261,7 +261,7 @@ This will generate an error:
|
||||
|
||||
{% code title="dnsconfig.js" %}
|
||||
```javascript
|
||||
D("example.com", ...
|
||||
D("example.com", REG_MY_PROVIDER, DnsProvider(DSP_MY_PROVIDER),
|
||||
...
|
||||
TXT("myhost", "mytext"),
|
||||
IGNORE("myhost", "*", "*"), // Error! Ignoring an item we inserted
|
||||
@ -274,7 +274,7 @@ to the `D()`.
|
||||
|
||||
{% code title="dnsconfig.js" %}
|
||||
```javascript
|
||||
D("example.com", ...
|
||||
D("example.com", REG_MY_PROVIDER, DnsProvider(DSP_MY_PROVIDER),
|
||||
DISABLE_IGNORE_SAFETY_CHECK,
|
||||
...
|
||||
TXT("myhost", "mytext"),
|
||||
|
@ -102,7 +102,7 @@ The coordinate format for `LOC()` is:
|
||||
|
||||
{% code title="dnsconfig.js" %}
|
||||
```javascript
|
||||
D("example.com","none"
|
||||
D("example.com", REG_MY_PROVIDER, DnsProvider(DSP_MY_PROVIDER),
|
||||
// LOC "subdomain", d1, m1, s1, "[NnSs]", d2, m2, s2, "[EeWw]", alt, siz, hp, vp)
|
||||
//42 21 54 N 71 06 18 W -24m 30m
|
||||
, LOC("@", 42, 21, 54, "N", 71, 6, 18, "W", -24, 30, 0, 0)
|
||||
|
@ -83,7 +83,7 @@ It looks like this:
|
||||
{% code title="dnsconfig.js" %}
|
||||
```javascript
|
||||
var REG_THIRDPARTY = NewRegistrar("ThirdParty");
|
||||
D("mydomain.com", REG_THIRDPARTY,
|
||||
D("example.com", REG_THIRDPARTY,
|
||||
...
|
||||
)
|
||||
```
|
||||
|
@ -25,7 +25,7 @@ parameter_types:
|
||||
{% code title="dnsconfig.js" %}
|
||||
```javascript
|
||||
D("example.com", REG_MY_PROVIDER, DnsProvider("DNS_BIND"),
|
||||
SOA("@", "ns3.example.org.", "hostmaster@example.org", 3600, 600, 604800, 1440),
|
||||
SOA("@", "ns3.example.com.", "hostmaster@example.com", 3600, 600, 604800, 1440),
|
||||
);
|
||||
```
|
||||
{% endcode %}
|
||||
|
@ -25,8 +25,8 @@ Priority, weight, and port are ints.
|
||||
D("example.com", REG_MY_PROVIDER, DnsProvider("GCLOUD"),
|
||||
// Create SRV records for a a SIP service:
|
||||
// pr w port, target
|
||||
SRV("_sip._tcp", 10, 60, 5060, "bigbox.example.tld."),
|
||||
SRV("_sip._tcp", 10, 20, 5060, "smallbox1.example.tld."),
|
||||
SRV("_sip._tcp", 10, 60, 5060, "bigbox.example.com."),
|
||||
SRV("_sip._tcp", 10, 20, 5060, "smallbox1.example.com."),
|
||||
);
|
||||
```
|
||||
{% endcode %}
|
||||
|
@ -41,7 +41,7 @@ var GOOGLE_APPS_DOMAIN_MX = [
|
||||
MX("@", 10, "alt4.aspmx.l.google.com."),
|
||||
]
|
||||
|
||||
D("example.com", REGISTRAR, DnsProvider(r53),
|
||||
D("example.com", REG_MY_PROVIDER, DnsProvider(r53),
|
||||
A("@","1.2.3.4"),
|
||||
CNAME("test", "foo.example2.com."),
|
||||
GOOGLE_APPS_DOMAIN_MX
|
||||
|
@ -23,7 +23,7 @@ of the call.
|
||||
```javascript
|
||||
require("kubernetes/clusters.js");
|
||||
|
||||
D("mydomain.net", REG_MY_PROVIDER, PROVIDER,
|
||||
D("example.com", REG_MY_PROVIDER, PROVIDER,
|
||||
IncludeKubernetes()
|
||||
);
|
||||
```
|
||||
@ -77,8 +77,8 @@ for (var domain in domains) {
|
||||
{% code title="domain-ip-map.json" %}
|
||||
```javascript
|
||||
{
|
||||
"mydomain.net": "1.1.1.1",
|
||||
"myotherdomain.org": "5.5.5.5"
|
||||
"example.com": "1.1.1.1",
|
||||
"other-example.com``": "5.5.5.5"
|
||||
}
|
||||
```
|
||||
{% endcode %}
|
||||
|
@ -28,7 +28,7 @@ For example you can use:
|
||||
```javascript
|
||||
CAA_BUILDER({
|
||||
label: "@",
|
||||
iodef: "mailto:test@domain.tld",
|
||||
iodef: "mailto:test@example.com",
|
||||
iodef_critical: true,
|
||||
issue: [
|
||||
"letsencrypt.org",
|
||||
@ -51,7 +51,7 @@ The parameters are:
|
||||
|
||||
{% code title="dnsconfig.js" %}
|
||||
```javascript
|
||||
CAA("@", "iodef", "mailto:test@domain.tld", CAA_CRITICAL)
|
||||
CAA("@", "iodef", "mailto:test@example.com", CAA_CRITICAL)
|
||||
CAA("@", "issue", "letsencrypt.org")
|
||||
CAA("@", "issue", "comodoca.com")
|
||||
CAA("@", "issuewild", ";")
|
||||
|
@ -41,8 +41,8 @@ The White House:
|
||||
|
||||
{% code title="dnsconfig.js" %}
|
||||
```javascript
|
||||
D("example.com","none"
|
||||
, LOC_BUILDER_DD({
|
||||
D("example.com", REG_MY_PROVIDER, DnsProvider(DSP_MY_PROVIDER),
|
||||
LOC_BUILDER_DD({
|
||||
label: "big-ben",
|
||||
x: 51.50084265331501,
|
||||
y: -0.12462541415599787,
|
||||
|
@ -35,7 +35,7 @@ Note that the following are acceptable forms (symbols differ):
|
||||
|
||||
{% code title="dnsconfig.js" %}
|
||||
```javascript
|
||||
D("example.com","none"
|
||||
D("example.com", REG_MY_PROVIDER, DnsProvider(DSP_MY_PROVIDER),
|
||||
LOC_BUILDER_STR({
|
||||
label: "tasmania",
|
||||
str: "42°S 147°E",
|
||||
|
@ -35,7 +35,7 @@ Note that the following are acceptable forms (symbols differ):
|
||||
|
||||
{% code title="dnsconfig.js" %}
|
||||
```javascript
|
||||
D("example.com","none"
|
||||
D("example.com", REG_MY_PROVIDER, DnsProvider(DSP_MY_PROVIDER),
|
||||
LOC_BUILDER_DMS_STR({
|
||||
label: "sydney-opera-house",
|
||||
str: "33°51′31″S 151°12′51″E",
|
||||
|
@ -32,7 +32,7 @@ Accepts a string and tries all `LOC_BUILDER_DM*_STR({})` methods:
|
||||
|
||||
{% code title="dnsconfig.js" %}
|
||||
```javascript
|
||||
D("example.com","none"
|
||||
D("example.com", REG_MY_PROVIDER, DnsProvider(DSP_MY_PROVIDER),
|
||||
, LOC_BUILDER_STR({
|
||||
label: "old-faithful",
|
||||
str: "44.46046°N 110.82815°W",
|
||||
|
@ -39,7 +39,7 @@ Here is an example of how SPF settings are normally done:
|
||||
|
||||
{% code title="dnsconfig.js" %}
|
||||
```javascript
|
||||
D("example.tld", REG_MY_PROVIDER, DNS, ...
|
||||
D("example.com", REG_MY_PROVIDER, DnsProvider(DSP_MY_PROVIDER),
|
||||
TXT("v=spf1 ip4:198.252.206.0/24 ip4:192.111.0.0/24 include:_spf.google.com include:mailgun.org include:spf-basic.fogcreek.com include:mail.zendesk.com include:servers.mcsv.net include:sendgrid.net include:450622.spf05.hubspotemail.net ~all")
|
||||
)
|
||||
```
|
||||
@ -55,9 +55,9 @@ This has a few problems:
|
||||
|
||||
{% code title="dnsconfig.js" %}
|
||||
```javascript
|
||||
D("example.tld", REG_MY_PROVIDER, DSP, ...
|
||||
D("example.com", REG_MY_PROVIDER, DnsProvider(DSP_MY_PROVIDER),
|
||||
A("@", "10.2.2.2"),
|
||||
MX("@", "example.tld."),
|
||||
MX("@", "example.com."),
|
||||
SPF_BUILDER({
|
||||
label: "@",
|
||||
overflow: "_spf%d",
|
||||
@ -98,7 +98,7 @@ When you want to specify SPF settings for a domain, use the
|
||||
|
||||
{% code title="dnsconfig.js" %}
|
||||
```javascript
|
||||
D("example.tld", REG_MY_PROVIDER, DSP, ...
|
||||
D("example.com", REG_MY_PROVIDER, DnsProvider(DSP_MY_PROVIDER),
|
||||
...
|
||||
...
|
||||
...
|
||||
@ -305,11 +305,11 @@ var SPF_MYSETTINGS = SPF_BUILDER({
|
||||
]
|
||||
});
|
||||
|
||||
D("example.tld", REG_MY_PROVIDER, DSP, ...
|
||||
D("example.com", REG_MY_PROVIDER, DnsProvider(DSP_MY_PROVIDER),
|
||||
SPF_MYSETTINGS
|
||||
);
|
||||
|
||||
D("example2.tld", REG_MY_PROVIDER, DSP, ...
|
||||
D("example2.tld", REG_MY_PROVIDER, DnsProvider(DSP_MY_PROVIDER),
|
||||
SPF_MYSETTINGS
|
||||
);
|
||||
```
|
||||
|
@ -26,7 +26,7 @@ The value can be:
|
||||
|
||||
{% code title="dnsconfig.js" %}
|
||||
```javascript
|
||||
D("example.com", REGISTRAR, DnsProvider("R53"),
|
||||
D("example.com", REG_MY_PROVIDER, DnsProvider("R53"),
|
||||
DefaultTTL(2000),
|
||||
A("@","1.2.3.4"), // uses default
|
||||
A("foo", "2.3.4.5", TTL(500)), // overrides default
|
||||
|
@ -136,7 +136,7 @@ Read a zonefile, generate a JS file, then use the JS file to see how
|
||||
different it is from the zonefile:
|
||||
|
||||
```shell
|
||||
dnscontrol get-zone --format=djs -out=foo.djs bind - example.org
|
||||
dnscontrol get-zone --format=djs -out=foo.djs bind - example.com
|
||||
dnscontrol preview --config foo.js
|
||||
```
|
||||
|
||||
|
@ -43,7 +43,7 @@ Simplicity.
|
||||
|
||||
{% code title="dnsconfig.js" %}
|
||||
```javascript
|
||||
D("example1.com", REG_NAMECOM,
|
||||
D("example.com", REG_NAMECOM,
|
||||
DnsProvider(DNS_NAMECOM),
|
||||
A("@", "10.2.3.4")
|
||||
);
|
||||
@ -62,7 +62,7 @@ you want to use a high-performance DNS server.
|
||||
|
||||
{% code title="dnsconfig.js" %}
|
||||
```javascript
|
||||
D("example1.com", REG_NAMECOM,
|
||||
D("example.com", REG_NAMECOM,
|
||||
DnsProvider(DNS_AWS),
|
||||
A("@", "10.2.3.4")
|
||||
);
|
||||
@ -83,7 +83,7 @@ updating the zone's records (most likely at a different provider).
|
||||
|
||||
{% code title="dnsconfig.js" %}
|
||||
```javascript
|
||||
D("example1.com", REG_THIRDPARTY,
|
||||
D("example.com", REG_THIRDPARTY,
|
||||
DnsProvider(DNS_NAMECOM),
|
||||
A("@", "10.2.3.4")
|
||||
);
|
||||
@ -103,7 +103,7 @@ controlling.
|
||||
|
||||
{% code title="dnsconfig.js" %}
|
||||
```javascript
|
||||
D("example1.com", REG_NAMECOM,
|
||||
D("example.com", REG_NAMECOM,
|
||||
NAMESERVER("dns1.p03.nsone.net."),
|
||||
NAMESERVER("dns2.p03.nsone.net."),
|
||||
NAMESERVER("dns3.p03.nsone.net."),
|
||||
@ -126,7 +126,7 @@ is new; this is a good temporary work-around until the API starts working.
|
||||
|
||||
{% code title="dnsconfig.js" %}
|
||||
```javascript
|
||||
D("example1.com", REG_NAMECOM,
|
||||
D("example.com", REG_NAMECOM,
|
||||
DnsProvider(DNS_CLOUDFLARE, 0), // Set the DNS provider but ignore the nameservers it suggests (0 == take none of the names it reports)
|
||||
NAMESERVER("kim.ns.cloudflare.com."),
|
||||
NAMESERVER("walt.ns.cloudflare.com."),
|
||||
@ -146,9 +146,9 @@ Usually only to correct a bug or misconfiguration elsewhere.
|
||||
|
||||
{% code title="dnsconfig.js" %}
|
||||
```javascript
|
||||
D("example1.com", REG_NAMECOM,
|
||||
D("example.com", REG_NAMECOM,
|
||||
DnsProvider(DNS_NAMECOM),
|
||||
NAMESERVER("ns1.myexample.tld"),
|
||||
NAMESERVER("ns1.myexample.com"),
|
||||
A("@", "10.2.3.4")
|
||||
);
|
||||
```
|
||||
@ -169,7 +169,7 @@ There are many reasons to do this:
|
||||
|
||||
{% code title="dnsconfig.js" %}
|
||||
```javascript
|
||||
D("example1.com", REG_NAMECOM,
|
||||
D("example.com", REG_NAMECOM,
|
||||
DnsProvider(DNS_NAMECOM), // Our real DNS server
|
||||
DnsProvider(DNS_CLOUDFLARE, 0), // Quietly send a copy of the zone here.
|
||||
DnsProvider(DNS_BIND, 0), // And here too!
|
||||
@ -200,7 +200,7 @@ More info: https://www.dns-oarc.net/files/workshop-201203/OARC-workshop-London-2
|
||||
|
||||
{% code title="dnsconfig.js" %}
|
||||
```javascript
|
||||
D("example1.com", REG_NAMECOM,
|
||||
D("example.com", REG_NAMECOM,
|
||||
DnsProvider(DNS_AWS, 2), // Take 2 nameservers from AWS
|
||||
DnsProvider(DNS_GOOGLE, 2), // Take 2 nameservers from GCP
|
||||
A("@", "10.2.3.4")
|
||||
@ -229,7 +229,7 @@ this is the output of DNSControl, not the input.
|
||||
|
||||
{% code title="dnsconfig.js" %}
|
||||
```javascript
|
||||
D("example1.com", REG_NAMECOM,
|
||||
D("example.com", REG_NAMECOM,
|
||||
DnsProvider(DNS_NAMECOM),
|
||||
DnsProvider(DNS_BIND, 0), // Don't activate any nameservers related to BIND.
|
||||
A("@", "10.2.3.4")
|
||||
@ -254,9 +254,9 @@ See the [DNS-over-HTTPS Provider](providers/dnsoverhttps.md) documentation for m
|
||||
```javascript
|
||||
var REG_MONITOR = NewRegistrar("DNS-over-HTTPS");
|
||||
|
||||
D("example1.com", REG_MONITOR,
|
||||
NAMESERVER("ns1.example1.com."),
|
||||
NAMESERVER("ns2.example1.com."),
|
||||
D("example.com", REG_MONITOR,
|
||||
NAMESERVER("ns1.example.com."),
|
||||
NAMESERVER("ns2.example.com."),
|
||||
);
|
||||
```
|
||||
{% endcode %}
|
||||
@ -278,7 +278,7 @@ Easily delegate a domain to a specific list of nameservers.
|
||||
|
||||
{% code title="dnsconfig.js" %}
|
||||
```javascript
|
||||
DOMAIN_ELSEWHERE("example1.com", REG_NAMECOM, [
|
||||
DOMAIN_ELSEWHERE("example.com", REG_NAMECOM, [
|
||||
"dns1.example.net.",
|
||||
"dns2.example.net.",
|
||||
"dns3.example.net.",
|
||||
@ -296,7 +296,7 @@ of nameservers is queried from the API of a single DNS provider.
|
||||
|
||||
{% code title="dnsconfig.js" %}
|
||||
```javascript
|
||||
DOMAIN_ELSEWHERE_AUTO("example1.com", REG_NAMECOM, DNS_AWS);
|
||||
DOMAIN_ELSEWHERE_AUTO("example.com", REG_NAMECOM, DNS_AWS);
|
||||
DOMAIN_ELSEWHERE_AUTO("example2.com", REG_NAMECOM, DNS_GOOGLE);
|
||||
```
|
||||
{% endcode %}
|
||||
|
@ -27,7 +27,7 @@ An example configuration:
|
||||
var REG_NONE = NewRegistrar("none");
|
||||
var DSP_AUTODNS = NewDnsProvider("autodns");
|
||||
|
||||
D("example.tld", REG_NONE, DnsProvider(DSP_AUTODNS),
|
||||
D("example.com", REG_NONE, DnsProvider(DSP_AUTODNS),
|
||||
A("test", "1.2.3.4")
|
||||
);
|
||||
```
|
||||
|
@ -92,10 +92,10 @@ the later allows `get-zones` to work properly.
|
||||
```javascript
|
||||
var DSP_AXFRDDNS = NewDnsProvider("axfrddns", {
|
||||
"default_ns": [
|
||||
"ns1.example.tld.",
|
||||
"ns2.example.tld.",
|
||||
"ns3.example.tld.",
|
||||
"ns4.example.tld."
|
||||
"ns1.example.com.",
|
||||
"ns2.example.com.",
|
||||
"ns3.example.com.",
|
||||
"ns4.example.com."
|
||||
]
|
||||
}
|
||||
}
|
||||
@ -107,7 +107,7 @@ var DSP_AXFRDDNS = NewDnsProvider("axfrddns", {
|
||||
{
|
||||
"axfrddns": {
|
||||
"TYPE": "AXFRDDNS",
|
||||
"nameservers": "ns1.example.tld.,ns2.example.tld.,ns3.example.tld.,ns4.example.tld."
|
||||
"nameservers": "ns1.example.com.,ns2.example.com.,ns3.example.com.,ns4.example.com."
|
||||
}
|
||||
}
|
||||
```
|
||||
@ -191,7 +191,7 @@ D("example.com", REG_NONE, DnsProvider(DNS),
|
||||
### Bind9
|
||||
|
||||
Here is a sample `named.conf` example for an authauritative server on
|
||||
zone `example.tld`. It uses a simple IP-based ACL for the AXFR
|
||||
zone `example.com`. It uses a simple IP-based ACL for the AXFR
|
||||
transfer and a conjunction of TSIG and IP-based ACL for the updates.
|
||||
|
||||
{% code title="named.conf" %}
|
||||
@ -210,9 +210,9 @@ options {
|
||||
|
||||
};
|
||||
|
||||
zone "example.tld" {
|
||||
zone "example.com" {
|
||||
type master;
|
||||
file "/etc/bind/db.example.tld";
|
||||
file "/etc/bind/db.example.com";
|
||||
allow-transfer { example-transfer; };
|
||||
allow-update { example-update; };
|
||||
};
|
||||
|
@ -56,7 +56,7 @@ An example configuration:
|
||||
var REG_NONE = NewRegistrar("none");
|
||||
var DSP_AZURE_MAIN = NewDnsProvider("azuredns_main");
|
||||
|
||||
D("example.tld", REG_NONE, DnsProvider(DSP_AZURE_MAIN),
|
||||
D("example.com", REG_NONE, DnsProvider(DSP_AZURE_MAIN),
|
||||
A("test", "1.2.3.4")
|
||||
);
|
||||
```
|
||||
|
@ -41,18 +41,18 @@ In this example we set the default SOA settings and NS records.
|
||||
```javascript
|
||||
var DSP_BIND = NewDnsProvider("bind", {
|
||||
"default_soa": {
|
||||
"master": "ns1.example.tld.",
|
||||
"mbox": "spamtrap.example.tld.",
|
||||
"master": "ns1.example.com.",
|
||||
"mbox": "spamtrap.example.com.",
|
||||
"refresh": 3600,
|
||||
"retry": 600,
|
||||
"expire": 604800,
|
||||
"minttl": 1440,
|
||||
},
|
||||
"default_ns": [
|
||||
"ns1.example.tld.",
|
||||
"ns2.example.tld.",
|
||||
"ns3.example.tld.",
|
||||
"ns4.example.tld."
|
||||
"ns1.example.com.",
|
||||
"ns2.example.com.",
|
||||
"ns3.example.com.",
|
||||
"ns4.example.com."
|
||||
]
|
||||
})
|
||||
```
|
||||
@ -109,7 +109,7 @@ Typical values:
|
||||
* `db_example.com`
|
||||
|
||||
The last example will generate the same name for both
|
||||
`D("example.tld!inside")` and `D("example.tld!outside")`. This
|
||||
`D("example.com!inside")` and `D("example.com!outside")`. This
|
||||
assumes two BIND providers are configured in `creds.json`, each with
|
||||
a different `directory` setting. Otherwise `dnscontrol` will write
|
||||
both domains to the same file, flapping between the two back and
|
||||
|
@ -158,7 +158,7 @@ The following example shows how to set meta variables with and without aliases:
|
||||
var REG_NONE = NewRegistrar("none");
|
||||
var DSP_CLOUDFLARE = NewDnsProvider("cloudflare");
|
||||
|
||||
D("example.tld", REG_NONE, DnsProvider(DSP_CLOUDFLARE),
|
||||
D("example.com", REG_NONE, DnsProvider(DSP_CLOUDFLARE),
|
||||
A("www1","1.2.3.11", CF_PROXY_ON), // turn proxy ON.
|
||||
A("www2","1.2.3.12", CF_PROXY_OFF), // default is OFF, this is a no-op.
|
||||
A("www3","1.2.3.13", {"cloudflare_proxy": "on"}) // Old format.
|
||||
@ -175,12 +175,12 @@ var REG_NONE = NewRegistrar("none");
|
||||
var DSP_CLOUDFLARE = NewDnsProvider("cloudflare");
|
||||
|
||||
// Example domain where the CF proxy abides by the default (off).
|
||||
D("example.tld", REG_NONE, DnsProvider(DSP_CLOUDFLARE),
|
||||
D("example.com", REG_NONE, DnsProvider(DSP_CLOUDFLARE),
|
||||
A("proxied", "1.2.3.4", CF_PROXY_ON),
|
||||
A("notproxied", "1.2.3.5"),
|
||||
A("another", "1.2.3.6", CF_PROXY_ON),
|
||||
ALIAS("@", "www.example.tld.", CF_PROXY_ON),
|
||||
CNAME("myalias", "www.example.tld.", CF_PROXY_ON)
|
||||
ALIAS("@", "www.example.com.", CF_PROXY_ON),
|
||||
CNAME("myalias", "www.example.com.", CF_PROXY_ON)
|
||||
);
|
||||
|
||||
// Example domain where the CF proxy default is set to "on":
|
||||
|
@ -40,7 +40,7 @@ Simply use the `CLOUDNS_WR` functions to make redirects like any other record:
|
||||
var REG_NONE = NewRegistrar("none");
|
||||
var DSP_CLOUDNS = NewDnsProvider("cloudns");
|
||||
|
||||
D("example.tld", REG_NONE, DnsProvider(DSP_CLOUDNS),
|
||||
D("example.com", REG_NONE, DnsProvider(DSP_CLOUDNS),
|
||||
CLOUDNS_WR("@", "http://example.com/"),
|
||||
CLOUDNS_WR("www", "http://example.com/")
|
||||
)
|
||||
@ -55,7 +55,7 @@ An example configuration:
|
||||
var REG_NONE = NewRegistrar("none");
|
||||
var DSP_CLOUDNS = NewDnsProvider("cloudns");
|
||||
|
||||
D("example.tld", REG_NONE, DnsProvider(DSP_CLOUDNS),
|
||||
D("example.com", REG_NONE, DnsProvider(DSP_CLOUDNS),
|
||||
A("test", "1.2.3.4")
|
||||
);
|
||||
```
|
||||
|
@ -22,7 +22,7 @@ Example:
|
||||
"TYPE": "CSCGLOBAL",
|
||||
"api-key": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
|
||||
"user-token": "yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy",
|
||||
"notification_emails": "test@example.tld,hostmaster@example.tld"
|
||||
"notification_emails": "test@example.com,hostmaster@example.com"
|
||||
}
|
||||
}
|
||||
```
|
||||
@ -36,7 +36,7 @@ An example configuration:
|
||||
var REG_CSCGLOBAL = NewRegistrar("cscglobal");
|
||||
var DSP_BIND = NewDnsProvider("bind");
|
||||
|
||||
D("example.tld", REG_CSCGLOBAL, DnsProvider(DSP_BIND),
|
||||
D("example.com", REG_CSCGLOBAL, DnsProvider(DSP_BIND),
|
||||
A("test", "1.2.3.4")
|
||||
);
|
||||
```
|
||||
|
@ -27,7 +27,7 @@ An example configuration:
|
||||
var REG_NONE = NewRegistrar("none");
|
||||
var DSP_DESEC = NewDnsProvider("desec");
|
||||
|
||||
D("example.tld", REG_NONE, DnsProvider(DSP_DESEC),
|
||||
D("example.com", REG_NONE, DnsProvider(DSP_DESEC),
|
||||
A("test", "1.2.3.4")
|
||||
);
|
||||
```
|
||||
|
@ -27,7 +27,7 @@ An example configuration:
|
||||
var REG_NONE = NewRegistrar("none");
|
||||
var DSP_DIGITALOCEAN = NewDnsProvider("mydigitalocean");
|
||||
|
||||
D("example.tld", REG_NONE, DnsProvider(DSP_DIGITALOCEAN),
|
||||
D("example.com", REG_NONE, DnsProvider(DSP_DIGITALOCEAN),
|
||||
A("test", "1.2.3.4")
|
||||
);
|
||||
```
|
||||
|
@ -34,7 +34,7 @@ An example configuration:
|
||||
var REG_DNSIMPLE = NewRegistrar("dnsimple");
|
||||
var DSP_DNSIMPLE = NewDnsProvider("dnsimple");
|
||||
|
||||
D("example.tld", REG_DNSIMPLE, DnsProvider(DSP_DNSIMPLE),
|
||||
D("example.com", REG_DNSIMPLE, DnsProvider(DSP_DNSIMPLE),
|
||||
A("test", "1.2.3.4")
|
||||
);
|
||||
```
|
||||
|
@ -36,7 +36,7 @@ An example configuration:
|
||||
var REG_NONE = NewRegistrar("none");
|
||||
var DSP_DNSMADEEASY = NewDnsProvider("dnsmadeeasy");
|
||||
|
||||
D("example.tld", REG_NONE, DnsProvider(DSP_DNSMADEEASY),
|
||||
D("example.com", REG_NONE, DnsProvider(DSP_DNSMADEEASY),
|
||||
A("test", "1.2.3.4")
|
||||
);
|
||||
```
|
||||
|
@ -28,7 +28,7 @@ An example configuration:
|
||||
var REG_NONE = NewRegistrar("none");
|
||||
var DSP_DOMAINNAMESHOP = NewDnsProvider("mydomainnameshop");
|
||||
|
||||
D("example.tld", REG_NONE, DnsProvider(DSP_DOMAINNAMESHOP),
|
||||
D("example.com", REG_NONE, DnsProvider(DSP_DOMAINNAMESHOP),
|
||||
A("test", "1.2.3.4")
|
||||
);
|
||||
```
|
||||
|
@ -58,7 +58,7 @@ An example configuration:
|
||||
var REG_GANDI = NewRegistrar("gandi");
|
||||
var DSP_GANDI = NewDnsProvider("gandi");
|
||||
|
||||
D("example.tld", REG_GANDI, DnsProvider(DSP_GANDI),
|
||||
D("example.com", REG_GANDI, DnsProvider(DSP_GANDI),
|
||||
A("test", "1.2.3.4")
|
||||
);
|
||||
```
|
||||
|
@ -64,7 +64,7 @@ An example configuration:
|
||||
var REG_NAMECOM = NewRegistrar("name.com");
|
||||
var DSP_GCLOUD = NewDnsProvider("gcloud");
|
||||
|
||||
D("example.tld", REG_NAMECOM, DnsProvider(DSP_GCLOUD),
|
||||
D("example.com", REG_NAMECOM, DnsProvider(DSP_GCLOUD),
|
||||
A("test", "1.2.3.4")
|
||||
);
|
||||
```
|
||||
|
@ -27,7 +27,7 @@ An example configuration:
|
||||
var REG_NONE = NewRegistrar("none");
|
||||
var DSP_GCORE = NewDnsProvider("gcore");
|
||||
|
||||
D("example.tld", REG_NONE, DnsProvider(DSP_GCORE),
|
||||
D("example.com", REG_NONE, DnsProvider(DSP_GCORE),
|
||||
A("test", "1.2.3.4")
|
||||
);
|
||||
```
|
||||
|
@ -110,7 +110,7 @@ An example configuration:
|
||||
var REG_NONE = NewRegistrar("none");
|
||||
var DSP_HEDNS = NewDnsProvider("hedns");
|
||||
|
||||
D("example.tld", REG_NONE, DnsProvider(DSP_HEDNS),
|
||||
D("example.com", REG_NONE, DnsProvider(DSP_HEDNS),
|
||||
A("test", "1.2.3.4")
|
||||
);
|
||||
```
|
||||
|
@ -30,7 +30,7 @@ An example configuration:
|
||||
var REG_NONE = NewRegistrar("none");
|
||||
var DSP_HETZNER = NewDnsProvider("hetzner");
|
||||
|
||||
D("example.tld", REG_NONE, DnsProvider(DSP_HETZNER),
|
||||
D("example.com", REG_NONE, DnsProvider(DSP_HETZNER),
|
||||
A("test", "1.2.3.4")
|
||||
);
|
||||
```
|
||||
|
@ -73,8 +73,8 @@ You are free to decide if you want to use both of our provider technology or jus
|
||||
|
||||
{% code title="dnsconfig.js" %}
|
||||
```javascript
|
||||
var REG_HX = NewRegistrar("hexonet");
|
||||
var DSP_HX = NewDnsProvider("hexonet");
|
||||
var REG_HEXONET = NewRegistrar("hexonet");
|
||||
var DSP_HEXONET = NewDnsProvider("hexonet");
|
||||
|
||||
// Set Default TTL for all RR to reflect our Backend API Default
|
||||
// If you use additional DNS Providers, configure a default TTL
|
||||
@ -85,7 +85,7 @@ DEFAULTS(
|
||||
DefaultTTL(3600)
|
||||
);
|
||||
|
||||
D("abhoster.com", REG_HX, DnsProvider(DSP_HX),
|
||||
D("example.com", REG_HEXONET, DnsProvider(DSP_HEXONET),
|
||||
NAMESERVER("ns1.ispapi.net"),
|
||||
NAMESERVER("ns2.ispapi.net"),
|
||||
NAMESERVER("ns3.ispapi.net"),
|
||||
|
@ -25,7 +25,7 @@ An example configuration:
|
||||
var REG_HOSTINGDE = NewRegistrar("hosting.de");
|
||||
var DSP_HOSTINGDE = NewDnsProvider("hosting.de");
|
||||
|
||||
D("example.tld", REG_HOSTINGDE, DnsProvider(DSP_HOSTINGDE),
|
||||
D("example.com", REG_HOSTINGDE, DnsProvider(DSP_HOSTINGDE),
|
||||
A("test", "1.2.3.4")
|
||||
);
|
||||
```
|
||||
|
@ -99,7 +99,7 @@ INWX.
|
||||
|
||||
## Usage
|
||||
An example `dnsconfig.js` configuration file
|
||||
for `example.tld` registered with INWX
|
||||
for `example.com` registered with INWX
|
||||
and delegated to Cloudflare:
|
||||
|
||||
{% code title="dnsconfig.js" %}
|
||||
@ -107,7 +107,7 @@ and delegated to Cloudflare:
|
||||
var REG_INWX = NewRegistrar("inwx");
|
||||
var DSP_CF = NewDnsProvider("cloudflare");
|
||||
|
||||
D("example.tld", REG_INWX, DnsProvider(DSP_CF),
|
||||
D("example.com", REG_INWX, DnsProvider(DSP_CF),
|
||||
A("test", "1.2.3.4")
|
||||
);
|
||||
```
|
||||
|
@ -27,7 +27,7 @@ An example configuration:
|
||||
var REG_NONE = NewRegistrar("none");
|
||||
var DSP_LINODE = NewDnsProvider("linode");
|
||||
|
||||
D("example.tld", REG_NONE, DnsProvider(DSP_LINODE),
|
||||
D("example.com", REG_NONE, DnsProvider(DSP_LINODE),
|
||||
A("test", "1.2.3.4")
|
||||
);
|
||||
```
|
||||
|
@ -28,7 +28,7 @@ An example configuration:
|
||||
var REG_NONE = NewRegistrar("none");
|
||||
var DSP_LUADNS = NewDnsProvider("luadns");
|
||||
|
||||
D("example.tld", REG_NONE, DnsProvider(DSP_LUADNS),
|
||||
D("example.com", REG_NONE, DnsProvider(DSP_LUADNS),
|
||||
A("test", "1.2.3.4")
|
||||
);
|
||||
```
|
||||
|
@ -57,7 +57,7 @@ An example DNS configuration:
|
||||
var REG_NONE = NewRegistrar("none");
|
||||
var DSP_MSDNS = NewDnsProvider("msdns");
|
||||
|
||||
D("example.tld", REG_NONE, DnsProvider(DSP_MSDNS),
|
||||
D("example.com", REG_NONE, DnsProvider(DSP_MSDNS),
|
||||
A("test", "1.2.3.4")
|
||||
)
|
||||
```
|
||||
|
@ -50,7 +50,7 @@ An example configuration:
|
||||
var REG_NAMECHEAP = NewRegistrar("namecheap");
|
||||
var DSP_BIND = NewDnsProvider("bind");
|
||||
|
||||
D("example.tld", REG_NAMECHEAP, DnsProvider(DSP_BIND),
|
||||
D("example.com", REG_NAMECHEAP, DnsProvider(DSP_BIND),
|
||||
A("test", "1.2.3.4")
|
||||
);
|
||||
```
|
||||
@ -64,7 +64,7 @@ records can be used like any other record:
|
||||
var REG_NAMECHEAP = NewRegistrar("namecheap");
|
||||
var DSP_NAMECHEAP = NewDnsProvider("namecheap");
|
||||
|
||||
D("example.tld", REG_NAMECHEAP, DnsProvider(DSP_NAMECHEAP),
|
||||
D("example.com", REG_NAMECHEAP, DnsProvider(DSP_NAMECHEAP),
|
||||
URL("@", "http://example.com/"),
|
||||
URL("www", "http://example.com/"),
|
||||
URL301("backup", "http://backup.example.com/")
|
||||
|
@ -43,7 +43,7 @@ as the registrar and DNS service provider:
|
||||
var REG_NAMECOM = NewRegistrar("name.com");
|
||||
var DSP_NAMECOM = NewDnsProvider("name.com");
|
||||
|
||||
D("example.tld", REG_NAMECOM, DnsProvider(DSP_NAMECOM),
|
||||
D("example.com", REG_NAMECOM, DnsProvider(DSP_NAMECOM),
|
||||
A("test", "1.2.3.4")
|
||||
);
|
||||
```
|
||||
@ -57,7 +57,7 @@ as the registrar and DNS only, DNS hosted elsewhere:
|
||||
var REG_NAMECOM = NewRegistrar("name.com");
|
||||
var DSP_R53 = NewDnsProvider("r53");
|
||||
|
||||
D("example.tld", REG_NAMECOM, DnsProvider(DSP_R53),
|
||||
D("example.com", REG_NAMECOM, DnsProvider(DSP_R53),
|
||||
A("test","1.2.3.4")
|
||||
);
|
||||
```
|
||||
|
@ -26,7 +26,7 @@ An example configuration:
|
||||
var REG_NONE = NewRegistrar("none");
|
||||
var DSP_NETCUP = NewDnsProvider("netcup");
|
||||
|
||||
D("example.tld", REG_NONE, DnsProvider(DSP_NETCUP),
|
||||
D("example.com", REG_NONE, DnsProvider(DSP_NETCUP),
|
||||
A("test", "1.2.3.4")
|
||||
);
|
||||
```
|
||||
|
@ -29,7 +29,7 @@ An example configuration:
|
||||
var REG_NETLIFY = NewRegistrar("netlify");
|
||||
var DSP_NETLIFY = NewDnsProvider("netlify");
|
||||
|
||||
D("example.tld", REG_NETLIFY, DnsProvider(DSP_NETLIFY),
|
||||
D("example.com", REG_NETLIFY, DnsProvider(DSP_NETLIFY),
|
||||
A("test", "1.2.3.4")
|
||||
);
|
||||
```
|
||||
|
@ -27,7 +27,7 @@ An example configuration:
|
||||
var REG_NONE = NewRegistrar("none");
|
||||
var DSP_NS1 = NewDnsProvider("ns1");
|
||||
|
||||
D("example.tld", REG_NONE, DnsProvider(DSP_NS1),
|
||||
D("example.com", REG_NONE, DnsProvider(DSP_NS1),
|
||||
A("test", "1.2.3.4")
|
||||
);
|
||||
```
|
||||
|
@ -35,7 +35,7 @@ An example configuration:
|
||||
var REG_NONE = NewRegistrar("none");
|
||||
var DSP_ORACLE = NewDnsProvider("oracle");
|
||||
|
||||
D("example.tld", REG_NONE, DnsProvider(DSP_ORACLE),
|
||||
D("example.com", REG_NONE, DnsProvider(DSP_ORACLE),
|
||||
NAMESERVER_TTL(86400),
|
||||
|
||||
A("test", "1.2.3.4")
|
||||
|
@ -33,7 +33,7 @@ An example configuration: (DNS hosted with OVH):
|
||||
var REG_OVH = NewRegistrar("ovh");
|
||||
var DSP_OVH = NewDnsProvider("ovh");
|
||||
|
||||
D("example.tld", REG_OVH, DnsProvider(DSP_OVH),
|
||||
D("example.com", REG_OVH, DnsProvider(DSP_OVH),
|
||||
A("test", "1.2.3.4")
|
||||
);
|
||||
```
|
||||
@ -46,7 +46,7 @@ An example configuration: (Registrar only. DNS hosted elsewhere)
|
||||
var REG_OVH = NewRegistrar("ovh");
|
||||
var DSP_R53 = NewDnsProvider("r53");
|
||||
|
||||
D("example.tld", REG_OVH, DnsProvider(DSP_R53),
|
||||
D("example.com", REG_OVH, DnsProvider(DSP_R53),
|
||||
A("test", "1.2.3.4")
|
||||
);
|
||||
```
|
||||
|
@ -27,7 +27,7 @@ An example configuration:
|
||||
var REG_NONE = NewRegistrar("none");
|
||||
var DSP_PACKETFRAME = NewDnsProvider("packetframe");
|
||||
|
||||
D("example.tld", REG_NONE, DnsProvider(DSP_PACKETFRAME),
|
||||
D("example.com", REG_NONE, DnsProvider(DSP_PACKETFRAME),
|
||||
A("test", "1.2.3.4")
|
||||
);
|
||||
```
|
||||
|
@ -30,7 +30,7 @@ An example configuration:
|
||||
var REG_NONE = NewRegistrar("none");
|
||||
var DSP_PORKBUN = NewDnsProvider("porkbun");
|
||||
|
||||
D("example.tld", REG_NONE, DnsProvider(DSP_PORKBUN),
|
||||
D("example.com", REG_NONE, DnsProvider(DSP_PORKBUN),
|
||||
A("test", "1.2.3.4")
|
||||
);
|
||||
```
|
||||
|
@ -51,7 +51,7 @@ An example configuration:
|
||||
var REG_NONE = NewRegistrar("none");
|
||||
var DSP_POWERDNS = NewDnsProvider("powerdns");
|
||||
|
||||
D("example.tld", REG_NONE, DnsProvider(DSP_POWERDNS),
|
||||
D("example.com", REG_NONE, DnsProvider(DSP_POWERDNS),
|
||||
A("test", "1.2.3.4")
|
||||
);
|
||||
```
|
||||
|
@ -72,7 +72,7 @@ An example configuration:
|
||||
var REG_NONE = NewRegistrar("none");
|
||||
var DSP_R53 = NewDnsProvider("r53_main");
|
||||
|
||||
D("example.tld", REG_NONE, DnsProvider(DSP_R53),
|
||||
D("example.com", REG_NONE, DnsProvider(DSP_R53),
|
||||
A("test", "1.2.3.4")
|
||||
);
|
||||
```
|
||||
|
@ -35,7 +35,7 @@ An example configuration:
|
||||
var REG_NONE = NewRegistrar("none");
|
||||
var DSP_SOFTLAYER = NewDnsProvider("softlayer");
|
||||
|
||||
D("example.tld", registrary, DnsProvider(DSP_SOFTLAYER),
|
||||
D("example.com", REG_NONE, DnsProvider(DSP_SOFTLAYER),
|
||||
A("test", "1.2.3.4")
|
||||
);
|
||||
```
|
||||
@ -50,7 +50,7 @@ For compatibility with the pre-generated NAMESERVER fields it's recommended to s
|
||||
var REG_NONE = NewRegistrar("none");
|
||||
var DSP_SOFTLAYER = NewDnsProvider("softlayer");
|
||||
|
||||
D("example.tld", REG_NONE, DnsProvider(SOFTLAYER),
|
||||
D("example.com", REG_NONE, DnsProvider(SOFTLAYER),
|
||||
NAMESERVER_TTL(86400),
|
||||
|
||||
A("test", "1.2.3.4")
|
||||
|
@ -50,7 +50,7 @@ An example configuration:
|
||||
var REG_NONE = NewRegistrar("none");
|
||||
var DSP_TRANSIP = NewDnsProvider("transip");
|
||||
|
||||
D("example.tld", REG_NONE, DnsProvider(DSP_TRANSIP),
|
||||
D("example.com", REG_NONE, DnsProvider(DSP_TRANSIP),
|
||||
A("test", "1.2.3.4")
|
||||
);
|
||||
```
|
||||
|
@ -28,7 +28,7 @@ An example configuration:
|
||||
```javascript
|
||||
var DSP_VULTR = NewDnsProvider("vultr");
|
||||
|
||||
D("example.tld", REG_DNSIMPLE, DnsProvider(DSP_VULTR),
|
||||
D("example.com", REG_DNSIMPLE, DnsProvider(DSP_VULTR),
|
||||
A("test", "1.2.3.4")
|
||||
);
|
||||
```
|
||||
|
Reference in New Issue
Block a user