Skip to content

Commit

Permalink
Documentation improvements for dns64 plugin (coredns#3777)
Browse files Browse the repository at this point in the history
Minor typo and improvements to the dns64 plugin README.

Signed-off-by: Ben Kochie <[email protected]>
  • Loading branch information
SuperQ authored Mar 26, 2020
1 parent 19cfa29 commit 14ca454
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 12 deletions.
19 changes: 12 additions & 7 deletions man/coredns-dns64.7
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
.\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-DNS64" 7 "January 2020" "CoreDNS" "CoreDNS Plugins"
.TH "COREDNS-DNS64" 7 "March 2020" "CoreDNS" "CoreDNS Plugins"

.SH "NAME"
.PP
Expand All @@ -21,6 +21,10 @@ A records, synthesizes the AAAA records from the A records.
.PP
The synthesis in only performed if the query came in via IPv6.

.PP
This translation is for IPv6-only networks that have NAT64
\[la]https://en.wikipedia.org/wiki/NAT64\[ra].

.PP
See RFC 6147
\[la]https://tools.ietf.org/html/rfc6147\[ra] for more information.
Expand All @@ -31,21 +35,21 @@ See RFC 6147

.nf
dns64 [PREFIX] {
[translate\\\_all]
[translate\_all]
}

.fi
.RE

.IP \(bu 4
[PREFIX] defines a custom prefix instead of the default \fB\fC64:ff9b::/96\fR
[PREFIX] defines a custom prefix instead of the default \fB\fC64:ff9b::/96\fR.
.IP \(bu 4
\fB\fCtranslate_all\fR translates all queries, including respones that have AAAA results.


.SH "EXAMPLES"
.PP
Translate with the default well known prefix. Applies to all queries
Translate with the default well known prefix. Applies to all queries.

.PP
.RS
Expand All @@ -57,7 +61,7 @@ dns64
.RE

.PP
Use a custom prefix
Use a custom prefix.

.PP
.RS
Expand All @@ -72,7 +76,7 @@ dns64 {
.RE

.PP
Enable translation even if an existing AAAA record is present
Enable translation even if an existing AAAA record is present.

.PP
.RS
Expand Down Expand Up @@ -100,6 +104,7 @@ Resolve PTR records
.IP \(bu 4
Follow CNAME records
.IP \(bu 4
Make resolver DNSSEC aware
Make resolver DNSSEC aware. See: RFC 6147 Section 3
\[la]https://tools.ietf.org/html/rfc6147#section-3\[ra]


12 changes: 7 additions & 5 deletions plugin/dns64/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,28 +13,30 @@ From Wikipedia:
The synthesis in 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] {
[translate\_all]
[translate_all]
}
~~~

* [PREFIX] defines a custom prefix instead of the default `64:ff9b::/96`
* [PREFIX] defines a custom prefix instead of the default `64:ff9b::/96`.
* `translate_all` translates all queries, including respones 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.

~~~
dns64
~~~

Use a custom prefix
Use a custom prefix.

~~~
dns64 64:1337::/96
Expand All @@ -44,7 +46,7 @@ dns64 {
}
~~~

Enable translation even if an existing AAAA record is present
Enable translation even if an existing AAAA record is present.

~~~
dns64 {
Expand Down

0 comments on commit 14ca454

Please sign in to comment.