coredns/man/coredns-secondary.7
Miek Gieben f8aa208cc0
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>
2019-04-06 08:42:40 +01:00

99 lines
2.1 KiB
Groff

.\" Generated by Mmark Markdown Processer - mmark.nl
.TH "COREDNS-SECONDARY" "7" "April 2019" "CoreDNS" "CoreDNS Plugins"
.SH SECONDARY
.SH NAME
.PP
\fIsecondary\fP - enables serving a zone retrieved from a primary server.
.SH DESCRIPTION
.PP
With \fIsecondary\fP you can transfer (via AXFR) a zone from another server. The retrieved zone is
\fInot committed\fP to disk (a violation of the RFC). This means restarting CoreDNS will cause it to
retrieve all secondary zones.
.PP
.RS
.nf
secondary [ZONES...]
.fi
.RE
.IP \(bu 4
\fBZONES\fP zones it should be authoritative for. If empty, the zones from the configuration block
are used. Note that without a remote address to \fIget\fP the zone from, the above is not that useful.
.PP
A working syntax would be:
.PP
.RS
.nf
secondary [zones...] {
transfer from ADDRESS
transfer to ADDRESS
upstream
}
.fi
.RE
.IP \(bu 4
\fB\fCtransfer from\fR specifies from which address to fetch the zone. It can be specified multiple times;
if one does not work, another will be tried.
.IP \(bu 4
\fB\fCtransfer to\fR can be enabled to allow this secondary zone to be transferred again.
.IP \(bu 4
\fB\fCupstream\fR resolve external names found (think CNAMEs) pointing to external names. This is only
really useful when CoreDNS is configured as a proxy; for normal authoritative serving you don't
need \fIor\fP want to use this. CoreDNS will resolve CNAMEs against itself.
.PP
When a zone is due to be refreshed (Refresh timer fires) a random jitter of 5 seconds is
applied, before fetching. In the case of retry this will be 2 seconds. If there are any errors
during the transfer the transfer fails; this will be logged.
.SH EXAMPLES
.PP
Transfer \fB\fCexample.org\fR from 10.0.1.1, and if that fails try 10.1.2.1.
.PP
.RS
.nf
example.org {
secondary {
transfer from 10.0.1.1
transfer from 10.1.2.1
}
}
.fi
.RE
.PP
Or re-export the retrieved zone to other secondaries.
.PP
.RS
.nf
\&. {
secondary example.net {
transfer from 10.1.2.1
transfer to *
}
}
.fi
.RE
.SH BUGS
.PP
Only AXFR is supported and the retrieved zone is not committed to disk.