mirror of
https://github.com/coredns/coredns.git
synced 2025-12-06 02:15:11 -05: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
@@ -1,97 +1,113 @@
|
||||
.\" generated with Ronn/v0.7.3
|
||||
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
||||
.
|
||||
.TH "COREDNS\-AUTO" "7" "March 2019" "CoreDNS" "CoreDNS plugins"
|
||||
.
|
||||
.SH "NAME"
|
||||
\fIauto\fR \- enables serving zone data from an RFC 1035\-style master file, which is automatically picked up from disk\.
|
||||
.
|
||||
.SH "DESCRIPTION"
|
||||
The \fIauto\fR plugin is used for an "old\-style" DNS server\. It serves from a preloaded file that exists on disk\. If the zone file contains signatures (i\.e\. is signed, i\.e\. using DNSSEC) correct DNSSEC answers are returned\. Only NSEC is supported! If you use this setup \fIyou\fR are responsible for re\-signing the zonefile\. New or changed zones are automatically picked up from disk\.
|
||||
.
|
||||
.SH "SYNTAX"
|
||||
.
|
||||
.nf
|
||||
.\" Generated by Mmark Markdown Processer - mmark.nl
|
||||
.TH "COREDNS-AUTO" "7" "April 2019" "CoreDNS" "CoreDNS Plugins"
|
||||
|
||||
auto [ZONES\.\.\.] {
|
||||
directory DIR [REGEXP ORIGIN_TEMPLATE [TIMEOUT]]
|
||||
.SH AUTO
|
||||
.SH NAME
|
||||
.PP
|
||||
\fIauto\fP - enables serving zone data from an RFC 1035-style master file, which is automatically picked up from disk.
|
||||
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
The \fIauto\fP plugin is used for an "old-style" DNS server. It serves from a preloaded file that exists
|
||||
on disk. If the zone file contains signatures (i.e. is signed, i.e. using DNSSEC) correct DNSSEC answers
|
||||
are returned. Only NSEC is supported! If you use this setup \fIyou\fP are responsible for re-signing the
|
||||
zonefile. New or changed zones are automatically picked up from disk.
|
||||
|
||||
.SH SYNTAX
|
||||
.PP
|
||||
.RS
|
||||
|
||||
.nf
|
||||
auto [ZONES...] {
|
||||
directory DIR [REGEXP ORIGIN\_TEMPLATE]
|
||||
transfer to ADDRESS...
|
||||
reload DURATION
|
||||
no_reload
|
||||
upstream
|
||||
}
|
||||
.
|
||||
.fi
|
||||
.
|
||||
.P
|
||||
\fBZONES\fR zones it should be authoritative for\. If empty, the zones from the configuration block are used\.
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fBdirectory\fR loads zones from the specified \fBDIR\fR\. If a file name matches \fBREGEXP\fR it will be used to extract the origin\. \fBORIGIN_TEMPLATE\fR will be used as a template for the origin\. Strings like \fB{<number>}\fR are replaced with the respective matches in the file name, e\.g\. \fB{1}\fR is the first match, \fB{2}\fR is the second\. The default is: \fBdb\e\.(\.*) {1}\fR i\.e\. from a file with the name \fBdb\.example\.com\fR, the extracted origin will be \fBexample\.com\fR\. \fBTIMEOUT\fR is deprecated and will be removed in a subsequent version\. \fBreload\fR will be used, if not defined (it specifies how often CoreDNS should scan the directory to watch for file removal and addition; the default is every 60 seconds\. This value is in seconds\. The minimum value is 1 second\.)
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fBreload\fR interval to perform reloads of zones if SOA version changes and zonefiles\. Default is one minute\. Value of \fB0\fR means to not scan for changes and reload\. eg\. \fB30s\fR checks zonefile every 30 seconds and reloads zone when serial changes\.
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fBno_reload\fR deprecated\. Sets reload to 0\.
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fBupstream\fR defines upstream resolvers to be used resolve external names found (think CNAMEs) pointing to external names\. CoreDNS will resolve CNAMEs against itself\.
|
||||
.
|
||||
.IP "" 0
|
||||
.
|
||||
.P
|
||||
All directives from the \fIfile\fR plugin are supported\. Note that \fIauto\fR will load all zones found, even though the directive might only receive queries for a specific zone\. I\.e:
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
.nf
|
||||
|
||||
\&\. {
|
||||
auto example\.org {
|
||||
.fi
|
||||
.RE
|
||||
|
||||
.PP
|
||||
\fBZONES\fP zones it should be authoritative for. If empty, the zones from the configuration block
|
||||
are used.
|
||||
|
||||
.IP \(bu 4
|
||||
\fB\fCdirectory\fR loads zones from the specified \fBDIR\fP. If a file name matches \fBREGEXP\fP it will be
|
||||
used to extract the origin. \fBORIGIN_TEMPLATE\fP will be used as a template for the origin. Strings
|
||||
like \fB\fC{<number>}\fR are replaced with the respective matches in the file name, e.g. \fB\fC{1}\fR is the
|
||||
first match, \fB\fC{2}\fR is the second. The default is: \fB\fCdb\.(.*) {1}\fR i.e. from a file with the
|
||||
name \fB\fCdb.example.com\fR, the extracted origin will be \fB\fCexample.com\fR.
|
||||
.IP \(bu 4
|
||||
\fB\fCtransfer\fR enables zone transfers. It may be specified multiples times. \fB\fCTo\fR or \fB\fCfrom\fR signals
|
||||
the direction. \fBADDRESS\fP must be denoted in CIDR notation (e.g., 127.0.0.1/32) or just as plain
|
||||
addresses. The special wildcard \fB\fC*\fR means: the entire internet (only valid for 'transfer to').
|
||||
When an address is specified a notify message will be send whenever the zone is reloaded.
|
||||
.IP \(bu 4
|
||||
\fB\fCreload\fR interval to perform reloads of zones if SOA version changes and zonefiles. It specifies how often CoreDNS should scan the directory to watch for file removal and addition. Default is one minute.
|
||||
Value of \fB\fC0\fR means to not scan for changes and reload. eg. \fB\fC30s\fR checks zonefile every 30 seconds
|
||||
and reloads zone when serial changes.
|
||||
.IP \(bu 4
|
||||
\fB\fCupstream\fR defines upstream resolvers to be used resolve external names found (think CNAMEs)
|
||||
pointing to external names. CoreDNS will resolve CNAMEs against itself.
|
||||
|
||||
|
||||
.PP
|
||||
All directives from the \fIfile\fP plugin are supported. Note that \fIauto\fP will load all zones found,
|
||||
even though the directive might only receive queries for a specific zone. I.e:
|
||||
|
||||
.PP
|
||||
.RS
|
||||
|
||||
.nf
|
||||
\&. {
|
||||
auto example.org {
|
||||
directory /etc/coredns/zones
|
||||
}
|
||||
}
|
||||
.
|
||||
.fi
|
||||
.
|
||||
.IP "" 0
|
||||
.
|
||||
.P
|
||||
Will happily pick up a zone for \fBexample\.COM\fR, except it will never be queried, because the \fIauto\fR directive only is authoritative for \fBexample\.ORG\fR\.
|
||||
.
|
||||
.SH "EXAMPLES"
|
||||
Load \fBorg\fR domains from \fB/etc/coredns/zones/org\fR and allow transfers to the internet, but send notifies to 10\.240\.1\.1
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
.nf
|
||||
|
||||
\&\. {
|
||||
.fi
|
||||
.RE
|
||||
|
||||
.PP
|
||||
Will happily pick up a zone for \fB\fCexample.COM\fR, except it will never be queried, because the \fIauto\fP
|
||||
directive only is authoritative for \fB\fCexample.ORG\fR.
|
||||
|
||||
.SH EXAMPLES
|
||||
.PP
|
||||
Load \fB\fCorg\fR domains from \fB\fC/etc/coredns/zones/org\fR and allow transfers to the internet, but send
|
||||
notifies to 10.240.1.1
|
||||
|
||||
.PP
|
||||
.RS
|
||||
|
||||
.nf
|
||||
\&. {
|
||||
auto org {
|
||||
directory /etc/coredns/zones/org
|
||||
transfer to *
|
||||
transfer to 10\.240\.1\.1
|
||||
transfer to 10.240.1.1
|
||||
}
|
||||
}
|
||||
.
|
||||
.fi
|
||||
.
|
||||
.IP "" 0
|
||||
.
|
||||
.P
|
||||
Load \fBorg\fR domains from \fB/etc/coredns/zones/org\fR and looks for file names as \fBwww\.db\.example\.org\fR, where \fBexample\.org\fR is the origin\. Scan every 45 seconds\.
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
.nf
|
||||
|
||||
.fi
|
||||
.RE
|
||||
|
||||
.PP
|
||||
Load \fB\fCorg\fR domains from \fB\fC/etc/coredns/zones/org\fR and looks for file names as \fB\fCwww.db.example.org\fR,
|
||||
where \fB\fCexample.org\fR is the origin. Scan every 45 seconds.
|
||||
|
||||
.PP
|
||||
.RS
|
||||
|
||||
.nf
|
||||
org {
|
||||
auto {
|
||||
directory /etc/coredns/zones/org www\e\.db\e\.(\.*) {1} 45
|
||||
directory /etc/coredns/zones/org www\\.db\\.(.*) {1}
|
||||
reload 45s
|
||||
}
|
||||
}
|
||||
.
|
||||
.fi
|
||||
.
|
||||
.IP "" 0
|
||||
|
||||
.fi
|
||||
.RE
|
||||
|
||||
|
||||
Reference in New Issue
Block a user