Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions documentation/language-reference/domain-modifiers/A.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ parameter_types:
"modifiers...": RecordModifier[]
---

A adds an A record To a domain. The name should be the relative label for the record. Use `@` for the domain apex.
`A` adds an [IPv4 Address record](https://www.rfc-editor.org/rfc/rfc1035) to a domain. The name should be the relative label for the record. Use `@` for the domain apex.

The address should be an ip address, either a string, or a numeric value obtained via [IP](../top-level-functions/IP.md).
The address should be an IP address, either a string, or a numeric value obtained via [IP](../top-level-functions/IP.md).

Modifiers can be any number of [record modifiers](https://docs.dnscontrol.org/language-reference/record-modifiers) or JSON objects, which will be merged into the record's metadata.

Expand Down
2 changes: 1 addition & 1 deletion documentation/language-reference/domain-modifiers/AAAA.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ parameter_types:
"modifiers...": RecordModifier[]
---

AAAA adds an AAAA record To a domain. The name should be the relative label for the record. Use `@` for the domain apex.
`AAAA` adds an [IPv6 Address record](https://www.rfc-editor.org/rfc/rfc3596) to a domain. The name should be the relative label for the record. Use `@` for the domain apex.

The address should be an IPv6 address as a string.

Expand Down
2 changes: 1 addition & 1 deletion documentation/language-reference/domain-modifiers/CAA.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ parameter_types:
"modifiers...": RecordModifier[]
---

`CAA()` adds a CAA record to a domain. The name should be the relative label for the record. Use `@` for the domain apex.
`CAA` adds a [Certification Authority Authorization record](https://www.rfc-editor.org/rfc/rfc8659) to a domain. The name should be the relative label for the record. Use `@` for the domain apex.

Tag can be one of
1. `"issue"`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,9 @@ parameter_types:
ttl: Duration?
---

DNSControl contains a `CAA_BUILDER` which can be used to simply create
[`CAA()`](../domain-modifiers/CAA.md) records for your domains. Instead of creating each [`CAA()`](../domain-modifiers/CAA.md) record
`CAA_BUILDER` adds a [Certification Authority Authorization record](https://www.rfc-editor.org/rfc/rfc8659) to a domain.

`CAA_BUILDER` eases the creation of [`CAA`](CAA.md) records. Instead of creating each [`CAA`](CAA.md) record
individually, you can simply configure your report mail address, the
authorized certificate authorities and the builder cares about the rest.

Expand All @@ -55,7 +56,7 @@ D("example.com", REG_MY_PROVIDER, DnsProvider(DSP_MY_PROVIDER),
```
{% endcode %}

`CAA_BUILDER()` builds multiple records:
`CAA_BUILDER` builds multiple records:

{% code title="dnsconfig.js" %}
```javascript
Expand Down Expand Up @@ -100,7 +101,7 @@ D("example.com", REG_MY_PROVIDER, DnsProvider(DSP_MY_PROVIDER),
```
{% endcode %}

`CAA_BUILDER()` then builds (the same) multiple records - all with CAA_CRITICAL flag set:
`CAA_BUILDER` then builds (the same) multiple records - all with CAA_CRITICAL flag set:

{% code title="dnsconfig.js" %}
```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ generate "Dynamic Single Redirects" for a limited number of use cases. See
[`CLOUDFLAREAPI`](../../provider/cloudflareapi.md) for details.
{% endhint %}

`CF_REDIRECT` uses Cloudflare-specific features ("Forwarding URL" Page
`CF_REDIRECT` uses [Cloudflare](../../provider/cloudflareapi.md)-specific features ("Forwarding URL" Page
Rules) to generate a HTTP 301 permanent redirect.

If _any_ `CF_REDIRECT` or [`CF_TEMP_REDIRECT`](CF_TEMP_REDIRECT.md) functions are used then
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ parameter_types:
"modifiers...": RecordModifier[]
---

`CF_SINGLE_REDIRECT` is a Cloudflare-specific feature for creating HTTP redirects. 301, 302, 303, 307, 308 are supported.
`CF_SINGLE_REDIRECT` is a [Cloudflare](../../provider/cloudflareapi.md)-specific feature for creating HTTP redirects. 301, 302, 303, 307, 308 are supported.
Typically one uses 302 (temporary) or 301 (permanent).

This feature manages dynamic "Single Redirects". (Single Redirects can be
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ generate "Dynamic Single Redirects" for a limited number of use cases. See
[`CLOUDFLAREAPI`](../../provider/cloudflareapi.md) for details.
{% endhint %}

`CF_TEMP_REDIRECT` uses Cloudflare-specific features ("Forwarding URL" Page
`CF_TEMP_REDIRECT` uses [Cloudflare](../../provider/cloudflareapi.md)-specific features ("Forwarding URL" Page
Rules) to generate a HTTP 302 temporary redirect.

If _any_ [`CF_REDIRECT`](CF_REDIRECT.md) or `CF_TEMP_REDIRECT functions are used then
Expand Down
2 changes: 1 addition & 1 deletion documentation/language-reference/domain-modifiers/CNAME.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ parameter_types:
"modifiers...": RecordModifier[]
---

CNAME adds a CNAME record to the domain. The name should be the relative label for the domain.
`CNAME` adds a [Canonical name record](https://www.rfc-editor.org/rfc/rfc1035) to the domain. The name should be the relative label for the domain.
Using `@` or `*` for CNAME records is not recommended, as different providers support them differently.

Target should be a string representing the CNAME target. If it is a single label we will assume it is a relative name on the current domain. If it contains *any* dots, it should be a fully qualified domain name, ending with a `.`.
Expand Down
2 changes: 1 addition & 1 deletion documentation/language-reference/domain-modifiers/DHCID.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ parameter_types:
"modifiers...": RecordModifier[]
---

DHCID adds a DHCID record to the domain.
`DHCID` adds a [DHCP identifier record](https://www.rfc-editor.org/rfc/rfc4701) to the domain.

Digest should be a string.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@
name: DISABLE_IGNORE_SAFETY_CHECK
---

`DISABLE_IGNORE_SAFETY_CHECK()` disables the safety check. Normally it is an
error to insert records that match an `IGNORE()` pattern. This disables that
`DISABLE_IGNORE_SAFETY_CHECK` disables the safety check. Normally it is an
error to insert records that match an `IGNORE` pattern. This disables that
safety check for the entire domain.

It replaces the per-record `IGNORE_NAME_DISABLE_SAFETY_CHECK()` which is
It replaces the per-record `IGNORE_NAME_DISABLE_SAFETY_CHECK` which is
deprecated as of DNSControl v4.0.0.0.

See [`IGNORE()`](../domain-modifiers/IGNORE.md) for more information.
See [`IGNORE`](../domain-modifiers/IGNORE.md) for more information.

## Syntax

Expand Down
2 changes: 1 addition & 1 deletion documentation/language-reference/domain-modifiers/DNAME.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ parameter_types:
"modifiers...": RecordModifier[]
---

DNAME adds a DNAME record to the domain.
`DNAME` adds a [Delegation name record](https://www.rfc-editor.org/rfc/rfc6672) to the domain.

Target should be a string.

Expand Down
2 changes: 1 addition & 1 deletion documentation/language-reference/domain-modifiers/DS.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ parameter_types:
"modifiers...": RecordModifier[]
---

DS adds a DS record to the domain.
`DS` adds a [Delegation signer record](https://www.rfc-editor.org/rfc/rfc4034) to the domain.

Key Tag should be a number.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ parameter_types:
ttl: Duration
---

DefaultTTL sets the TTL for all subsequent records following it in a domain that do not explicitly set one with [`TTL`](../record-modifiers/TTL.md). If neither `DefaultTTL` or `TTL` exist for a record,
DefaultTTL sets the Time To Live (TTL) for all subsequent records following it in a domain that do not explicitly set one with [`TTL`](../record-modifiers/TTL.md). If neither `DefaultTTL` or `TTL` exist for a record,
the record will inherit the DNSControl global internal default of 300 seconds. See also [`DEFAULTS`](../top-level-functions/DEFAULTS.md) to override the internal defaults.

NS records are currently a special case, and do not inherit from `DefaultTTL`. See [`NAMESERVER_TTL`](../domain-modifiers/NAMESERVER_TTL.md) to set a default TTL for all NS records.
Expand Down
2 changes: 2 additions & 0 deletions documentation/language-reference/domain-modifiers/LOC.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@ parameter_types:
vertical_precision: number
---

`LOC` add a [Location record](https://www.rfc-editor.org/rfc/rfc1876) to the domain.

The parameter number types ingested are as follows:

```
Expand Down
2 changes: 1 addition & 1 deletion documentation/language-reference/domain-modifiers/MX.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ parameter_types:
"modifiers...": RecordModifier[]
---

MX adds an MX record to the domain.
`MX` adds a [Mail exchange record](https://www.rfc-editor.org/rfc/rfc1035) to the domain.

Priority should be a number.

Expand Down
2 changes: 1 addition & 1 deletion documentation/language-reference/domain-modifiers/NS.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ parameter_types:
"modifiers...": RecordModifier[]
---

NS adds a NS record to the domain. The name should be the relative label for the domain.
`NS` adds a [Name server record](https://www.rfc-editor.org/rfc/rfc1035) to the domain. The name should be the relative label for the domain.

The name may not be `@` (the bare domain), as that is controlled via [`NAMESERVER()`](NAMESERVER.md).
The difference between `NS()` and [`NAMESERVER()`](NAMESERVER.md) is explained in the [`NAMESERVER()` description](NAMESERVER.md).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ parameter_types:
"modifiers...": RecordModifier[]
---

OPENPGPKEY adds a OPENPGPKEY record to the domain.
`OPENPGPKEY` adds an [OpenPGP public key record](https://www.rfc-editor.org/rfc/rfc7929) to the domain.

So far, no transformation is applied to the parameters. The data will be passed to the DNS server as-is.
Reference RFC 7929 for details.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ parameter_types:
**DEPRECATED**: This record type is deprecated. Please use `URL` (for temporary redirects) or `URL301` (for permanent redirects) instead. PORKBUN_URLFWD will continue to work but is no longer recommended for new configurations.
{% endhint %}

`PORKBUN_URLFWD` is a Porkbun-specific feature that maps to Porkbun's URL forwarding feature, which creates HTTP 301 (permanent) or 302 (temporary) redirects.
`PORKBUN_URLFWD` is a [Porkbun](../../provider/porkbun.md)-specific feature that maps to Porkbun's URL forwarding feature, which creates HTTP 301 (permanent) or 302 (temporary) redirects.


{% code title="dnsconfig.js" %}
Expand Down
2 changes: 1 addition & 1 deletion documentation/language-reference/domain-modifiers/PTR.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ parameter_types:
"modifiers...": RecordModifier[]
---

PTR adds a PTR record to the domain.
`PTR` adds a [PTR Resource record](https://www.rfc-editor.org/rfc/rfc1035) to the domain.

The name is normally a relative label for the domain, or a FQDN that ends with `.`. If magic mode is enabled (see below) it can also be an IP address, which will be replaced by the proper string automatically, thus
saving the user from having to reverse the IP address manually.
Expand Down
6 changes: 5 additions & 1 deletion documentation/language-reference/domain-modifiers/RP.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,13 @@ parameter_types:
"modifiers...": RecordModifier[]
---

`RP()` adds an RP record to a domain.
`RP` adds an [Responsible Person record](https://www.rfc-editor.org/rfc/rfc1183) to a domain.

An RP record contains contact details for the domain. Usually an email address with the `@` replaced by a `.`.

{% hint style="warning" %}
The RP implementation in DNSControl is still experimental and may change.
{% endhint %}

{% code title="dnsconfig.js" %}
```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ parameter_types:
"modifiers...": RecordModifier[]
---

`SMIMEA` adds a `SMIMEA` record to a domain. The name should be the hashed and stripped local part of the e-mail.
`SMIMEA` adds an [S/MIME cert association record](https://www.rfc-editor.org/rfc/rfc8162) to a domain. The name should be the hashed and stripped local part of the e-mail.

To create the name, you can the following command:

Expand Down
6 changes: 3 additions & 3 deletions documentation/language-reference/domain-modifiers/SOA.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ parameter_types:
"modifiers...": RecordModifier[]
---

`SOA` adds an `SOA` record to a domain. The name should be `@`. ns and mbox are strings. The other fields are unsigned 32-bit ints.
`SOA` adds a [Start of Authority record](https://www.rfc-editor.org/rfc/rfc1035) to a domain. The name should be `@`. ns and mbox are strings. The other fields are unsigned 32-bit ints.

{% code title="dnsconfig.js" %}
```javascript
Expand All @@ -31,8 +31,8 @@ D("example.com", REG_MY_PROVIDER, DnsProvider(DSP_MY_PROVIDER),
{% endcode %}

## Notes
* The serial number is managed automatically. It isn't even a field in `SOA()`.
* Most providers automatically generate SOA records. They will ignore any `SOA()` statements.
* The serial number is managed automatically. It isn't even a field in `SOA`.
* Most providers automatically generate SOA records. They will ignore any `SOA` statements.
* The mbox field should not be set to a real email address unless you love spam and hate your privacy.

There is more info about `SOA` in the documentation for the [BIND provider](../../provider/bind.md).
2 changes: 1 addition & 1 deletion documentation/language-reference/domain-modifiers/SRV.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ parameter_types:
"modifiers...": RecordModifier[]
---

`SRV` adds a `SRV` record to a domain. The name should be the relative label for the record.
`SRV` adds a [Service locator record](https://www.rfc-editor.org/rfc/rfc2782) to a domain. The name should be the relative label for the record.

Priority, weight, and port are ints.

Expand Down
2 changes: 1 addition & 1 deletion documentation/language-reference/domain-modifiers/SSHFP.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ parameter_types:
"modifiers...": RecordModifier[]
---

`SSHFP` contains a fingerprint of a SSH server which can be validated before SSH clients are establishing the connection.
`SSHFP` adds a [SSH Public Key Fingerprint record](https://www.rfc-editor.org/rfc/rfc4255) to the domain. The record contains a fingerprint of a SSH server which can be validated before SSH clients are establishing the connection.

**Algorithm** (type of the key)

Expand Down
2 changes: 1 addition & 1 deletion documentation/language-reference/domain-modifiers/SVCB.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ parameter_types:
"modifiers...": RecordModifier[]
---

SVCB adds an SVCB record to a domain. The name should be the relative label for the record. Use `@` for the domain apex.
`SVCB` adds a [Service Binding record](https://www.rfc-editor.org/rfc/rfc9460) to a domain. The name should be the relative label for the record. Use `@` for the domain apex.

The priority must be a positive number, the address should be an ip address, either a string, or a numeric value obtained via [IP](../top-level-functions/IP.md).

Expand Down
2 changes: 1 addition & 1 deletion documentation/language-reference/domain-modifiers/TLSA.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ parameter_types:
"modifiers...": RecordModifier[]
---

`TLSA` adds a `TLSA` record to a domain. The name should be the relative label for the record.
`TLSA` adds a [TLSA certificate association record](https://www.rfc-editor.org/rfc/rfc6698) to a domain. The name should be the relative label for the record.

Usage, selector, and type are ints.

Expand Down
2 changes: 1 addition & 1 deletion documentation/language-reference/domain-modifiers/TXT.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ parameter_types:
"modifiers...": RecordModifier[]
---

`TXT` adds an `TXT` record To a domain. The name should be the relative
`TXT` adds a [Text record](https://www.rfc-editor.org/rfc/rfc1035) to a domain. The name should be the relative
label for the record. Use `@` for the domain apex.

The contents is either a single or multiple strings. To
Expand Down