mirror of
https://github.com/coredns/coredns.git
synced 2025-11-01 18:53:43 -04:00
docs: Regenerate all manpages using mmark (#2762)
Mmark recently became able to create manual pages. This removed the dependency on 'ronn' and just uses mmark (Go program). Re-hookup Makefile.doc to generate the correct header mmark needs to see and regenate them all. Spot checking a few pages suggest they look good and actually better than rendered with ronn, esp. lists in lists. Fixes #2757 Signed-off-by: Miek Gieben <miek@miek.nl>
This commit is contained in:
Miek Gieben
GitHub
310
man/corefile.5
310
man/corefile.5
@@ -1,192 +1,204 @@
|
||||
.\" generated with Ronn/v0.7.3
|
||||
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
||||
.
|
||||
.TH "COREFILE" "5" "March 2019" "CoreDNS" "CoreDNS"
|
||||
.
|
||||
.SH "NAME"
|
||||
\fBcorefile\fR
|
||||
.
|
||||
.SH "NAME"
|
||||
\fIcorefile\fR \- configuration file for CoreDNS
|
||||
.
|
||||
.SH "DESCRIPTION"
|
||||
A \fIcorefile\fR specifies the (internal) servers CoreDNS should run and what plugins each of these should chain\. The syntax is as follows:
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
.nf
|
||||
.\" Generated by Mmark Markdown Processer - mmark.nl
|
||||
.TH "COREFILE" "5" "April 2019" "CoreDNS" "CoreDNS"
|
||||
|
||||
[SCHEME://]ZONE [[SCHEME://]ZONE]\.\.\.[:PORT] {
|
||||
[PLUGIN]\.\.\.
|
||||
.SH NAME
|
||||
.PP
|
||||
\fIcorefile\fP - configuration file for CoreDNS
|
||||
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
A \fIcorefile\fP specifies the (internal) servers CoreDNS should run and what plugins each of these
|
||||
should chain. The syntax is as follows:
|
||||
|
||||
.PP
|
||||
.RS
|
||||
|
||||
.nf
|
||||
[SCHEME://]ZONE [[SCHEME://]ZONE]...[:PORT] {
|
||||
[PLUGIN]...
|
||||
}
|
||||
.
|
||||
.fi
|
||||
.
|
||||
.IP "" 0
|
||||
.
|
||||
.P
|
||||
The \fBZONE\fR defines for which name this server should be called, multiple zones are allowed and should be \fIwhite space\fR separated\. You can use a "reverse" syntax to specify a reverse zone (i\.e\. ip6\.arpa and in\-addr\.arpa), by using an IP address in the CIDR notation\.
|
||||
.
|
||||
.P
|
||||
The optional \fBSCHEME\fR defaults to \fBdns://\fR, but can also be \fBtls://\fR (DNS over TLS), \fBgrpc://\fR (DNS over gRPC) or \fBhttps://\fR (DNS over HTTP/2)\.
|
||||
.
|
||||
.P
|
||||
The optional \fBPORT\fR controls on which port the server will bind, this default to 53\. If you use a port number here, you \fIcan\'t\fR override it with \fB\-dns\.port\fR (coredns(1))\.
|
||||
.
|
||||
.P
|
||||
Specifying a \fBZONE\fR \fIand\fR \fBPORT\fR combination multiple times for \fIdifferent\fR servers will lead to an error on startup\.
|
||||
.
|
||||
.P
|
||||
When a query comes in, it is matched again all zones for all servers, the server with the longest match on the query name will receive the query\.
|
||||
.
|
||||
.P
|
||||
\fBPLUGIN\fR defines the plugin(s) we want to load into this server\. This is optional as well, but as server with no plugins will just return SERVFAIL for all queries\. Each plugin can have a number of properties than can have arguments, see the documentation for each plugin\.
|
||||
.
|
||||
.P
|
||||
Comments are allowed and begin with an unquoted hash \fB#\fR and continue to the end of the line\. Comments may be started anywhere on a line\.
|
||||
.
|
||||
.P
|
||||
Environment variables are supported and either the Unix or Windows form may be used: \fB{$ENV_VAR_1}\fR or \fB{%ENV_VAR_2%}\fR\.
|
||||
.
|
||||
.P
|
||||
You can use the \fBimport\fR "plugin" to include parts of other files\.
|
||||
.
|
||||
.P
|
||||
If CoreDNS can’t find a Corefile to load it loads the following builtin one:
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
.nf
|
||||
|
||||
\&\. {
|
||||
.fi
|
||||
.RE
|
||||
|
||||
.PP
|
||||
The \fBZONE\fP defines for which name this server should be called, multiple zones are allowed and
|
||||
should be \fIwhite space\fP separated. You can use a "reverse" syntax to specify a reverse zone (i.e.
|
||||
ip6.arpa and in-addr.arpa), by using an IP address in the CIDR notation.
|
||||
|
||||
.PP
|
||||
The optional \fBSCHEME\fP defaults to \fB\fCdns://\fR, but can also be \fB\fCtls://\fR (DNS over TLS), \fB\fCgrpc://\fR
|
||||
(DNS over gRPC) or \fB\fChttps://\fR (DNS over HTTP/2).
|
||||
|
||||
.PP
|
||||
The optional \fBPORT\fP controls on which port the server will bind, this default to 53. If you use
|
||||
a port number here, you \fIcan't\fP override it with \fB\fC-dns.port\fR (coredns(1)).
|
||||
|
||||
.PP
|
||||
Specifying a \fBZONE\fP \fIand\fP \fBPORT\fP combination multiple times for \fIdifferent\fP servers will lead to
|
||||
an error on startup.
|
||||
|
||||
.PP
|
||||
When a query comes in, it is matched again all zones for all servers, the server with the longest
|
||||
match on the query name will receive the query.
|
||||
|
||||
.PP
|
||||
\fBPLUGIN\fP defines the plugin(s) we want to load into this server. This is optional as well, but as
|
||||
server with no plugins will just return SERVFAIL for all queries. Each plugin can have a number of
|
||||
properties than can have arguments, see the documentation for each plugin.
|
||||
|
||||
.PP
|
||||
Comments are allowed and begin with an unquoted hash \fB\fC#\fR and continue to the end of the line.
|
||||
Comments may be started anywhere on a line.
|
||||
|
||||
.PP
|
||||
Environment variables are supported and either the Unix or Windows form may be used: \fB\fC{$ENV_VAR_1}\fR
|
||||
or \fB\fC{%ENV_VAR_2%}\fR.
|
||||
|
||||
.PP
|
||||
You can use the \fB\fCimport\fR "plugin" to include parts of other files.
|
||||
|
||||
.PP
|
||||
If CoreDNS can’t find a Corefile to load it loads the following builtin one:
|
||||
|
||||
.PP
|
||||
.RS
|
||||
|
||||
.nf
|
||||
\&. {
|
||||
whoami
|
||||
}
|
||||
.
|
||||
.fi
|
||||
.
|
||||
.IP "" 0
|
||||
.
|
||||
.SH "IMPORT"
|
||||
You can use the \fBimport\fR "plugin" to include parts of other files, see \fIhttps://coredns\.io/plugins/import\fR\.
|
||||
.
|
||||
.SH "SNIPPETS"
|
||||
If you want to reuse a snippet you can define one with and then use it with \fIimport\fR\.
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
.nf
|
||||
|
||||
.fi
|
||||
.RE
|
||||
|
||||
.SH IMPORT
|
||||
.PP
|
||||
You can use the \fB\fCimport\fR "plugin" to include parts of other files, see https://coredns.io/plugins/import
|
||||
\[la]https://coredns.io/plugins/import\[ra].
|
||||
|
||||
.SH SNIPPETS
|
||||
.PP
|
||||
If you want to reuse a snippet you can define one with and then use it with \fIimport\fP.
|
||||
|
||||
.PP
|
||||
.RS
|
||||
|
||||
.nf
|
||||
(mysnippet) {
|
||||
log
|
||||
whoami
|
||||
}
|
||||
|
||||
\. {
|
||||
\&. {
|
||||
import mysnippet
|
||||
}
|
||||
.
|
||||
.fi
|
||||
.
|
||||
.IP "" 0
|
||||
.
|
||||
.SH "EXAMPLES"
|
||||
The \fBZONE\fR is root zone \fB\.\fR, the \fBPLUGIN\fR is chaos\. The chaos plugin takes an argument: \fBCoreDNS\-001\fR\. This text is returned on a CH class query: \fBdig CH txt version\.bind @localhost\fR\.
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
.nf
|
||||
|
||||
\&\. {
|
||||
.fi
|
||||
.RE
|
||||
|
||||
.SH EXAMPLES
|
||||
.PP
|
||||
The \fBZONE\fP is root zone \fB\fC.\fR, the \fBPLUGIN\fP is chaos. The chaos plugin takes an argument:
|
||||
\fB\fCCoreDNS-001\fR. This text is returned on a CH class query: \fB\fCdig CH txt version.bind @localhost\fR.
|
||||
|
||||
.PP
|
||||
.RS
|
||||
|
||||
.nf
|
||||
\&. {
|
||||
chaos CoreDNS\-001
|
||||
}
|
||||
.
|
||||
.fi
|
||||
.
|
||||
.IP "" 0
|
||||
.
|
||||
.P
|
||||
When defining a new zone, you either create a new server, or add it to an existing one\. Here we define one server that handles two zones; that potentially chain different plugins:
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
.nf
|
||||
|
||||
example\.org {
|
||||
.fi
|
||||
.RE
|
||||
|
||||
.PP
|
||||
When defining a new zone, you either create a new server, or add it to an existing one. Here we
|
||||
define one server that handles two zones; that potentially chain different plugins:
|
||||
|
||||
.PP
|
||||
.RS
|
||||
|
||||
.nf
|
||||
example.org {
|
||||
whoami
|
||||
}
|
||||
org {
|
||||
whoami
|
||||
}
|
||||
.
|
||||
|
||||
.fi
|
||||
.
|
||||
.IP "" 0
|
||||
.
|
||||
.P
|
||||
.RE
|
||||
|
||||
.PP
|
||||
Is identical to:
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
.nf
|
||||
|
||||
example\.org org {
|
||||
.PP
|
||||
.RS
|
||||
|
||||
.nf
|
||||
example.org org {
|
||||
whoami
|
||||
}
|
||||
.
|
||||
|
||||
.fi
|
||||
.
|
||||
.IP "" 0
|
||||
.
|
||||
.P
|
||||
.RE
|
||||
|
||||
.PP
|
||||
Reverse zones can be specified as domain names:
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
.nf
|
||||
|
||||
0\.0\.10\.in\-addr\.arpa {
|
||||
.PP
|
||||
.RS
|
||||
|
||||
.nf
|
||||
0.0.10.in\-addr.arpa {
|
||||
whoami
|
||||
}
|
||||
.
|
||||
|
||||
.fi
|
||||
.
|
||||
.IP "" 0
|
||||
.
|
||||
.P
|
||||
.RE
|
||||
|
||||
.PP
|
||||
or by just using the CIDR notation:
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
.nf
|
||||
|
||||
10\.0\.0\.0/24 {
|
||||
.PP
|
||||
.RS
|
||||
|
||||
.nf
|
||||
10.0.0.0/24 {
|
||||
whoami
|
||||
}
|
||||
.
|
||||
|
||||
.fi
|
||||
.
|
||||
.IP "" 0
|
||||
.
|
||||
.P
|
||||
.RE
|
||||
|
||||
.PP
|
||||
This also works on a non octet boundary:
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
.nf
|
||||
|
||||
10\.0\.0\.0/27 {
|
||||
.PP
|
||||
.RS
|
||||
|
||||
.nf
|
||||
10.0.0.0/27 {
|
||||
whoami
|
||||
}
|
||||
.
|
||||
|
||||
.fi
|
||||
.
|
||||
.IP "" 0
|
||||
.
|
||||
.SH "AUTHORS"
|
||||
CoreDNS Authors\.
|
||||
.
|
||||
.SH "COPYRIGHT"
|
||||
Apache License 2\.0
|
||||
.
|
||||
.SH "SEE ALSO"
|
||||
The manual page for CoreDNS: coredns(1) and more documentation on \fIhttps://coredns\.io\fR\. Also see the \fIimport\fR \fIhttps://coredns\.io/plugins/import\fR\'s documentation\.
|
||||
.RE
|
||||
|
||||
.SH AUTHORS
|
||||
.PP
|
||||
CoreDNS Authors.
|
||||
|
||||
.SH COPYRIGHT
|
||||
.PP
|
||||
Apache License 2.0
|
||||
|
||||
.SH SEE ALSO
|
||||
.PP
|
||||
The manual page for CoreDNS: coredns(1) and more documentation on https://coredns.io
|
||||
\[la]https://coredns.io\[ra].
|
||||
Also see the \fIimport\fP
|
||||
\[la]https://coredns.io/plugins/import\[ra]'s documentation.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user