2019-08-30 15:58:25 +01:00
|
|
|
.\" Generated by Mmark Markdown Processer - mmark.miek.nl
|
2026-03-27 05:35:09 +02:00
|
|
|
.TH "COREDNS-ROOT" 7 "March 2026" "CoreDNS" "CoreDNS Plugins"
|
2019-04-06 08:42:40 +01:00
|
|
|
|
2019-06-24 12:37:27 +01:00
|
|
|
.SH "NAME"
|
2019-04-06 08:42:40 +01:00
|
|
|
.PP
|
2026-03-27 05:35:09 +02:00
|
|
|
\fIroot\fP - simply specifies the root of where to find files.
|
2019-04-06 08:42:40 +01:00
|
|
|
|
2019-06-24 12:37:27 +01:00
|
|
|
.SH "DESCRIPTION"
|
2019-04-06 08:42:40 +01:00
|
|
|
.PP
|
|
|
|
|
The default root is the current working directory of CoreDNS. The \fIroot\fP plugin allows you to change
|
|
|
|
|
this. A relative root path is relative to the current working directory.
|
2026-03-27 05:35:09 +02:00
|
|
|
\fBNOTE: The \fIroot\fP directory is NOT currently supported by all plugins.\fP
|
|
|
|
|
Currently the following plugins respect the \fIroot\fP plugin configuration:
|
|
|
|
|
|
|
|
|
|
.IP \(bu 4
|
|
|
|
|
\fIfile\fP
|
|
|
|
|
.IP \(bu 4
|
|
|
|
|
\fItls\fP
|
|
|
|
|
.IP \(bu 4
|
|
|
|
|
\fIdnssec\fP
|
|
|
|
|
|
2019-04-06 08:42:40 +01:00
|
|
|
|
|
|
|
|
.PP
|
|
|
|
|
This plugin can only be used once per Server Block.
|
2018-01-04 12:53:07 +00:00
|
|
|
|
2019-06-24 12:37:27 +01:00
|
|
|
.SH "SYNTAX"
|
2019-04-06 08:42:40 +01:00
|
|
|
.PP
|
|
|
|
|
.RS
|
|
|
|
|
|
|
|
|
|
.nf
|
2018-01-04 12:53:07 +00:00
|
|
|
root PATH
|
2019-04-06 08:42:40 +01:00
|
|
|
|
2018-01-04 12:53:07 +00:00
|
|
|
.fi
|
2019-04-06 08:42:40 +01:00
|
|
|
.RE
|
|
|
|
|
|
|
|
|
|
.PP
|
|
|
|
|
\fBPATH\fP is the directory to set as CoreDNS' root.
|
|
|
|
|
|
2019-06-24 12:37:27 +01:00
|
|
|
.SH "EXAMPLES"
|
2019-04-06 08:42:40 +01:00
|
|
|
.PP
|
|
|
|
|
Serve zone data (when the \fIfile\fP plugin is used) from \fB\fC/etc/coredns/zones\fR:
|
2018-01-04 12:53:07 +00:00
|
|
|
|
2019-04-06 08:42:40 +01:00
|
|
|
.PP
|
|
|
|
|
.RS
|
|
|
|
|
|
|
|
|
|
.nf
|
|
|
|
|
\&. {
|
2018-01-04 12:53:07 +00:00
|
|
|
root /etc/coredns/zones
|
|
|
|
|
}
|
2019-04-06 08:42:40 +01:00
|
|
|
|
2018-01-04 12:53:07 +00:00
|
|
|
.fi
|
2019-04-06 08:42:40 +01:00
|
|
|
.RE
|
2018-01-04 12:53:07 +00:00
|
|
|
|
2026-03-27 05:35:09 +02:00
|
|
|
.PP
|
|
|
|
|
When you use the \fIroot\fP and \fItls\fP plugin together, your cert and key should also be placed in the \fIroot\fP directory.
|
|
|
|
|
The example below will look for \fB\fC/config/cert.pem\fR and \fB\fC/config/key.pem\fR
|
|
|
|
|
|
|
|
|
|
.PP
|
|
|
|
|
.RS
|
|
|
|
|
|
|
|
|
|
.nf
|
|
|
|
|
tls://example.com:853 {
|
|
|
|
|
root /config
|
|
|
|
|
tls cert.pem key.pem
|
|
|
|
|
whoami
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
.fi
|
|
|
|
|
.RE
|
|
|
|
|
|
|
|
|
|
.SH "BUGS"
|
|
|
|
|
.PP
|
|
|
|
|
\fBNOTE: The \fIroot\fP directory is NOT currently supported by all plugins.\fP
|
|
|
|
|
Currently the following plugins respect the \fIroot\fP plugin configuration:
|
|
|
|
|
|
|
|
|
|
.IP \(bu 4
|
|
|
|
|
\fIfile\fP
|
|
|
|
|
.IP \(bu 4
|
|
|
|
|
\fItls\fP
|
|
|
|
|
.IP \(bu 4
|
|
|
|
|
\fIdnssec\fP
|
|
|
|
|
|
|
|
|
|
|