package
1.3.0
Repository: https://github.com/sendgrid/coredns.git
Documentation: pkg.go.dev

# README

file

Name

file - enables serving zone data from an RFC 1035-style master file.

Description

The file 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 using DNSSEC), correct DNSSEC answers are returned. Only NSEC is supported! If you use this setup you are responsible for re-signing the zonefile.

Syntax

file DBFILE [ZONES...]
  • DBFILE the database file to read and parse. If the path is relative, the path from the root directive will be prepended to it.
  • ZONES zones it should be authoritative for. If empty, the zones from the configuration block are used.

If you want to round-robin A and AAAA responses look at the loadbalance plugin.

file DBFILE [ZONES... ] {
    transfer to ADDRESS...
    reload DURATION
    no_reload
    upstream [ADDRESS...]
}
  • transfer enables zone transfers. It may be specified multiples times. To or from signals the direction. ADDRESS must be denoted in CIDR notation (e.g., 127.0.0.1/32) or just as plain addresses. The special wildcard * 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.
  • reload interval to perform a reload of the zone if the SOA version changes. Default is one minute. Value of 0 means to not scan for changes and reload. For example, 30s checks the zonefile every 30 seconds and reloads the zone when serial changes.
  • no_reload deprecated. Sets reload to 0.
  • upstream defines upstream resolvers to be used 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 or want to use this. ADDRESS can be an IP address, an IP:port or a string pointing to a file that is structured as /etc/resolv.conf. If no ADDRESS is given, CoreDNS will resolve CNAMEs against itself.

Examples

Load the example.org zone from example.org.signed and allow transfers to the internet, but send notifies to 10.240.1.1

example.org {
    file example.org.signed {
        transfer to *
        transfer to 10.240.1.1
    }
}

Or use a single zone file for multiple zones:

. {
    file example.org.signed example.org example.net {
        transfer to *
        transfer to 10.240.1.1
    }
}

# Packages

Package tree implements Left-Leaning Red Black trees as described by Robert Sedgewick.

# Functions

NewZone returns a new zone.
Parse parses the zone in filename and returns a new Zone or an error.

# Constants

Delegation indicates the lookup resulted in a delegation.
MaxSerialIncrement is the maximum difference between two serial numbers.
NameError indicates a nameerror.
NoData indicates the lookup resulted in a NODATA.
ServerFailure indicates a server failure during the lookup.
Success is a successful lookup.

# Variables

TickTime is clock resolution.

# Structs

Apex contains the apex records of a zone: SOA, NS and their potential signatures.
No description provided by the author
Xfr serves up an AXFR.
Zone defines a structure that contains all data related to a DNS zone.
No description provided by the author

# Type aliases

Result is the result of a Lookup.