mirror of
https://github.com/coredns/coredns.git
synced 2025-12-09 03:45:11 -05:00
doc: make -f Makefile.doc (#2919)
mechanical change: create the manual pages. Signed-off-by: Miek Gieben <miek@miek.nl>
This commit is contained in:
@@ -1,15 +1,15 @@
|
||||
.\" Generated by Mmark Markdown Processer - mmark.nl
|
||||
.TH "COREDNS-TEMPLATE" "7" "April 2019" "CoreDNS" "CoreDNS Plugins"
|
||||
.TH "COREDNS-TEMPLATE" 7 "June 2019" "CoreDNS" "CoreDNS Plugins"
|
||||
|
||||
.SH NAME
|
||||
.SH "NAME"
|
||||
.PP
|
||||
\fItemplate\fP - allows for dynamic responses based on the incoming query.
|
||||
|
||||
.SH DESCRIPTION
|
||||
.SH "DESCRIPTION"
|
||||
.PP
|
||||
The \fItemplate\fP plugin allows you to dynamically respond to queries by just writing a (Go) template.
|
||||
|
||||
.SH SYNTAX
|
||||
.SH "SYNTAX"
|
||||
.PP
|
||||
.RS
|
||||
|
||||
@@ -58,7 +58,7 @@ At least one \fB\fCanswer\fR or \fB\fCrcode\fR directive is needed (e.g. \fB\fCr
|
||||
Also see
|
||||
\[la]#also-see\[ra] contains an additional reading list.
|
||||
|
||||
.SH TEMPLATES
|
||||
.SH "TEMPLATES"
|
||||
.PP
|
||||
Each resource record is a full-featured Go template
|
||||
\[la]https://golang.org/pkg/text/template/\[ra] with the following predefined data
|
||||
@@ -91,7 +91,7 @@ The output of the template must be a RFC 1035
|
||||
Caddy) while \fB\fC{{ $var }}\fR will work. See Bugs
|
||||
\[la]#bugs\[ra] and corefile(5).
|
||||
|
||||
.SH METRICS
|
||||
.SH "METRICS"
|
||||
.PP
|
||||
If monitoring is enabled (via the \fIprometheus\fP directive) then the following metrics are exported:
|
||||
|
||||
@@ -107,8 +107,8 @@ If monitoring is enabled (via the \fIprometheus\fP directive) then the following
|
||||
Both failure cases indicate a problem with the template configuration. The \fB\fCserver\fR label indicates
|
||||
the server incrementing the metric, see the \fImetrics\fP plugin for details.
|
||||
|
||||
.SH EXAMPLES
|
||||
.SS RESOLVE EVERYTHING TO NXDOMAIN
|
||||
.SH "EXAMPLES"
|
||||
.SS "RESOLVE EVERYTHING TO NXDOMAIN"
|
||||
.PP
|
||||
The most simplistic template is
|
||||
|
||||
@@ -133,7 +133,7 @@ All queries will be answered (no \fB\fCfallthrough\fR)
|
||||
The answer is always NXDOMAIN
|
||||
|
||||
|
||||
.SS RESOLVE .INVALID AS NXDOMAIN
|
||||
.SS "RESOLVE .INVALID AS NXDOMAIN"
|
||||
.PP
|
||||
The \fB\fC.invalid\fR domain is a reserved TLD (see RFC 2606 Reserved Top Level DNS Names
|
||||
\[la]https://tools.ietf.org/html/rfc2606#section-2\[ra]) to indicate invalid domains.
|
||||
@@ -164,7 +164,7 @@ Querying \fB\fC.invalid\fR in the \fB\fCCH\fR class will also cause a NXDOMAIN/S
|
||||
The default regex is \fB\fC.*\fR
|
||||
|
||||
|
||||
.SS BLOCK INVALID SEARCH DOMAIN COMPLETIONS
|
||||
.SS "BLOCK INVALID SEARCH DOMAIN COMPLETIONS"
|
||||
.PP
|
||||
Imagine you run \fB\fCexample.com\fR with a datacenter \fB\fCdc1.example.com\fR. The datacenter domain
|
||||
is part of the DNS search domain.
|
||||
@@ -212,7 +212,7 @@ A more verbose regex based equivalent would be
|
||||
.PP
|
||||
The regex-based version can do more complex matching/templating while zone-based templating is easier to read and use.
|
||||
|
||||
.SS RESOLVE A/PTR FOR .EXAMPLE
|
||||
.SS "RESOLVE A/PTR FOR .EXAMPLE"
|
||||
.PP
|
||||
.RS
|
||||
|
||||
@@ -252,7 +252,7 @@ Having templates to map certain PTR/A pairs is a common pattern.
|
||||
.PP
|
||||
Fallthrough is needed for mixed domains where only some responses are templated.
|
||||
|
||||
.SS RESOLVE MULTIPLE IP PATTERNS
|
||||
.SS "RESOLVE MULTIPLE IP PATTERNS"
|
||||
.PP
|
||||
.RS
|
||||
|
||||
@@ -274,7 +274,7 @@ Fallthrough is needed for mixed domains where only some responses are templated.
|
||||
.PP
|
||||
Named capture groups can be used to template one response for multiple patterns.
|
||||
|
||||
.SS RESOLVE A AND MX RECORDS FOR IP TEMPLATES IN .EXAMPLE
|
||||
.SS "RESOLVE A AND MX RECORDS FOR IP TEMPLATES IN .EXAMPLE"
|
||||
.PP
|
||||
.RS
|
||||
|
||||
@@ -298,7 +298,7 @@ Named capture groups can be used to template one response for multiple patterns.
|
||||
.fi
|
||||
.RE
|
||||
|
||||
.SS ADDING AUTHORITATIVE NAMESERVERS TO THE RESPONSE
|
||||
.SS "ADDING AUTHORITATIVE NAMESERVERS TO THE RESPONSE"
|
||||
.PP
|
||||
.RS
|
||||
|
||||
@@ -330,7 +330,7 @@ Named capture groups can be used to template one response for multiple patterns.
|
||||
.fi
|
||||
.RE
|
||||
|
||||
.SH ALSO SEE
|
||||
.SH "ALSO SEE"
|
||||
.IP \(bu 4
|
||||
Go regexp
|
||||
\[la]https://golang.org/pkg/regexp/\[ra] for details about the regex implementation
|
||||
@@ -346,7 +346,7 @@ Go template
|
||||
\[la]https://golang.org/pkg/text/template/\[ra] for the template language reference
|
||||
|
||||
|
||||
.SH BUGS
|
||||
.SH "BUGS"
|
||||
.PP
|
||||
CoreDNS supports caddyfile environment variables
|
||||
\[la]https://caddyserver.com/docs/caddyfile#env\[ra]
|
||||
|
||||
Reference in New Issue
Block a user