mirror of
https://github.com/coredns/coredns.git
synced 2025-12-05 09:55:10 -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,11 +1,11 @@
|
||||
.\" Generated by Mmark Markdown Processer - mmark.nl
|
||||
.TH "COREDNS-FORWARD" "7" "April 2019" "CoreDNS" "CoreDNS Plugins"
|
||||
.TH "COREDNS-FORWARD" 7 "June 2019" "CoreDNS" "CoreDNS Plugins"
|
||||
|
||||
.SH NAME
|
||||
.SH "NAME"
|
||||
.PP
|
||||
\fIforward\fP - facilitates proxying DNS messages to upstream resolvers.
|
||||
|
||||
.SH DESCRIPTION
|
||||
.SH "DESCRIPTION"
|
||||
.PP
|
||||
The \fIforward\fP plugin re-uses already opened sockets to the upstreams. It supports UDP, TCP and
|
||||
DNS-over-TLS and uses in band health checking.
|
||||
@@ -25,7 +25,7 @@ connect to a random upstream (which may or may not work).
|
||||
.PP
|
||||
This plugin can only be used once per Server Block.
|
||||
|
||||
.SH SYNTAX
|
||||
.SH "SYNTAX"
|
||||
.PP
|
||||
In its most basic form, a simple forwarder uses this syntax:
|
||||
|
||||
@@ -140,7 +140,7 @@ dialTimeout by default is 30 sec, and can decrease automatically down to 100ms
|
||||
readTimeout by default is 2 sec, and can decrease automatically down to 200ms
|
||||
|
||||
|
||||
.SH METRICS
|
||||
.SH "METRICS"
|
||||
.PP
|
||||
If monitoring is enabled (via the \fIprometheus\fP directive) then the following metric are exported:
|
||||
|
||||
@@ -164,7 +164,7 @@ Where \fB\fCto\fR is one of the upstream servers (\fBTO\fP from the config), \fB
|
||||
the incoming query ("tcp" or "udp"), and family the transport family ("1" for IPv4, and "2" for
|
||||
IPv6).
|
||||
|
||||
.SH EXAMPLES
|
||||
.SH "EXAMPLES"
|
||||
.PP
|
||||
Proxy all requests within \fB\fCexample.org.\fR to a nameserver running on a different port:
|
||||
|
||||
@@ -264,12 +264,12 @@ Or with multiple upstreams from the same provider
|
||||
.fi
|
||||
.RE
|
||||
|
||||
.SH BUGS
|
||||
.SH "BUGS"
|
||||
.PP
|
||||
The TLS config is global for the whole forwarding proxy if you need a different \fB\fCtls_servername\fR for
|
||||
different upstreams you're out of luck.
|
||||
|
||||
.SH ALSO SEE
|
||||
.SH "ALSO SEE"
|
||||
.PP
|
||||
RFC 7858
|
||||
\[la]https://tools.ietf.org/html/rfc7858\[ra] for DNS over TLS.
|
||||
|
||||
Reference in New Issue
Block a user