coredns/man/corefile.5

.\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREFILE" 5 "April 2020" "CoreDNS" "CoreDNS"

.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
.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)), also see coredns-bind(7).

.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" (See coredns-import(7)) 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
    log
}

.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], and coredns-import(7).

.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
.RE

.SH "EXAMPLES"
.PP
The \fBZONE\fP is root zone \fB\fC.\fR, the \fBPLUGIN\fP is \fIchaos\fP. The \fIchaos\fP plugin takes an (optional) 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
.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
.RE

.PP
Is identical to:

.PP
.RS

.nf
example.org org {
    whoami
}

.fi
.RE

.PP
Reverse zones can be specified as domain names:

.PP
.RS

.nf
0.0.10.in\-addr.arpa {
    whoami
}

.fi
.RE

.PP
or by just using the CIDR notation:

.PP
.RS

.nf
10.0.0.0/24 {
    whoami
}

.fi
.RE

.PP
This also works on a non octet boundary:

.PP
.RS

.nf
10.0.0.0/27 {
    whoami
}

.fi
.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 and all the manual pages
for the plugins.