diff --git a/docs/_functions/domain/CAA.md b/docs/_functions/domain/CAA.md index df37eef7d..ca64e0879 100644 --- a/docs/_functions/domain/CAA.md +++ b/docs/_functions/domain/CAA.md @@ -13,11 +13,11 @@ Tag can be one of "issue", "issuewild" or "iodef". Value is a string. The format of the contents is different depending on the tag. DNSControl will handle any escaping or quoting required, similar to TXT records. For example use `CAA("@", "issue", "letsencrypt.org")` rather than `CAA("@", "issue", "\"letsencrypt.org\"")`. -Flags are controlled by modifier.: +Flags are controlled by modifier: - CAA_CRITICAL: Issuer critical flag. CA that does not understand this tag will refuse to issue certificate for this domain. -CAA record is supported only by BIND, Google Cloud DNS, and Amazon Route 53. Some certificate authorities may not support this record until the mandatory date of September 2017. +CAA record is supported only by BIND, Google Cloud DNS, Amazon Route 53 and OVH. Some certificate authorities may not support this record until the mandatory date of September 2017. {% include startExample.html %} {% highlight js %} diff --git a/docs/_functions/domain/NS.md b/docs/_functions/domain/NS.md index d93512738..5187ab062 100644 --- a/docs/_functions/domain/NS.md +++ b/docs/_functions/domain/NS.md @@ -15,8 +15,8 @@ Target should be a string representing the NS target. If it is a single label we {% highlight js %} D("example.com", REGISTRAR, DnsProvider("R53"), - 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. + 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 A("ns2.example2.com", "10.10.10.20"), // Glue records ); diff --git a/docs/_functions/domain/SSHFP.md b/docs/_functions/domain/SSHFP.md new file mode 100644 index 000000000..2e86e448a --- /dev/null +++ b/docs/_functions/domain/SSHFP.md @@ -0,0 +1,37 @@ +--- +name: SSHFP +parameters: + - name + - algorithm + - type + - value + - modifiers... +--- + +SSHFP contains a fingerprint of a SSH server which can be validated before SSH clients are establishing the connection. + +**Algorithm** (type of the key) +| ID | Algorithm | +|----|-----------| +| 0 | reserved | +| 1 | RSA | +| 2 | DSA | +| 3 | ECDSA | +| 4 | ED25519 | + +**Type** (fingerprint format) +| ID | Algorithm | +|----|-----------| +| 0 | reserved | +| 1 | SHA-1 | +| 2 | SHA-256 | + +`value` is the fingerprint as a string. + +{% include startExample.html %} +{% highlight js %} + +SSHFP('@', 1, 1, '00yourAmazingFingerprint00'), + +{%endhighlight%} +{% include endExample.html %} diff --git a/docs/_functions/global/IP.md b/docs/_functions/global/IP.md index e69de29bb..9c5be23e7 100644 --- a/docs/_functions/global/IP.md +++ b/docs/_functions/global/IP.md @@ -0,0 +1,17 @@ +--- +name: IP +parameters: + - ip +--- + +Converts the IP address from string to an integer. This allows performing mathematical operations with the IP address. + +{% include startExample.html %} +{% highlight js %} + +var addrA = IP('1.2.3.4') +var addrB = addrA + 1 +// addrB = 1.2.3.5 + +{%endhighlight%} +{% include endExample.html %} diff --git a/docs/_includes/matrix.html b/docs/_includes/matrix.html index c03d789f4..b3793f9a0 100644 --- a/docs/_includes/matrix.html +++ b/docs/_includes/matrix.html @@ -136,6 +136,9 @@ + + + @@ -285,6 +288,9 @@ + + + @@ -293,8 +299,8 @@ - - + + @@ -329,6 +335,9 @@ + + + @@ -352,6 +361,31 @@ + + NAPTR + + + + + + + + + + + + + + + + + + + + + + + SRV @@ -381,6 +415,9 @@ + + + @@ -408,6 +445,33 @@ + + SSHFP + + + + + + + + + + + + + + + + + + + + + + + + + TLSA @@ -456,13 +520,13 @@ - - - - - - + + + + + + @@ -488,6 +552,7 @@ + @@ -498,7 +563,6 @@ - @@ -520,8 +584,8 @@ - - + + diff --git a/docs/_providers/cloudflare.md b/docs/_providers/cloudflare.md index a1ad7dbc0..dc35f0a0f 100644 --- a/docs/_providers/cloudflare.md +++ b/docs/_providers/cloudflare.md @@ -52,10 +52,19 @@ What does on/off/full mean? * "on" enables the Cloudflare proxy (turns on the "orange cloud") * "full" is the same as "on" but also enables Railgun. DNSControl will prevent you from accidentally enabling "full" on a CNAME that points to an A record that is set to "off", as this is generally not desired. +Good to know: You can also set the default proxy mode using `DEFAULTS()` function, see: +{% highlight js %} + +DEFAULTS( + CF_PROXY_DEFAULT_OFF // turn proxy off when not specified otherwise +); + +{% endhighlight %} + **Aliases:** To make configuration files more readable and less prone to errors, -the following aliases are pre-defined: +the following aliases are *pre-defined*: {% highlight js %} // Meta settings for individual records. diff --git a/docs/caa-builder.md b/docs/caa-builder.md index 2025ab6bb..fc04f707a 100644 --- a/docs/caa-builder.md +++ b/docs/caa-builder.md @@ -18,7 +18,7 @@ For example you can use: ``` CAA_BUILDER({ label: "@", - iodef: "test@domain.tld", + iodef: "mailto:test@domain.tld", iodef_critical: true, issue: [ "letsencrypt.org", @@ -38,7 +38,7 @@ The parameters are: `CAA_BUILDER()` returns multiple records (when configured as example above): - * `CAA("@", "iodef", "test@domain.tld", CAA_CRITICAL)` + * `CAA("@", "iodef", "mailto:test@domain.tld", CAA_CRITICAL)` * `CAA("@", "issue", "letsencrypt.org")` * `CAA("@", "issue", "comodoca.com")` * `CAA("@", "issuewild", ";")` diff --git a/docs/examples.md b/docs/examples.md index 175470d8c..84751c7e9 100644 --- a/docs/examples.md +++ b/docs/examples.md @@ -21,8 +21,8 @@ D('example.com', REG, DnsProvider('GCLOUD'), MX('mail', 10, 'mailserver'), MX('mail', 20, 'mailqueue'), TXT('the', 'message'), - NS('delegated', 'ns1.dnsexample.com.'), - NS('delegated', 'ns2.dnsexample.com.') + NS('department2', 'ns1.dnsexample.com.'), // use different nameservers + NS('department2', 'ns2.dnsexample.com.') // for department2.example.com ) {% endhighlight %} @@ -31,10 +31,17 @@ D('example.com', REG, DnsProvider('GCLOUD'), {% highlight javascript %} +var mailTTL = TTL('1h'); + D('example.com', registrar, + NAMESERVER_TTL('10m'), // On domain apex NS RRs DefaultTTL('5m'), // Default for a domain + + MX('@', 5, '1.2.3.4', mailTTL), // use variable to + MX('@', 10, '4.3.2.1', mailTTL), // set TTL + A('@', '1.2.3.4', TTL('10m')), // individual record - NAMESERVER_TTL('10m') // On domain apex NS RRs + CNAME('mail', 'mx01') // TTL of 5m, as defined per DefaultTTL() ); {% endhighlight %} @@ -138,3 +145,15 @@ D('example3.com', REG, DnsProvider('R53'), DnsProvider('GCLOUD',0), ) {% endhighlight %} + +## Set default records modifiers + +{% highlight javascript %} + +DEFAULTS( + NAMESERVER_TTL('24h'), + DefaultTTL('12h'), + CF_PROXY_DEFAULT_OFF +); + +{% endhighlight %} diff --git a/docs/index.md b/docs/index.md index 486006cc9..ed3d4b1b9 100644 --- a/docs/index.md +++ b/docs/index.md @@ -114,7 +114,7 @@ title: DnsControl SPF Optimizer: Optimize your SPF records
  • - : Build CAA records the easy way + CAA Builder: Build CAA records the easy way
    • diff --git a/docs/provider-list.md b/docs/provider-list.md index a14023a5f..0d110670e 100644 --- a/docs/provider-list.md +++ b/docs/provider-list.md @@ -95,19 +95,24 @@ These providers have an open pr with (potentially) working code. They may be rea