aboutsummaryrefslogtreecommitdiff
path: root/plugin/dns64/README.md
diff options
context:
space:
mode:
authorGravatar Miek Gieben <miek@miek.nl> 2020-04-23 10:22:20 +0200
committerGravatar GitHub <noreply@github.com> 2020-04-23 10:22:20 +0200
commitec5696b20268bcfe319a7953b3712445b7c5a739 (patch)
tree567e24587e1f4e247a0a0339e25069f24bb118c6 /plugin/dns64/README.md
parent8fe950f4bc161ff45a7cbda9b9059db02fa3701f (diff)
downloadcoredns-ec5696b20268bcfe319a7953b3712445b7c5a739.tar.gz
coredns-ec5696b20268bcfe319a7953b3712445b7c5a739.tar.zst
coredns-ec5696b20268bcfe319a7953b3712445b7c5a739.zip
plugin/dns64: update readme and owners (#3848)
* plugin/dns64: update readme and owners Make @superq code owner of the plugins. Update the readme a bit: * don't make it start with a quote * make it look more like other README's in syntax description * make a full corefile examples and tests these by setting the corefile language tag Signed-off-by: Miek Gieben <miek@miek.nl> * Update plugin/dns64/README.md Co-Authored-By: Ben Kochie <superq@gmail.com> * Update plugin/dns64/README.md Co-Authored-By: Ben Kochie <superq@gmail.com> * Update plugin/dns64/README.md Co-Authored-By: Ben Kochie <superq@gmail.com> * Update plugin/dns64/README.md Co-Authored-By: Ben Kochie <superq@gmail.com> * Update plugin/dns64/README.md Co-Authored-By: Ben Kochie <superq@gmail.com> Co-authored-by: Ben Kochie <superq@gmail.com>
Diffstat (limited to '')
-rw-r--r--plugin/dns64/README.md61
1 files changed, 40 insertions, 21 deletions
diff --git a/plugin/dns64/README.md b/plugin/dns64/README.md
index 6f3709336..24a092fe8 100644
--- a/plugin/dns64/README.md
+++ b/plugin/dns64/README.md
@@ -6,55 +6,70 @@
## Description
-> DNS64 describes a DNS server that when asked for a domain's AAAA records, but only finds
-> A records, synthesizes the AAAA records from the A records.
+The *dns64* plugin will when asked for a domain's AAAA records, but only finds A records,
+synthesizes the AAAA records from the A records.
-The synthesis in only performed if the query came in via IPv6.
+The synthesis is *only* performed **if the query came in via IPv6**.
This translation is for IPv6-only networks that have [NAT64](https://en.wikipedia.org/wiki/NAT64).
-See [RFC 6147](https://tools.ietf.org/html/rfc6147) for more information.
-
## Syntax
~~~
+dns64 [PREFIX]
+~~~
+
+* **PREFIX** defines a custom prefix instead of the default `64:ff9b::/96`.
+
+Or use this slightly longer form with more options:
+
+~~~
dns64 [PREFIX] {
- [translate_all]
+ [translate_all]
+ prefix PREFIX
}
~~~
-* [PREFIX] defines a custom prefix instead of the default `64:ff9b::/96`.
-* `translate_all` translates all queries, including respones that have AAAA results.
+* `prefix` specifies any local IPv6 prefix to use, instead of the well known prefix (64:ff9b::/96)
+* `translate_all` translates all queries, including responses that have AAAA results.
## Examples
-Translate with the default well known prefix. Applies to all queries.
+Translate with the default well known prefix. Applies to all queries (if they came in over IPv6).
~~~
-dns64
+. {
+ dns64
+}
~~~
Use a custom prefix.
-~~~
-dns64 64:1337::/96
-# Or
-dns64 {
- prefix 64:1337::/96
+~~~ corefile
+. {
+ dns64 64:1337::/96
+}
+~~~~
+
+Or
+~~~ corefile
+. {
+ dns64 {
+ prefix 64:1337::/96
+ }
}
~~~
Enable translation even if an existing AAAA record is present.
-~~~
-dns64 {
- translate_all
+~~~ corefile
+. {
+ dns64 {
+ translate_all
+ }
}
~~~
-* `prefix` specifies any local IPv6 prefix to use, instead of the well known prefix (64:ff9b::/96)
-
-
## Metrics
If monitoring is enabled (via the _prometheus_ plugin) then the following metrics are exported:
@@ -71,3 +86,7 @@ Not all features required by DNS64 are implemented, only basic AAAA synthesis.
* Resolve PTR records
* Follow CNAME records
* Make resolver DNSSEC aware. See: [RFC 6147 Section 3](https://tools.ietf.org/html/rfc6147#section-3)
+
+## Also See
+
+See [RFC 6147](https://tools.ietf.org/html/rfc6147) for more information on the DNS64 mechanism.