mirror of
https://github.com/StackExchange/dnscontrol.git
synced 2024-05-11 05:55:12 +00:00
DOCS: The Javascript code examples are no longer tied to a DNS provider (#2443)
This commit is contained in:
committed by
GitHub
parent
5b3bb312ea
commit
8656ffdbd5
@ -4,11 +4,11 @@
|
||||
|
||||
// Providers:
|
||||
|
||||
var REG_NONE = NewRegistrar('none'); // No registrar.
|
||||
var DNS_BIND = NewDnsProvider('bind'); // ISC BIND.
|
||||
var REG_NONE = NewRegistrar("none"); // No registrar.
|
||||
var DNS_BIND = NewDnsProvider("bind"); // ISC BIND.
|
||||
|
||||
// Domains:
|
||||
|
||||
D('example.com', REG_NONE, DnsProvider(DNS_BIND),
|
||||
A('@', '1.2.3.4')
|
||||
D("example.com", REG_NONE, DnsProvider(DNS_BIND),
|
||||
A("@", "1.2.3.4")
|
||||
);
|
||||
|
@ -18,7 +18,7 @@ Modifiers can be any number of [record modifiers](https://docs.dnscontrol.org/la
|
||||
|
||||
{% code title="dnsconfig.js" %}
|
||||
```javascript
|
||||
D("example.com", REG_MY_PROVIDER, DnsProvider("R53"),
|
||||
D("example.com", REG_MY_PROVIDER, DnsProvider(DSP_MY_PROVIDER),
|
||||
A("@", "1.2.3.4"),
|
||||
A("foo", "2.3.4.5"),
|
||||
A("test.foo", IP("1.2.3.4"), TTL(5000)),
|
||||
|
@ -20,7 +20,7 @@ Modifiers can be any number of [record modifiers](https://docs.dnscontrol.org/la
|
||||
```javascript
|
||||
var addrV6 = "2001:0db8:85a3:0000:0000:8a2e:0370:7334"
|
||||
|
||||
D("example.com", REG_MY_PROVIDER, DnsProvider("R53"),
|
||||
D("example.com", REG_MY_PROVIDER, DnsProvider(DSP_MY_PROVIDER),
|
||||
AAAA("@", addrV6),
|
||||
AAAA("foo", addrV6),
|
||||
AAAA("test.foo", addrV6, TTL(5000)),
|
||||
|
@ -20,7 +20,7 @@ Target should be a string representing the target. If it is a single label we wi
|
||||
|
||||
{% code title="dnsconfig.js" %}
|
||||
```javascript
|
||||
D("example.com", REG_MY_PROVIDER, DnsProvider("CLOUDFLARE"),
|
||||
D("example.com", REG_MY_PROVIDER, DnsProvider(DSP_MY_PROVIDER),
|
||||
ALIAS("@", "google.com."), // example.com -> google.com
|
||||
);
|
||||
```
|
||||
|
@ -26,7 +26,7 @@ Flags are controlled by modifier:
|
||||
|
||||
{% code title="dnsconfig.js" %}
|
||||
```javascript
|
||||
D("example.com", REG_MY_PROVIDER, DnsProvider("GCLOUD"),
|
||||
D("example.com", REG_MY_PROVIDER, DnsProvider(DSP_MY_PROVIDER),
|
||||
// Allow letsencrypt to issue certificate for this domain
|
||||
CAA("@", "issue", "letsencrypt.org"),
|
||||
// Allow no CA to issue wildcard certificate for this domain
|
||||
|
@ -17,7 +17,7 @@ Target should be a string representing the CNAME target. If it is a single label
|
||||
|
||||
{% code title="dnsconfig.js" %}
|
||||
```javascript
|
||||
D("example.com", REG_MY_PROVIDER, DnsProvider("R53"),
|
||||
D("example.com", REG_MY_PROVIDER, DnsProvider(DSP_MY_PROVIDER),
|
||||
CNAME("foo", "google.com."), // foo.example.com -> google.com
|
||||
CNAME("abc", "@"), // abc.example.com -> example.com
|
||||
CNAME("def", "test"), // def.example.com -> test.example.com
|
||||
|
@ -28,7 +28,7 @@ Digest must be a string.
|
||||
|
||||
{% code title="dnsconfig.js" %}
|
||||
```javascript
|
||||
D("example.com", REG_MY_PROVIDER, DnsProvider(R53),
|
||||
D("example.com", REG_MY_PROVIDER, DnsProvider(DSP_MY_PROVIDER),
|
||||
DS("example.com", 2371, 13, 2, "ABCDEF")
|
||||
);
|
||||
```
|
||||
|
@ -14,7 +14,7 @@ NS records are currently a special case, and do not inherit from `DefaultTTL`. S
|
||||
|
||||
{% code title="dnsconfig.js" %}
|
||||
```javascript
|
||||
D("example.com", REG_MY_PROVIDER, DnsProvider("R53"),
|
||||
D("example.com", REG_MY_PROVIDER, DnsProvider(DSP_MY_PROVIDER),
|
||||
DefaultTTL("4h"),
|
||||
A("@","1.2.3.4"), // uses default
|
||||
A("foo", "2.3.4.5", TTL(600)) // overrides default
|
||||
|
@ -11,11 +11,11 @@ Includes all records from a given domain
|
||||
|
||||
{% code title="dnsconfig.js" %}
|
||||
```javascript
|
||||
D("example.com!external", REG_MY_PROVIDER, DnsProvider(R53),
|
||||
D("example.com!external", REG_MY_PROVIDER, DnsProvider(DSP_MY_PROVIDER),
|
||||
A("test", "8.8.8.8")
|
||||
);
|
||||
|
||||
D("example.com!internal", REG_MY_PROVIDER, DnsProvider(R53),
|
||||
D("example.com!internal", REG_MY_PROVIDER, DnsProvider(DSP_MY_PROVIDER),
|
||||
INCLUDE("example.com!external"),
|
||||
A("home", "127.0.0.1")
|
||||
);
|
||||
|
@ -20,7 +20,7 @@ Target should be a string representing the MX target. If it is a single label we
|
||||
|
||||
{% code title="dnsconfig.js" %}
|
||||
```javascript
|
||||
D("example.com", REG_MY_PROVIDER, DnsProvider(R53),
|
||||
D("example.com", REG_MY_PROVIDER, DnsProvider(DSP_MY_PROVIDER),
|
||||
MX("@", 5, "mail"), // mx example.com -> mail.example.com
|
||||
MX("sub", 10, "mail.foo.com.")
|
||||
);
|
||||
|
@ -14,7 +14,7 @@ The value can be an integer or a string. See [`TTL`](../record/TTL.md) for examp
|
||||
|
||||
{% code title="dnsconfig.js" %}
|
||||
```javascript
|
||||
D("example.com", REG_MY_PROVIDER, DnsProvider("R53"),
|
||||
D("example.com", REG_MY_PROVIDER, DnsProvider(DSP_MY_PROVIDER),
|
||||
NAMESERVER_TTL("2d"),
|
||||
NAMESERVER("ns")
|
||||
);
|
||||
@ -25,7 +25,7 @@ Use `NAMESERVER_TTL("3600"),` or `NAMESERVER_TTL("1h"),` for a 1h default TTL fo
|
||||
|
||||
{% code title="dnsconfig.js" %}
|
||||
```javascript
|
||||
D("example.com", REG_MY_PROVIDER, DnsProvider("xyz"),
|
||||
D("example.com", REG_MY_PROVIDER, DnsProvider(DSP_MY_PROVIDER),
|
||||
DefaultTTL("4h"),
|
||||
NAMESERVER_TTL("3600"),
|
||||
NAMESERVER("ns1.provider.com."), //inherits NAMESERVER_TTL
|
||||
|
@ -187,7 +187,7 @@ D("4.3.2.1.5.5.5.0.0.8.1.e164.arpa.", REG_MY_PROVIDER, DnsProvider(R53),
|
||||
|
||||
{% code title="dnsconfig.js" %}
|
||||
```javascript
|
||||
D("example.com", REG_MY_PROVIDER, DnsProvider(R53),
|
||||
D("example.com", REG_MY_PROVIDER, DnsProvider(DSP_MY_PROVIDER),
|
||||
NAPTR("@", 20, 50, "s", "SIPS+D2T", "", "_sips._tcp.example.com."),
|
||||
NAPTR("@", 20, 50, "s", "SIP+D2T", "", "_sip._tcp.example.com."),
|
||||
NAPTR("@", 30, 50, "s", "SIP+D2U", "", "_sip._udp.example.com."),
|
||||
@ -208,7 +208,7 @@ D("example.com", REG_MY_PROVIDER, DnsProvider(R53),
|
||||
|
||||
{% code title="dnsconfig.js" %}
|
||||
```javascript
|
||||
D("example.com", REG_MY_PROVIDER, DnsProvider(R53),
|
||||
D("example.com", REG_MY_PROVIDER, DnsProvider(DSP_MY_PROVIDER),
|
||||
NAPTR("@",100, 50, "a", "z3950+N2L+N2C", "", "cidserver.example.com."),
|
||||
NAPTR("@", 50, 50, "a", "rcds+N2C", "", "cidserver.example.com."),
|
||||
NAPTR("@", 30, 50, "s", "http+N2L+N2C+N2R", "", "www.example.com."),
|
||||
|
@ -20,7 +20,7 @@ Target should be a string representing the NS target. If it is a single label we
|
||||
|
||||
{% code title="dnsconfig.js" %}
|
||||
```javascript
|
||||
D("example.com", REG_MY_PROVIDER, DnsProvider("R53"),
|
||||
D("example.com", REG_MY_PROVIDER, DnsProvider(DSP_MY_PROVIDER),
|
||||
NS("foo", "ns1.example2.com."), // Delegate ".foo.example.com" zone to another server.
|
||||
NS("foo", "ns2.example2.com."), // Delegate ".foo.example.com" zone to another server.
|
||||
A("ns1.example2.com", "10.10.10.10"), // Glue records
|
||||
|
@ -24,7 +24,7 @@ parameter_types:
|
||||
|
||||
{% code title="dnsconfig.js" %}
|
||||
```javascript
|
||||
D("example.com", REG_MY_PROVIDER, DnsProvider("DNS_BIND"),
|
||||
D("example.com", REG_MY_PROVIDER, DnsProvider(DSP_MY_PROVIDER),
|
||||
SOA("@", "ns3.example.com.", "hostmaster@example.com", 3600, 600, 604800, 1440),
|
||||
);
|
||||
```
|
||||
|
@ -22,7 +22,7 @@ Priority, weight, and port are ints.
|
||||
|
||||
{% code title="dnsconfig.js" %}
|
||||
```javascript
|
||||
D("example.com", REG_MY_PROVIDER, DnsProvider("GCLOUD"),
|
||||
D("example.com", REG_MY_PROVIDER, DnsProvider(DSP_MY_PROVIDER),
|
||||
// Create SRV records for a a SIP service:
|
||||
// pr w port, target
|
||||
SRV("_sip._tcp", 10, 60, 5060, "bigbox.example.com."),
|
||||
|
@ -24,7 +24,7 @@ Certificate is a hex string.
|
||||
|
||||
{% code title="dnsconfig.js" %}
|
||||
```javascript
|
||||
D("example.com", REG_MY_PROVIDER, DnsProvider("GCLOUD"),
|
||||
D("example.com", REG_MY_PROVIDER, DnsProvider(DSP_MY_PROVIDER),
|
||||
// Create TLSA record for certificate used on TCP port 443
|
||||
TLSA("_443._tcp", 3, 1, 1, "abcdef0"),
|
||||
);
|
||||
|
@ -23,11 +23,8 @@ Modifier arguments are processed according to type as follows:
|
||||
|
||||
{% code title="dnsconfig.js" %}
|
||||
```javascript
|
||||
var REG_NAMECOM = NewRegistrar("name.com");
|
||||
var r53 = NewDnsProvider("R53");
|
||||
|
||||
// simple domain
|
||||
D("example.com", REG_NAMECOM, DnsProvider(r53),
|
||||
D("example.com", REG_MY_PROVIDER, DnsProvider(DSP_MY_PROVIDER),
|
||||
A("@","1.2.3.4"),
|
||||
CNAME("test", "foo.example2.com.")
|
||||
);
|
||||
@ -41,7 +38,7 @@ var GOOGLE_APPS_DOMAIN_MX = [
|
||||
MX("@", 10, "alt4.aspmx.l.google.com."),
|
||||
]
|
||||
|
||||
D("example.com", REG_MY_PROVIDER, DnsProvider(r53),
|
||||
D("example.com", REG_MY_PROVIDER, DnsProvider(DSP_MY_PROVIDER),
|
||||
A("@","1.2.3.4"),
|
||||
CNAME("test", "foo.example2.com."),
|
||||
GOOGLE_APPS_DOMAIN_MX
|
||||
|
@ -22,9 +22,7 @@ DEFAULTS(
|
||||
DefaultTTL("1d")
|
||||
);
|
||||
|
||||
D("example.com",
|
||||
REGISTRAR,
|
||||
DnsProvider("R53"),
|
||||
D("example.com", REG_MY_PROVIDER, DnsProvider(DSP_MY_PROVIDER),
|
||||
A("@","1.2.3.4")
|
||||
);
|
||||
```
|
||||
@ -37,9 +35,7 @@ The domain `example2.com` will **not** have the defaults set.
|
||||
```javascript
|
||||
DEFAULTS();
|
||||
|
||||
D("example2.com",
|
||||
REGISTRAR,
|
||||
DnsProvider("R53"),
|
||||
D("example2.com", REG_MY_PROVIDER, DnsProvider(DSP_MY_PROVIDER),
|
||||
A("@","1.2.3.4")
|
||||
);
|
||||
```
|
||||
|
@ -25,13 +25,13 @@ For example these two statements are equivalent:
|
||||
|
||||
{% code title="dnsconfig.js" %}
|
||||
```javascript
|
||||
DOMAIN_ELSEWHERE("example.com", REG_NAMEDOTCOM, ["ns1.foo.com", "ns2.foo.com"]);
|
||||
DOMAIN_ELSEWHERE("example.com", REG_MY_PROVIDER, ["ns1.foo.com", "ns2.foo.com"]);
|
||||
```
|
||||
{% endcode %}
|
||||
|
||||
{% code title="dnsconfig.js" %}
|
||||
```javascript
|
||||
D("example.com", REG_NAMEDOTCOM,
|
||||
D("example.com", REG_MY_PROVIDER, DnsProvider(DSP_MY_PROVIDER),
|
||||
NO_PURGE,
|
||||
NAMESERVER("ns1.foo.com"),
|
||||
NAMESERVER("ns2.foo.com")
|
||||
|
@ -22,10 +22,7 @@ Otherwise the syntax of `FETCH` is the same as `fetch`.
|
||||
|
||||
{% code title="dnsconfig.js" %}
|
||||
```javascript
|
||||
var REG_NONE = NewRegistrar("none");
|
||||
var DNS_BIND = NewDnsProvider("bind");
|
||||
|
||||
D("example.com", REG_NONE, DnsProvider(DNS_BIND), [
|
||||
D("example.com", REG_MY_PROVIDER, DnsProvider(DSP_MY_PROVIDER), [
|
||||
A("@", "1.2.3.4"),
|
||||
]);
|
||||
|
||||
|
@ -8,8 +8,8 @@ ts_return: string
|
||||
---
|
||||
|
||||
`REV` returns the reverse lookup domain for an IP network. For
|
||||
example `REV('1.2.3.0/24')` returns `3.2.1.in-addr.arpa.` and
|
||||
`REV('2001:db8:302::/48)` returns `2.0.3.0.8.b.d.0.1.0.0.2.ip6.arpa.`.
|
||||
example `REV("1.2.3.0/24")` returns `3.2.1.in-addr.arpa.` and
|
||||
`REV("2001:db8:302::/48")` returns `2.0.3.0.8.b.d.0.1.0.0.2.ip6.arpa.`.
|
||||
This is used in [`D()`](D.md) functions to create reverse DNS lookup zones.
|
||||
|
||||
This is a convenience function. You could specify `D("3.2.1.in-addr.arpa",
|
||||
|
@ -23,7 +23,7 @@ of the call.
|
||||
```javascript
|
||||
require("kubernetes/clusters.js");
|
||||
|
||||
D("example.com", REG_MY_PROVIDER, PROVIDER,
|
||||
D("example.com", REG_MY_PROVIDER, DnsProvider(DSP_MY_PROVIDER),
|
||||
IncludeKubernetes()
|
||||
);
|
||||
```
|
||||
|
@ -26,7 +26,7 @@ The value can be:
|
||||
|
||||
{% code title="dnsconfig.js" %}
|
||||
```javascript
|
||||
D("example.com", REG_MY_PROVIDER, DnsProvider("R53"),
|
||||
D("example.com", REG_MY_PROVIDER, DnsProvider(DSP_MY_PROVIDER),
|
||||
DefaultTTL(2000),
|
||||
A("@","1.2.3.4"), // uses default
|
||||
A("foo", "2.3.4.5", TTL(500)), // overrides default
|
||||
|
@ -249,7 +249,7 @@ Done. 1 corrections.
|
||||
## 6. Make a change
|
||||
|
||||
Try making a change to `dnsconfig.js`. For example, change the IP
|
||||
address of in `A('@', '1.2.3.4')` or add an additional A record.
|
||||
address of in `A("@", "1.2.3.4")` or add an additional A record.
|
||||
|
||||
In our case, we changed the IP address to 10.10.10.10. Previewing
|
||||
our change looks like this:
|
||||
|
Reference in New Issue
Block a user