You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<!--
## Before submiting a pull request
Please make sure you've run the following commands from the root
directory.
bin/generate-all.sh
(this runs commands like "go generate", fixes formatting, and so on)
## Release changelog section
Help keep the release changelog clear by pre-naming the proper section
in the GitHub pull request title.
Some examples:
* CICD: Add required GHA permissions for goreleaser
* DOCS: Fixed providers with "contributor support" table
* ROUTE53: Allow R53_ALIAS records to enable target health evaluation
More examples/context can be found in the file .goreleaser.yml under the
'build' > 'changelog' key.
!-->
* A adds an A record To a domain. The name should be the relative label for the record. Use `@` for the domain apex.
182
+
* `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.
183
183
*
184
-
* The address should be an ip address, either a string, or a numeric value obtained via [IP](../top-level-functions/IP.md).
184
+
* The address should be an IP address, either a string, or a numeric value obtained via [IP](../top-level-functions/IP.md).
185
185
*
186
186
* 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.
* AAAA adds an AAAA record To a domain. The name should be the relative label for the record. Use `@` for the domain apex.
202
+
* `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.
203
203
*
204
204
* The address should be an IPv6 address as a string.
* `CAA()` adds a CAA record to a domain. The name should be the relative label for the record. Use `@` for the domain apex.
413
+
* `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.
414
414
*
415
415
* Tag can be one of
416
416
* 1. `"issue"`
@@ -445,8 +445,9 @@ declare function AZURE_ALIAS(name: string, type: "A" | "AAAA" | "CNAME", target:
* `CF_SINGLE_REDIRECT` is a Cloudflare-specific feature for creating HTTP redirects. 301, 302, 303, 307, 308 are supported.
590
+
* `CF_SINGLE_REDIRECT` is a [Cloudflare](../../provider/cloudflareapi.md)-specific feature for creating HTTP redirects. 301, 302, 303, 307, 308 are supported.
590
591
* Typically one uses 302 (temporary) or 301 (permanent).
591
592
*
592
593
* This feature manages dynamic "Single Redirects". (Single Redirects can be
* CNAME adds a CNAME record to the domain. The name should be the relative label for the domain.
699
+
* `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.
699
700
* Using `@` or `*` for CNAME records is not recommended, as different providers support them differently.
700
701
*
701
702
* 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 `.`.
* 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,
1301
+
* 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,
1301
1302
* 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.
1302
1303
*
1303
1304
* 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.
@@ -1969,6 +1970,8 @@ declare function INCLUDE(domain: string): DomainModifier;
1969
1970
declarefunctionIP(ip: string): number;
1970
1971
1971
1972
/**
1973
+
* `LOC` add a [Location record](https://www.rfc-editor.org/rfc/rfc1876) to the domain.
1974
+
*
1972
1975
* The parameter number types ingested are as follows:
* OPENPGPKEY adds a OPENPGPKEY record to the domain.
2889
+
* `OPENPGPKEY` adds an [OpenPGP public key record](https://www.rfc-editor.org/rfc/rfc7929) to the domain.
2887
2890
*
2888
2891
* So far, no transformation is applied to the parameters. The data will be passed to the DNS server as-is.
2889
2892
* Reference RFC 7929 for details.
@@ -2912,7 +2915,7 @@ declare function PANIC(message: string): never;
2912
2915
/**
2913
2916
* **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.
2914
2917
*
2915
-
* `PORKBUN_URLFWD` is a Porkbun-specific feature that maps to Porkbun's URL forwarding feature, which creates HTTP 301 (permanent) or 302 (temporary) redirects.
2918
+
* `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.
* `PTR` adds a [PTR Resource record](https://www.rfc-editor.org/rfc/rfc1035) to the domain.
2937
2940
*
2938
2941
* 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
2939
2942
* saving the user from having to reverse the IP address manually.
@@ -3255,7 +3258,9 @@ declare function REV(address: string): string;
3255
3258
declarefunctionREVCOMPAT(rfc: string): string;
3256
3259
3257
3260
/**
3258
-
* `RP()` adds an RP record to a domain.
3261
+
* `RP` adds an [Responsible Person record](https://www.rfc-editor.org/rfc/rfc1183) to a domain.
3262
+
*
3263
+
* An RP record contains contact details for the domain. Usually an email address with the `@` replaced by a `.`.
3259
3264
*
3260
3265
* The RP implementation in DNSControl is still experimental and may change.
3261
3266
*
@@ -3270,7 +3275,7 @@ declare function REVCOMPAT(rfc: string): string;
* `SMIMEA` adds a `SMIMEA` record to a domain. The name should be the hashed and stripped local part of the e-mail.
3278
+
* `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.
3274
3279
*
3275
3280
* To create the name, you can the following command:
* `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.
3310
+
* `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.
* `SSHFP` contains a fingerprint of a SSH server which can be validated before SSH clients are establishing the connection.
3632
+
* `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.
* SVCB adds an SVCB record to a domain. The name should be the relative label for the record. Use `@` for the domain apex.
3665
+
* `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.
3661
3666
*
3662
3667
* 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).
* `TLSA` adds a `TLSA` record to a domain. The name should be the relative label for the record.
3684
+
* `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.
0 commit comments