Each setting can appear on the command line, prefixed by -- and using the old style name, or in configuration files.
Settings on the command line are processed after the file-based settings are processed.
Note
Starting with version 5.0.0, Recursor supports a new YAML syntax for configuration files
as described here.
If both recursor.conf and recursor.yml files are found in the configuration directory the YAML file is used.
A configuration using the old style syntax can be converted to a YAML configuration using the instructions in Conversion of old-style settings to YAML format.
Release 5.0.0 will install a default old-style recursor.conf file.
Starting with version 5.1.0, in the absence of a recursor.yml file, an existing recursor.conf will be processed as YAML,
if that fails, it will be processed as old-style configuration.
Packages will stop installing a old-style recursor.conf file and start installing a default recursor.conf file containing YAML syntax.
With the release of 5.2.0, the default will be to expect a YAML configuration file and reading of old-style recursor.conf files will have to be enabled specifically by providing a command line option --enable-old-settings.
In a future release support for the “old-style” recursor.conf settings file will be dropped.
Note
Starting with version 5.1.0, the settings originally specified in a Lua config file can also be put in YAML form.
The conversion printed by rec_control show-yaml will print these settings if a Lua config file is specified in the config file being converted.
You have to choose however: either set Lua settings the old way in the Lua config file, or convert all to YAML.
If you are using YAML settings of items originally specified in the Lua config file, do not set recursor.lua_config_file anymore. The Recursor will check that you do not mix both configuration methods.
Please refer to e.g. https://docs.ansible.com/ansible/latest/reference_appendices/YAMLSyntax.html for a description of YAML syntax.
A Recursor configuration file has several sections. For example, incoming for
settings related to receiving queries and dnssec for settings related to DNSSEC processing.
An example Recursor YAML configuration file looks like:
dnssec:
log_bogus: true
incoming:
listen:
- 0.0.0.0:5301
- '[::]:5301'
recursor:
extended_resolution_errors: true
forward_zones:
- zone: example.com
forwarders:
- 127.0.0.1:5301
outgoing:
source_address:
- 0.0.0.0
- '::'
logging:
loglevel: 6
Take care when listing IPv6 addresses, as characters used for these are special to YAML.
If in doubt, quote any string containing :, !, [ or ] and use (online) tools to check your YAML syntax.
Specify an empty sequence using [].
The main setting file is called recursor.yml and will be processed first.
This settings file might refer to other files via the recursor.include_dir setting.
The next section will describe how settings specified in multiple files are merged.
If recursor.include_dir is set, all .yml files in it will be processed in alphabetical order, modifying the settings processed so far.
For simple values like an boolean or number setting, a value in the processed file will overwrite an existing setting.
For values of type sequence, the new value will replace the existing value if the existing value is equal to the default or if the new value is marked with the !override tag.
Otherwise, the existing value will be extended with the new value by appending the new sequence to the existing.
For example, with the above example recursor.yml and an include directory containing a file extra.yml:
dnssec:
log_bogus: false
recursor:
forward_zones:
- zone: example.net
forwarders:
- '::1'
outgoing:
source_address: !override
- 0.0.0.0
dont_query: []
After merging, dnssec.log_bogus will be false, the sequence of recursor.forward_zones will contain 2 zones and the outgoing addresses used will contain one entry, as the extra.yml entry has overwritten the existing one.
outgoing.dont-query has a non-empty sequence as default value. The main recursor.yml did not set it, so before processing extra.yml it had the default value.
After processing extra.yml the value will be set to the empty sequence, as existing default values are overwritten by new values.
Warning
The merging process does not process values deeper than the second level.
For example if the main recursor.yml specified a forward zone
forward_zones:
- zone: example.net
forwarders:
- '::1'
and another settings file contains
forward_zones:
- zone: example.net
forwarders:
- '::2'
The result will not be a a single forward with two IP addresses, but two entries for example.net.
It depends on the specific setting how the sequence is processed and interpreted further.
A socket address is a string containing either an IP address or and IP address:port combination For example:
some_key: 127.0.0.1
another_key: '[::1]:8080'
A subnet is a single IP address or an IP address followed by a slash and a prefix length.
If no prefix length is specified, /32 or /128 is assumed, indicating a single IP address.
Subnets can also be prefixed with a !, specifying negation.
This can be used to deny addresses from a previously allowed range.
For example, allow-from takes a sequence of subnets:
allow_from:
- '2001:DB8::/32'
- 128.66.0.0/16
- '!128.66.1.2'
In this case the address 128.66.1.2 is excluded from the addresses allowed access.
A forward zone is defined as:
zone: string
forwarders:
- Socket Address
- ...
recurse: Boolean, default false
allow_notify: Boolean, default false
An example of a forward_zones entry, which consists of a sequence of Forward Zone entries:
- zone: example1.com
forwarders:
- 127.0.0.1
- 127.0.0.1:5353
- '[::1]:53'
- zone: example2.com
forwarders:
- '::1'
recurse: true
notify_allowed: true
Starting with version 5.1.0, names can be used if
recursor.system_resolver_ttl is set.
The names will be resolved using the system resolver and an automatic refresh of the forwarding zones will happen if a name starts resolving to a new address.
The refresh is done by performing the equivalent of rec_control reload-zones.
The YAML settings below were introduced in version 5.1.0 and correspond to their respective Lua settings. Refer to Advanced Configuration Using Lua.
As of version 5.1.0, a trust anchor is defined as
name: string
dsrecords: sequence of DS record strings in presentation format
An example of a trustanchors entry, which is a sequence of TrustAnchor:
trustanchors:
- name: example.com
dsrecords:
- 10000 8 2 a06d44b80b8f1d39a95c0b0d7c65d08458e880409bbc683457104237c7f8ec8d
As of version 5.1.0, a negative trust anchor is defined as
name: string
reason: string
An example of a negative_trustanchors entry, which is a sequence of NegativeTrustAnchor:
negative_trustanchors:
- name: example.com
reason: an example
As of version 5.1.0, a protobuf server is defined as
servers: [] Sequence of strings representing SocketAddress
timeout: 2
maxQueuedEntries: 100
reconnectWaitTime: 1
taggedOnly: false
asyncConnect: false
logQueries: true
logResponses: true
exportTypes: [A, AAAA, CNAME] Sequence of QType names
logMappedFrom: false
An example of a protobuf_servers entry, which is a sequence of ProtobufServer:
protobuf_servers:
- servers: [127.0.0.1:4578]
exportTypes: [A, AAAA]
- servers: ['[2001:DB8::1]':7891]
logQueries: false
logResponses: true
exportTypes: [A]
As of version 5.1.0, a dnstap framestream server is defined as
servers: [] Sequence of strings representing SocketAddress or a socket path
logQueries: true
logResponses: true
bufferHint: 0
flushTimeout: 0
inputQueueSize: 0
outputQueueSize: 0
queueNotifyThreshold: 0
reopenInterval: 0
An example of a dnstap_framestream_servers entry, which is a sequence of DNSTapFrameStreamServers:
dnstap_framestream_servers:
- servers: [127.0.0.1:2024]
logQueries: false
logResponses: true
As of version 5.1.0, an NOD dnstap framestream server is defined as
servers: [] Sequence of strings representing SocketAddress or a socket path
logNODs: true
logUDRs: false
bufferHint: 0
flushTimeout: 0
inputQueueSize: 0
outputQueueSize: 0
queueNotifyThreshold: 0
reopenInterval: 0
An example of a dnstap_nod_framestream_servers entry, which is a sequence of DNSTapNODFrameStreamServers:
dnstap_nop_framestream_servers:
- servers: [127.0.0.1:2024]
logNODs: false
logUDRs: true
As of version 5.1.0, a sortlist entry is defined as
- key: Subnet
subnets:
- subnet: Subnet
order: number
An example of a sortlists entry, which is a sequence of SortList:
sortlists:
- key: 198.18.0.0/8
subnets:
- subnet: 233.252.0.0/24
order: 10
- key: 198.18.1.0/8
subnets:
- subnet: 198.18.0.0/16
order: 20
- subnet: 203.0.113.0/24
order: 20
As of version 5.1.0, an RPZ entry is defined as
name: name or pathname
addresses: [] Sequence of SocketAddress
defcontent: string
defpol: Custom, Drop, NXDOMAIN, NODATA Truncate or NoAction
defpolOverrideLocalData: true
defttl: number
extendedErrorCode: number
extendedErrorExtra: string
includeSOA: false
ignoreDuplicates: false
maxTTL: number
policyName: string
tags: Sequence of string
overridesGettag: true
zoneSizeHint: number
tsig:
name: string
algo: string
secret: base64string
refresh: number
maxReceivedMBytes: number
localAddress: IP address
axfrTimeout: number
dumpFile: string
seedFile: string
If addresses is empty, the name field specifies the path name of the RPZ, otherwise the name field defines the name of the RPZ.
Starting with version 5.2.0, names instead of IP addresess can be used for addresses if
recursor.system_resolver_ttl is set.
An example of an rpzs entry, which is a sequence of RPZ:
rpzs:
- name: 'path/to/a/file'
- name: 'remote.rpz'
addresses: ['192.168.178.99']
policyName: mypolicy
As of version 5.1.0, a ZoneToCache entry is defined as
zone: zonename
method: One of axfr, url, file
sources: [] Sequence of string, representing IP address, URL or path
timeout: 20
tsig:
name: name of key
algo: algorithm
secret: Base64 encoded secret
refreshPeriod: 86400
retryOnErrorPeriod: 60
maxReceivedMBytes: 0 Zero mean no restrcition
localAddress: local IP address to bind to.
zonemd: One of ignore, validate, require
dnssec: One of ignore, validate, require
An example of an zonetocaches entry, which is a sequence of ZoneToCache:
zonetocaches:
- zone: .
method: url
sources: ['https://www.example.com/path']
- zone: example.com
method: file
sources: ['dir/example.com.zone']
As of version 5.1.0, an allowed additional qtype entry is defined as:
qtype: string representing a QType
targets: [] Sequence of string representing QType
mode: One of Ignore, CacheOnly, CacheOnlyRequireAuth, ResolveImmediately, ResolveDeferred, default CacheOnlyRequireAuth
An example of an allowed_additional_qtypes entry, which is a sequence of AllowedAdditionalQType:
allowed_additional_qtypes:
- qtype: MX
targets: [A, AAAA]
- qtype: NAPTR
targets: [A, AAAA, SRV]
mode: ResolveDeferred
As of version 5.1.0, a proxy mapping entry is defined as:
subnet: Subnet
address: IPAddress
domains: [] Sequence of string
An example of an proxymappings entry, which is a sequence of ProxyMapping:
proxymappings:
- subnet: 192.168.178.0/24
address: 128.66.1.2
- subnet: 192.168.179.0/24
address: 128.66.1.3
domains:
- example.com
- example.net
As of version 5.2.0, a forwarding catalog zone entry is defined as:
zone: Name of catalog zone
notify_allowed: bool, default false
xfr:
addresses: [] Sequence of SocketAddress
zoneSizeHint: number, default not set
tsig:
name: string
algo: string
secret: base64string
refresh: number, default not set
maxReceivedMBytes: number, default not set
localAddress: IP address, default not set
axfrTimeout: number, default 20
groups:
- name: optional group name
forwarders: [] Sequence of SocketAddress
recurse: bool, default false
notify: bool, default false
Names instead of IP addresess can be used for addresses if recursor.system_resolver_ttl is set.
An example of a recursor.forwarding_catalog_zones entry, which is a sequence of ForwardingCatalogZone:
forwarding_catalog_zones:
- zone: 'forward.example'
xfr:
addresses: [128.66.1.2]
groups:
- forwarders: [192.168.178.1] # default forwarder
- name: mygroup
forwarders: [192.168.179.2] # forwarder for catalog zone members in mygroup
recurse: true
notify_allowed: true
- zone: 'forward2.example'
xfr:
addresses: [128.66.1.3]
groups:
- forwarders: [192.168.178.3] # only default forwarder for 2nd catalog zone
Recursor will transfer the catalog zone from the authoritative server using IXFR (falling back to AXFR if needed) and add forwarding clauses for all members of the catalog zone. The forwarding parameters will be taken from the default group entry (the one without a name) defined in the YAML settings. For catalog zone members in a group, the forwarding parameters will be taken from the group entry with the corresponding name.
The forwarding definitions will be written into a file $api_dir/catzone.$zonename. webservice.api_dir must be defined, the directory must exist and be writable by the Recursor process.
The notation section.name means that an entry name can appear in the YAML section section.
So the entry recordcache.max_ttl will end up in settings file as follows:
recordcache:
...
max_ttl: 3600
...
carbon.instance¶New in version 4.2.0.
recursorChange the instance or third string of the metric key. The default is recursor.
carbon.interval¶30If sending carbon updates, this is the interval between them in seconds. See Metrics and Statistics.
carbon.ns¶New in version 4.2.0.
pdnsChange the namespace or first string of the metric key. The default is pdns.
carbon.ourname¶If sending carbon updates, if set, this will override our hostname. Be careful not to include any dots in this setting, unless you know what you are doing. See Sending metrics to Graphite/Metronome over Carbon.
carbon.server¶[]Will send all available metrics to these servers via the carbon protocol, which is used by graphite and metronome. See Metrics and Statistics.
dnssec.aggressive_cache_max_nsec3_hash_cost¶New in version 5.0.2.
New in version 4.9.3.
New in version 4.8.6.
150Maximum estimated NSEC3 cost for a given query to consider aggressive use of the NSEC3 cache. The cost is estimated based on a heuristic taking the zone’s NSEC3 salt and iterations parameters into account, as well at the number of labels of the requested name. For example a query for a name like a.b.c.d.e.f.example.com. in an example.com zone. secured with NSEC3 and 10 iterations (NSEC3 iterations count of 9) and an empty salt will have an estimated worst-case cost of 10 (iterations) * 6 (number of labels) = 60. The aggressive NSEC cache is an optimization to reduce the number of queries to authoritative servers, which is especially useful when a zone is under pseudo-random subdomain attack, and we want to skip it the zone parameters make it expensive.
dnssec.aggressive_cache_min_nsec3_hit_ratio¶New in version 4.9.0.
2000The limit for which to put NSEC3 records into the aggressive cache.
A value of n means that an NSEC3 record is only put into the aggressive cache if the estimated probability of a random name hitting the NSEC3 record is higher than 1/n.
A higher n will cause more records to be put into the aggressive cache, e.g. a value of 4000 will cause records to be put in the aggressive cache even if the estimated probability of hitting them is twice as low as would be the case for n=2000.
A value of 0 means no NSEC3 records will be put into the aggressive cache.
For large zones the effectiveness of the NSEC3 cache is reduced since each NSEC3 record only covers a randomly distributed subset of all possible names. This setting avoids doing unnecessary work for such large zones.
dnssec.aggressive_nsec_cache_size¶New in version 4.5.0.
100000The number of records to cache in the aggressive cache. If set to a value greater than 0, the recursor will cache NSEC and NSEC3 records to generate negative answers, as defined in RFC 8198.
To use this, DNSSEC processing or validation must be enabled by setting dnssec.validation to process, log-fail or validate.
dnssec.disabled_algorithms¶New in version 4.9.0.
[]A list of DNSSEC algorithm numbers that should be considered disabled.
These algorithms will not be used to validate DNSSEC signatures.
Zones (only) signed with these algorithms will be considered Insecure.
If this setting is empty (the default), Recursor will determine which algorithms to disable automatically.
This is done for specific algorithms only, currently algorithms 5 (RSASHA1) and 7 (RSASHA1NSEC3SHA1).
This is important on systems that have a default strict crypto policy, like RHEL9 derived systems.
On such systems not disabling some algorithms (or changing the security policy) will make affected zones to be considered Bogus as using these algorithms fails.
dnssec.log_bogus¶falseLog every DNSSEC validation failure. Note: This is not logged per-query but every time records are validated as Bogus.
dnssec.max_dnskeys¶New in version 5.0.2.
New in version 4.9.3.
New in version 4.8.6.
2Maximum number of DNSKEYs with the same algorithm and tag to consider when validating a given record. Setting this value to 1 effectively denies DNSKEY tag collisions in a zone.
dnssec.max_ds_per_zone¶New in version 5.0.2.
New in version 4.9.3.
New in version 4.8.6.
8Maximum number of DS records to consider when validating records inside a zone.
dnssec.max_nsec3_hash_computations_per_query¶New in version 5.0.2.
New in version 4.9.3.
New in version 4.8.6.
600Maximum number of NSEC3 hashes that we are willing to compute during DNSSEC validation, per incoming query.
dnssec.max_nsec3s_per_record¶New in version 5.0.2.
New in version 4.9.3.
New in version 4.8.6.
10Maximum number of NSEC3s to consider when validating a given denial of existence.
dnssec.max_rrsigs_per_record¶New in version 5.0.2.
New in version 4.9.3.
New in version 4.8.6.
2Maximum number of RRSIGs we are willing to cryptographically check when validating a given record. Expired or not yet incepted RRSIGs do not count toward to this limit.
dnssec.max_signature_validations_per_query¶New in version 5.0.2.
New in version 4.9.3.
New in version 4.8.6.
30Maximum number of RRSIG signatures we are willing to validate per incoming query.
dnssec.negative_trustanchors¶New in version 5.1.0.
[]Sequence of negative trust anchors.
dnssec.nsec3_max_iterations¶New in version 4.1.0.
Changed in version 4.5.2: Default is now 150, was 2500 before.
Changed in version 5.0.0: Default is now 50, was 150 before.
50Maximum number of iterations allowed for an NSEC3 record.
If an answer containing an NSEC3 record with more iterations is received, its DNSSEC validation status is treated as Insecure.
dnssec.signature_inception_skew¶New in version 4.1.5.
Changed in version 4.2.0: Default is now 60, was 0 before.
60Allow the signature inception to be off by this number of seconds. Negative values are not allowed.
dnssec.trustanchorfile¶New in version 5.1.0.
A path to a zone file to read trust anchors from.
This can be used to read distribution provided trust anchors, as for instance /usr/share/dns/root.key from Debian’s dns-root-data package.
dnssec.trustanchorfile_interval¶New in version 5.1.0.
24Interval (in hours) to re-read the trustanchorfile. Zero disables periodic re-reads.
dnssec.trustanchors¶New in version 5.1.0.
- name: .
dsrecords:
- 20326 8 2 e06d44b80b8f1d39a95c0b0d7c65d08458e880409bbc683457104237c7f8ec8d
- 38696 8 2 683d2d0acb8c9b712a1948b27f741219298d0a450d612c483af444a4c0fb2b16
Sequence of trust anchors. If the sequence contains an entry for the root zone, the default root zone trust anchor is not included.
If a zone appears multiple times, the entries in dsrecords are merged.
dnssec.validation¶New in version 4.0.0.
Changed in version 4.5.0: The default changed from process-no-validate to process
processOne of off, process-no-validate, process, log-fail, validate
Set the mode for DNSSEC processing, as detailed in DNSSEC in the PowerDNS Recursor.
offprocess-no-validateprocesslog-failprocess, but validate RRSIGs on responses and log bogus responses.validatednssec.x_dnssec_names¶New in version 4.5.0.
[]List of names whose DNSSEC validation metrics will be counted in a separate set of metrics that start
with x-dnssec-result-.
The names are suffix-matched.
This can be used to not count known failing (test) name validations in the ordinary DNSSEC metrics.
ecs.add_for¶New in version 4.2.0.
[0.0.0.0/0, '::/0', '!127.0.0.0/8', '!10.0.0.0/8', '!100.64.0.0/10', '!169.254.0.0/16', '!192.168.0.0/16', '!172.16.0.0/12', '!::1/128', '!fc00::/7', '!fe80::/10']List of requestor netmasks for which the requestor IP Address should be used as the EDNS Client Subnet for outgoing queries. Outgoing queries for requestors that do not match this list will use the ecs.scope_zero_address instead. Valid incoming ECS values from incoming.use_incoming_edns_subnet are not replaced.
Regardless of the value of this setting, ECS values are only sent for outgoing queries matching the conditions in the outgoing.edns_subnet_allow_list setting. This setting only controls the actual value being sent.
This defaults to not using the requestor address inside RFC1918 and similar ‘private’ IP address spaces.
ecs.cache_limit_ttl¶New in version 4.1.12.
0The minimum TTL for an ECS-specific answer to be inserted into the record cache. This condition applies in conjunction with ecs-ipv4-cache-bits or ecs-ipv6-cache-bits.
That is, only if both the limits apply, the record will not be cached. This decision can be overridden by ecs-ipv4-never-cache and ecs-ipv6-never-cache.
ecs.ipv4_bits¶New in version 4.1.0.
24Number of bits of client IPv4 address to pass when sending EDNS Client Subnet address information.
ecs.ipv4_cache_bits¶New in version 4.1.12.
24Maximum number of bits of client IPv4 address used by the authoritative server (as indicated by the EDNS Client Subnet scope in the answer) for an answer to be inserted into the record cache. This condition applies in conjunction with ecs-cache-limit-ttl.
That is, only if both the limits apply, the record will not be cached. This decision can be overridden by ecs-ipv4-never-cache and ecs-ipv6-never-cache.
ecs.ipv4_never_cache¶New in version 4.5.0.
falseWhen set, never cache replies carrying EDNS IPv4 Client Subnet scope in the record cache.
In this case the decision made by `ecs-ipv4-cache-bits and ecs-cache-limit-ttl is no longer relevant.
ecs.ipv6_bits¶New in version 4.1.0.
56Number of bits of client IPv6 address to pass when sending EDNS Client Subnet address information.
ecs.ipv6_cache_bits¶New in version 4.1.12.
56Maximum number of bits of client IPv6 address used by the authoritative server (as indicated by the EDNS Client Subnet scope in the answer) for an answer to be inserted into the record cache. This condition applies in conjunction with ecs-cache-limit-ttl.
That is, only if both the limits apply, the record will not be cached. This decision can be overridden by ecs-ipv4-never-cache and ecs-ipv6-never-cache.
ecs.ipv6_never_cache¶New in version 4.5.0.
falseWhen set, never cache replies carrying EDNS IPv6 Client Subnet scope in the record cache.
In this case the decision made by `ecs-ipv6-cache-bits and ecs-cache-limit-ttl is no longer relevant.
ecs.minimum_ttl_override¶Changed in version 4.5.0: Old versions used default 0.
1This setting artificially raises the TTLs of records in the ANSWER section of ECS-specific answers to be at least this long.
Setting this to a value greater than 1 technically is an RFC violation, but might improve performance a lot.
Using a value of 0 impacts performance of TTL 0 records greatly, since it forces the recursor to contact
authoritative servers every time a client requests them.
Can be set at runtime using rec_control set-ecs-minimum-ttl 3600.
ecs.scope_zero_address¶New in version 4.1.0.
The IP address sent via EDNS Client Subnet to authoritative servers listed in
outgoing.edns_subnet_allow_list when incoming.use_incoming_edns_subnet is set and the query has
an ECS source prefix-length set to 0.
The default is to look for the first usable (not an any one) address in
outgoing.source_address (starting with IPv4). If no suitable address is
found, the recursor fallbacks to sending 127.0.0.1.
incoming.allow_from¶[127.0.0.0/8, 10.0.0.0/8, 100.64.0.0/10, 169.254.0.0/16, 192.168.0.0/16, 172.16.0.0/12, '::1/128', 'fc00::/7', 'fe80::/10']Netmasks (both IPv4 and IPv6) that are allowed to use the server. The default allows access only from RFC 1918 private IP addresses. An empty value means no checking is done, all clients are allowed. Due to the aggressive nature of the internet these days, it is highly recommended to not open up the recursor for the entire internet. Questions from IP addresses not listed here are ignored and do not get an answer.
When the Proxy Protocol is enabled (see incoming.proxy_protocol_from), the recursor will check the address of the client IP advertised in the Proxy Protocol header instead of the one of the proxy.
Note that specifying an IP address without a netmask uses an implicit netmask of /32 or /128.
incoming.allow_from_file¶Like incoming.allow_from, except reading a sequence of Subnet from file. Overrides the incoming.allow_from setting. Example content of th specified file:
- 127.0.01
- ::1
incoming.allow_no_rd¶New in version 5.0.0.
falseAllow no recursion desired (RD=0) queries to query cache contents.
If not set (the default), these queries are answered with rcode Refused.
incoming.allow_notify_for¶New in version 4.6.0.
[]Domain names specified in this list are used to permit incoming NOTIFY operations to wipe any cache entries that match the domain name. If this list is empty, all NOTIFY operations will be ignored.
incoming.allow_notify_for_file¶New in version 4.6.0.
Like incoming.allow_notify_for, except reading a sequence of names from file. Example contents of specified file:
- example.com
- example.org
incoming.allow_notify_from¶New in version 4.6.0.
[]Subnets (both IPv4 and IPv6) that are allowed to issue NOTIFY operations to the server. NOTIFY operations from IP addresses not listed here are ignored and do not get an answer.
When the Proxy Protocol is enabled (see incoming.proxy_protocol_from), the recursor will check the address of the client IP advertised in the Proxy Protocol header instead of the one of the proxy.
Note that specifying an IP address without a netmask uses an implicit netmask of /32 or /128.
NOTIFY operations received from a client listed in one of these netmasks
will be accepted and used to initiate a freshness check for an RPZ zone or wipe any cache entries whose zones match
the zone specified in the NOTIFY operation, but only if that zone (or
one of its parents) is included in incoming.allow_notify_for,
incoming.allow_notify_for_file, or recursor.forward_zones_file with a allow_notify set to true.
incoming.allow_notify_from_file¶New in version 4.6.0.
Like incoming.allow_notify_from, except reading a sequence of Subnet from file.
incoming.distribution_load_factor¶New in version 4.1.12.
0.0If incoming.pdns_distributes_queries is set and this setting is set to another value than 0, the distributor thread will use a bounded load-balancing algorithm while distributing queries to worker threads, making sure that no thread is assigned more queries than distribution-load-factor times the average number of queries currently processed by all the workers. For example, with a value of 1.25, no server should get more than 125 % of the average load. This helps making sure that all the workers have roughly the same share of queries, even if the incoming traffic is very skewed, with a larger number of requests asking for the same qname.
incoming.distribution_pipe_buffer_size¶New in version 4.2.0.
0Size in bytes of the internal buffer of the pipe used by the distributor to pass incoming queries to a worker thread. Requires support for F_SETPIPE_SZ which is present in Linux since 2.6.35. The actual size might be rounded up to a multiple of a page size. 0 means that the OS default size is used. A large buffer might allow the recursor to deal with very short-lived load spikes during which a worker thread gets overloaded, but it will be at the cost of an increased latency.
incoming.distributor_threads¶New in version 4.2.0.
If incoming.pdns_distributes_queries is set, spawn this number of distributor threads on startup. Distributor threads handle incoming queries and distribute them to other threads based on a hash of the query.
incoming.edns_padding_from¶New in version 4.5.0.
Changed in version 5.0.5: YAML settings only: previously this was defined as a string instead of a sequence
[]List of netmasks (proxy IP in case of proxy-protocol presence, client IP otherwise) for which EDNS padding will be enabled in responses, provided that incoming.edns_padding_mode applies.
incoming.edns_padding_mode¶New in version 4.5.0.
padded-queries-onlyOne of always, padded-queries-only.
Whether to add EDNS padding to all responses (always) or only to responses for queries containing the EDNS padding option (padded-queries-only, the default).
In both modes, padding will only be added to responses for queries coming from incoming.edns_padding_from sources.
incoming.edns_padding_tag¶New in version 4.5.0.
7830The packetcache tag to use for padded responses, to prevent a client not allowed by the :ref::setting-edns-padding-from list to be served a cached answer generated for an allowed one. This
effectively divides the packet cache in two when incoming.edns_padding_from is used. Note that this will not override a tag set from one of the Lua hooks.
incoming.gettag_needs_edns_options¶New in version 4.1.0.
falseIf set, EDNS options in incoming queries are extracted and passed to the gettag() hook in the ednsoptions table.
incoming.listen¶[127.0.0.1]Local IP addresses to which we bind. Each address specified can include a port number; if no port is included then the incoming.port port will be used for that address. If a port number is specified, it must be separated from the address with a ‘:’; for an IPv6 address the address must be enclosed in square brackets.
Example:
incoming:
listen:
- 127.0.0.1
- listen: '[::1]:5353'
- listen: '::'
incoming.max_concurrent_requests_per_tcp_connection¶New in version 4.3.0.
10Maximum number of incoming requests handled concurrently per tcp connection. This number must be larger than 0 and smaller than 65536 and also smaller than max-mthreads.
incoming.max_tcp_clients¶Changed in version 5.2.0: Before 5.2.0 the default was 128.
1024Maximum number of simultaneous incoming TCP connections allowed.
incoming.max_tcp_per_client¶0Maximum number of simultaneous incoming TCP connections allowed per client (remote IP address). 0 means unlimited.
incoming.max_tcp_queries_per_connection¶New in version 4.1.0.
0Maximum number of DNS queries in a TCP connection. 0 means unlimited.
incoming.max_udp_queries_per_round¶New in version 4.1.4.
10000Under heavy load the recursor might be busy processing incoming UDP queries for a long while before there is no more of these, and might therefore
neglect scheduling new mthreads, handling responses from authoritative servers or responding to rec_control
requests.
This setting caps the maximum number of incoming UDP DNS queries processed in a single round of looping on recvmsg() after being woken up by the multiplexer, before
returning back to normal processing and handling other events.
incoming.non_local_bind¶falseBind to addresses even if one or more of the incoming.listen’s do not exist on this server. Setting this option will enable the needed socket options to allow binding to non-local addresses. This feature is intended to facilitate ip-failover setups, but it may also mask configuration issues and for this reason it is disabled by default.
incoming.pdns_distributes_queries¶Changed in version 4.9.0: Default changed to no, previously it was yes.
falseIf set, PowerDNS will use distinct threads to listen to client sockets and distribute that work to worker-threads using a hash of the query. This feature should maximize the cache hit ratio on versions before 4.9.0. To use more than one thread set incoming.distributor_threads in version 4.2.0 or newer. Enabling should improve performance on systems where incoming.reuseport does not have the effect of balancing the queries evenly over multiple worker threads.
incoming.port¶53Local port to bind to. If an address in incoming.listen does not have an explicit port, this port is used.
incoming.proxy_protocol_exceptions¶New in version 5.1.0.
[]If set, clients sending from an address in incoming.proxy_protocol_from to a address:port listed here are excluded from using the Proxy Protocol. If no port is specified, port 53 is assumed. This is typically used to provide an easy to use address and port to send debug queries to.
incoming.proxy_protocol_from¶New in version 4.4.0.
Changed in version 5.0.5: YAML settings only: previously this was defined as a string instead of a sequence
[]Ranges that are required to send a Proxy Protocol version 2 header in front of UDP and TCP queries, to pass the original source and destination addresses and ports to the recursor, as well as custom values. Queries that are not prefixed with such a header will not be accepted from clients in these ranges. Queries prefixed by headers from clients that are not listed in these ranges will be dropped.
Note that once a Proxy Protocol header has been received, the source address from the proxy header instead of the address of the proxy will be checked against the incoming.allow_from ACL.
The dnsdist docs have more information about the PROXY protocol.
incoming.proxy_protocol_maximum_size¶New in version 4.4.0.
512The maximum size, in bytes, of a Proxy Protocol payload (header, addresses and ports, and TLV values). Queries with a larger payload will be dropped.
incoming.proxymappings¶New in version 5.1.0.
[]Sequence of ProxyMapping
incoming.reuseport¶Changed in version 4.9.0: The default is changed to yes, previously it was no. If SO_REUSEPORT support is not available, the setting defaults to no.
trueIf SO_REUSEPORT support is available, allows multiple threads and processes to open listening sockets for the same port.
Since 4.1.0, when incoming.pdns_distributes_queries is disabled and incoming.reuseport is enabled, every worker-thread will open a separate listening socket to let the kernel distribute the incoming queries instead of running a distributor thread (which could otherwise be a bottleneck) and avoiding thundering herd issues, thus leading to much higher performance on multi-core boxes.
incoming.tcp_fast_open¶New in version 4.1.0.
0Enable TCP Fast Open support, if available, on the listening sockets. The numerical value supplied is used as the queue size, 0 meaning disabled. See TCP Fast Open Support.
incoming.tcp_timeout¶2Time to wait for data from TCP clients.
incoming.udp_truncation_threshold¶Changed in version 4.2.0: Before 4.2.0, the default was 1680.
1232EDNS0 allows for large UDP response datagrams, which can potentially raise performance. Large responses however also have downsides in terms of reflection attacks. This setting limits the accepted size. Maximum value is 65535, but values above 4096 should probably not be attempted.
To know why 1232, see the note at outgoing.edns_bufsize.
incoming.use_incoming_edns_subnet¶falseWhether to process and pass along a received EDNS Client Subnet to authoritative servers. The ECS information will only be sent for netmasks and domains listed in outgoing.edns_subnet_allow_list and will be truncated if the received scope exceeds ecs.ipv4_bits for IPv4 or ecs.ipv6_bits for IPv6.
logging.common_errors¶falseSome DNS errors occur rather frequently and are no cause for alarm.
logging.disable_syslog¶falseDo not log to syslog, only to stderr. Use this setting when running inside a supervisor that handles logging (like systemd). Note: do not use this setting in combination with recursor.daemon as all logging will disappear.
logging.dnstap_framestream_servers¶New in version 5.1.0.
[]Sequence of dnstap servers. Currently the maximum size of this list is one.
logging.dnstap_nod_framestream_servers¶New in version 5.1.0.
[]Sequence of NOD dnstap servers. Currently the maximum size of this list is one.
logging.facility¶If set to a digit, logging is performed under this LOCAL facility. See Logging. Do not pass names like ‘local0’!
logging.loglevel¶Changed in version 5.0.0: Previous version would not allow setting a level below 3 (error).
6Amount of logging. The higher the number, the more lines logged.
Corresponds to syslog level values (e.g. 0 = emergency, 1 = alert, 2 = critical, 3 = error, 4 = warning, 5 = notice, 6 = info, 7 = debug).
Each level includes itself plus the lower levels before it.
Not recommended to set this below 3.
If logging.quiet is no/false, logging.loglevel will be minimally set to 6 (info).
logging.outgoing_protobuf_servers¶New in version 5.1.0.
[]Sequence of outgoing protobuf servers. Currently the maximum size of this list is one.
logging.protobuf_mask_v4¶New in version 5.1.0.
32Network mask to apply to the client IPv4 addresses, for anonymization purposes. The default of 32 means no anonymization.
logging.protobuf_mask_v6¶New in version 5.1.0.
128Network mask to apply to the client IPv6 addresses, for anonymization purposes. The default of 128 means no anonymization.
logging.protobuf_servers¶New in version 5.1.0.
[]Sequence of outgoing protobuf servers. Currently the maximum size of this list is one.
logging.protobuf_use_kernel_timestamp¶New in version 4.2.0.
falseWhether to compute the latency of responses in protobuf messages using the timestamp set by the kernel when the query packet was received (when available), instead of computing it based on the moment we start processing the query.
logging.rpz_changes¶New in version 4.1.0.
falseLog additions and removals to RPZ zones at Info (6) level instead of Debug (7).
logging.statistics_interval¶New in version 4.1.0.
1800Interval between logging statistical summary on recursor performance. Use 0 to disable.
logging.structured_logging¶New in version 4.6.0.
Changed in version 5.1.0: Disabling structured logging is not supported
truePrefer structured logging when both an old style and a structured log messages is available.
logging.structured_logging_backend¶New in version 4.8.0.
Changed in version 5.1.0: The JSON backend was added
defaultThe backend used for structured logging output.
This setting must be set on the command line (--structured-logging-backend=...) to be effective.
Available backends are:
default: use the traditional logging system to output structured logging information.systemd-journal: use systemd-journal.
When using this backend, provide -o verbose or simular output option to journalctl to view the full information.json: JSON objects are written to the standard error stream.See Structured Logging Dictionary for more details.
logging.timestamp¶truelogging.trace¶noOne of no, yes or fail.
If turned on, output impressive heaps of logging.
May destroy performance under load.
To log only queries resulting in a ServFail answer from the resolving process, this value can be set to fail, but note that the performance impact is still large.
Also note that queries that do produce a result but with a failing DNSSEC validation are not written to the log
nod.db_size¶New in version 4.2.0.
67108864The default size of the stable bloom filter used to store previously observed domains is 67108864. To change the number of cells, use this setting. For each cell, the SBF uses 1 bit of memory, and one byte of disk for the persistent file. If there are already persistent files saved to disk, this setting will have no effect unless you remove the existing files.
nod.db_snapshot_interval¶New in version 5.1.0.
600Interval (in seconds) to write the NOD and UDR DB snapshots. Set to zero to disable snapshot writing.’,
nod.history_dir¶New in version 4.2.0.
This setting controls which directory is used to store the on-disk cache of previously observed domains.
The default depends on LOCALSTATEDIR when building the software.
Usually this comes down to /var/lib/pdns-recursor/nod or /usr/local/var/lib/pdns-recursor/nod).
The newly observed domain feature uses a stable bloom filter to store a history of previously observed domains. The data structure is synchronized to disk every 10 minutes, and is also initialized from disk on startup. This ensures that previously observed domains are preserved across recursor restarts. If you change the new-domain-db-size setting, you must remove any files from this directory.
nod.ignore_list¶New in version 4.5.0.
[]This setting is a list of all domains (and implicitly all subdomains) that will never be considered a new domain. For example, if the domain ‘example.com’ is in the list, then ‘foo.bar.example.com’ will never be considered a new domain. One use-case for the ignore list is to never reveal details of internal subdomains via the new-domain-lookup feature.
nod.ignore_list_file¶New in version 5.1.0.
Path to a file with a list of domains. File should have one domain per line, with no extra characters or comments. See nod.ignore_list.
nod.log¶New in version 4.2.0.
trueIf a newly observed domain is detected, log that domain in the recursor log file. The log line looks something like:
Jul 18 11:31:25 Newly observed domain nod=sdfoijdfio.com
nod.lookup¶New in version 4.2.0.
If a domain is specified, then each time a newly observed domain is detected, the recursor will perform an A record lookup of ‘<newly observed domain>.<lookup domain>’. For example if ‘new-domain-lookup’ is configured as ‘nod.powerdns.com’, and a new domain ‘example.com’ is detected, then an A record lookup will be made for ‘example.com.nod.powerdns.com’. This feature gives a way to share the newly observed domain with partners, vendors or security teams. The result of the DNS lookup will be ignored by the recursor.
nod.pb_tag¶New in version 4.2.0.
pdns-nodIf protobuf is configured, then this tag will be added to all protobuf response messages when a new domain is observed.
nod.tracking¶New in version 4.2.0.
falseWhether to track newly observed domains, i.e. never seen before. This is a probabilistic algorithm, using a stable bloom filter to store records of previously seen domains. When enabled for the first time, all domains will appear to be newly observed, so the feature is best left enabled for e.g. a week or longer before using the results. Note that this feature is optional and must be enabled at compile-time, thus it may not be available in all pre-built packages. If protobuf is enabled and configured, then the newly observed domain status will appear as a flag in Response messages.
nod.unique_response_db_size¶New in version 4.2.0.
67108864The default size of the stable bloom filter used to store previously observed responses is 67108864. To change the number of cells, use this setting. For each cell, the SBF uses 1 bit of memory, and one byte of disk for the persistent file. If there are already persistent files saved to disk, this setting will have no effect unless you remove the existing files.
nod.unique_response_history_dir¶New in version 4.2.0.
This setting controls which directory is used to store the on-disk cache of previously observed responses.
The default depends on LOCALSTATEDIR when building the software.
Usually this comes down to /var/lib/pdns-recursor/udr or /usr/local/var/lib/pdns-recursor/udr).
The newly observed domain feature uses a stable bloom filter to store a history of previously observed responses. The data structure is synchronized to disk every 10 minutes, and is also initialized from disk on startup. This ensures that previously observed responses are preserved across recursor restarts. If you change the unique-response-db-size, you must remove any files from this directory.
nod.unique_response_ignore_list¶New in version 5.1.0.
[]This setting is a list of all domains (and implicitly all subdomains) that will never be considered for new unique domain responses. For example, if the domain ‘example.com’ is in the list, then ‘foo.bar.example.com’ will never be considered for a new unique domain response.
nod.unique_response_ignore_list_file¶New in version 5.1.0.
Path to a file with a list of domains. File should have one domain per line, with no extra characters or comments. See nod.unique_response_ignore_list.
nod.unique_response_log¶New in version 4.2.0.
trueWhether to log when a unique response is detected. The log line looks something like:
Oct 24 12:11:27 Unique response observed: qname=foo.com qtype=A rrtype=AAAA rrname=foo.com rrcontent=1.2.3.4
nod.unique_response_pb_tag¶New in version 4.2.0.
pdns-udrIf protobuf is configured, then this tag will be added to all protobuf response messages when a unique DNS response is observed.
nod.unique_response_tracking¶New in version 4.2.0.
falseWhether to track unique DNS responses, i.e. never seen before combinations of the triplet (query name, query type, RR[rrname, rrtype, rrdata]). This can be useful for tracking potentially suspicious domains and behaviour, e.g. DNS fast-flux. If protobuf is enabled and configured, then the Protobuf Response message will contain a flag with udr set to true for each RR that is considered unique, i.e. never seen before. This feature uses a probabilistic data structure (stable bloom filter) to track unique responses, which can have false positives as well as false negatives, thus it is a best-effort feature. Increasing the number of cells in the SBF using the unique-response-db-size setting can reduce FPs and FNs.
outgoing.bypass_server_throttling_probability¶New in version 5.0.0.
25This setting determines the probability of a server marked down to be used anyway.
A value of n means that the chance of a server marked down still being used after it wins speed selection is is 1/n.
If this setting is zero throttled servers will never be selected to be used anyway.
outgoing.dont_query¶[127.0.0.0/8, 10.0.0.0/8, 100.64.0.0/10, 169.254.0.0/16, 192.168.0.0/16, 172.16.0.0/12, '::1/128', 'fc00::/7', 'fe80::/10', 0.0.0.0/8, 192.0.0.0/24, 192.0.2.0/24, 198.51.100.0/24, 203.0.113.0/24, 240.0.0.0/4, '::/96', '::ffff:0:0/96', '100::/64', '2001:db8::/32']The DNS is a public database, but sometimes contains delegations to private IP addresses, like for example 127.0.0.1. This can have odd effects, depending on your network, and may even be a security risk. Therefore, the PowerDNS Recursor by default does not query private space IP addresses. This setting can be used to expand or reduce the limitations.
Queries for names in forward zones and to addresses as configured in any of the settings recursor.forward_zones, recursor.forward_zones_file or recursor.forward_zones_recurse are performed regardless of these limitations. However, if NS records are learned from recursor.forward_zones and the IP addresses of the nameservers learned in that way are included in outgoing.dont_query, lookups relying on these nameservers will fail with SERVFAIL.
outgoing.dont_throttle_names¶New in version 4.2.0.
[]When an authoritative server does not answer a query or sends a reply the recursor does not like, it is throttled. Any servers’ name suffix-matching the supplied names will never be throttled.
Warning
Most servers on the internet do not respond for a good reason (overloaded or unreachable), dont-throttle-names could make this load on the upstream server even higher, resulting in further service degradation.
outgoing.dont_throttle_netmasks¶New in version 4.2.0.
[]When an authoritative server does not answer a query or sends a reply the recursor does not like, it is throttled. Any servers matching the supplied netmasks will never be throttled.
This can come in handy on lossy networks when forwarding, where the same server is configured multiple times (e.g. with forward_zones_recurse: [ {zone: example.com, forwarders: [ 192.0.2.1, 192.0.2.1 ] } ].
By default, the PowerDNS Recursor would throttle the ‘first’ server on a timeout and hence not retry the ‘second’ one.
In this case, outgoing.dont_throttle_netmasks could be set to include 192.0.2.1.
Warning
Most servers on the internet do not respond for a good reason (overloaded or unreachable), dont-throttle-netmasks could make this load on the upstream server even higher, resulting in further service degradation.
outgoing.dot_to_auth_names¶New in version 4.6.0.
[]Force DoT to the listed authoritative nameservers. For this to work, DoT support has to be compiled in. Currently, the certificate is not checked for validity in any way.
outgoing.dot_to_port_853¶New in version 4.6.0.
trueEnable DoT to forwarders that specify port 853.
outgoing.edns_bufsize¶Changed in version 4.2.0: Before 4.2.0, the default was 1680
1232Note
Why 1232?
1232 is the largest number of payload bytes that can fit in the smallest IPv6 packet. IPv6 has a minimum MTU of 1280 bytes (RFC 8200, section 5), minus 40 bytes for the IPv6 header, minus 8 bytes for the UDP header gives 1232, the maximum payload size for the DNS response.
This is the value set for the EDNS0 buffer size in outgoing packets. Lower this if you experience timeouts.
outgoing.edns_padding¶New in version 4.8.0.
trueWhether to add EDNS padding to outgoing DoT queries.
outgoing.edns_subnet_allow_list¶New in version 4.5.0.
[]List of netmasks and domains that EDNS Client Subnet should be enabled for in outgoing queries.
For example, an EDNS Client Subnet option containing the address of the initial requestor (but see ecs.add_for) will be added to an outgoing query sent to server 192.0.2.1 for domain X if 192.0.2.1 matches one of the supplied netmasks, or if X matches one of the supplied domains. The initial requestor address will be truncated to 24 bits for IPv4 (see ecs.ipv4_bits) and to 56 bits for IPv6 (see ecs.ipv6_bits), as recommended in the privacy section of RFC 7871.
Note that this setting describes the destination of outgoing queries, not the sources of incoming queries, nor the subnets described in the EDNS Client Subnet option.
By default, this option is empty, meaning no EDNS Client Subnet information is sent.
outgoing.lowercase¶falseSet to true to lowercase the outgoing queries.
When set to ‘no’ (the default) a query from a client using mixed case in the DNS labels (such as a user entering mixed-case names or draft-vixie-dnsext-dns0x20-00), PowerDNS preserves the case of the query.
Broken authoritative servers might give a wrong or broken answer on this encoding.
Setting lowercase-outgoing to ‘yes’ makes the PowerDNS Recursor lowercase all the labels in the query to the authoritative servers, but still return the proper case to the client requesting.
outgoing.max_busy_dot_probes¶New in version 4.7.0.
0Limit the maximum number of simultaneous DoT probes the Recursor will schedule. The default value 0 means no DoT probes are scheduled.
DoT probes are used to check if an authoritative server’s IP address supports DoT.
If the probe determines an IP address supports DoT, the Recursor will use DoT to contact it for subsequent queries until a failure occurs.
After a failure, the Recursor will stop using DoT for that specific IP address for a while.
The results of probes are remembered and can be viewed by the rec_control dump-dot-probe-map command.
If the maximum number of pending probes is reached, no probes will be scheduled, even if no DoT status is known for an address.
If the result of a probe is not yet available, the Recursor will contact the authoritative server in the regular way, unless an authoritative server is configured to be contacted over DoT always using outgoing.dot_to_auth_names.
In that case no probe will be scheduled.
Note
DoT probing is an experimental feature. Please test thoroughly to determine if it is suitable in your specific production environment before enabling.
outgoing.max_ns_address_qperq¶New in version 4.1.16.
New in version 4.2.2.
New in version 4.3.1.
10The maximum number of outgoing queries with empty replies for resolving nameserver names to addresses we allow during the resolution of a single client query. If IPv6 is enabled, an A and a AAAA query for a name counts as 1. If a zone publishes more than this number of NS records, the limit is further reduced for that zone by lowering it by the number of NS records found above the outgoing.max_ns_address_qperq value. The limit wil not be reduced to a number lower than 5.
outgoing.max_ns_per_resolve¶New in version 4.8.0.
New in version 4.7.3.
New in version 4.6.4.
New in version 4.5.11.
13The maximum number of NS records that will be considered to select a nameserver to contact to resolve a name. If a zone has more than outgoing.max_ns_per_resolve NS records, a random sample of this size will be used. If outgoing.max_ns_per_resolve is zero, no limit applies.
outgoing.max_qperq¶Changed in version 5.1.0: The default used to be 60, with an extra allowance if qname minimization was enabled. Having better algorithms allows for a lower default limit.
50The maximum number of outgoing queries that will be sent out during the resolution of a single client query. This is used to avoid cycles resolving names.
outgoing.network_timeout¶1500Number of milliseconds to wait for a remote authoritative server to respond. If the number of concurrent requests is high, the :program:Recursor uses a lower value.
outgoing.non_resolving_ns_max_fails¶New in version 4.5.0.
5Number of failed address resolves of a nameserver name to start throttling it, 0 is disabled. Nameservers matching outgoing.dont_throttle_names will not be throttled.
outgoing.non_resolving_ns_throttle_time¶New in version 4.5.0.
60Number of seconds to throttle a nameserver with a name failing to resolve.
outgoing.server_down_max_fails¶64If a server has not responded in any way this many times in a row, no longer send it any queries for outgoing.server_down_throttle_time seconds. Afterwards, we will try a new packet, and if that also gets no response at all, we again throttle for outgoing.server_down_throttle_time seconds. Even a single response packet will drop the block.
outgoing.server_down_throttle_time¶60Throttle a server that has failed to respond outgoing.server_down_max_fails times for this many seconds.
outgoing.single_socket¶falseUse only a single socket for outgoing queries.
outgoing.source_address¶Changed in version 4.4.0: IPv6 addresses can be set with this option as well.
[0.0.0.0]Note
While subnets and their negations are syntactically accepted, the handling of subnets has not been implemented yet. Only individual IP addresses can be listed.
Send out local queries from this address, or addresses. By adding multiple addresses, increased spoofing resilience is achieved. When no address of a certain address family is configured, there are no queries sent with that address family. In the default configuration this means that IPv6 is not used for outgoing queries.
outgoing.tcp_fast_open_connect¶New in version 4.5.0.
falseEnable TCP Fast Open Connect support, if available, on the outgoing connections to authoritative servers. See TCP Fast Open Support.
outgoing.tcp_max_idle_ms¶New in version 4.6.0.
10000Time outgoing TCP/DoT connections are left idle in milliseconds or 0 if no limit. After having been idle for this time, the connection is eligible for closing.
outgoing.tcp_max_idle_per_auth¶New in version 4.6.0.
10Maximum number of idle outgoing TCP/DoT connections to a specific IP per thread, 0 means do not keep idle connections open.
outgoing.tcp_max_idle_per_thread¶New in version 4.6.0.
100Maximum number of idle outgoing TCP/DoT connections per thread, 0 means do not keep idle connections open.
outgoing.tcp_max_queries¶0Maximum total number of queries per outgoing TCP/DoT connection, 0 means no limit. After this number of queries, the connection is closed and a new one will be created if needed.
outgoing.udp_source_port_avoid¶New in version 4.2.0.
[11211]A sequence of UDP port numbers to avoid when binding. For example:
outgoing:
udp_source_port_avoid:
- 5300
- 11211
outgoing.udp_source_port_max¶New in version 4.2.0.
65535This option sets the maximum limit of UDP port number to bind on.
outgoing.udp_source_port_min¶New in version 4.2.0.
1024This option sets the low limit of UDP port number to bind on.
In combination with outgoing.udp_source_port_max it configures the UDP port range to use. Port numbers are randomized within this range on initialization, and exceptions can be configured with outgoing.udp_source_port_avoid
packetcache.disable¶falseTurn off the packet cache. Useful when running with Lua scripts that modify answers in such a way they cannot be cached, though individual answer caching can be controlled from Lua as well.
packetcache.max_entries¶500000Maximum number of Packet Cache entries. Sharded and shared by all threads since 4.9.0.
packetcache.negative_ttl¶New in version 4.9.0.
60Maximum number of seconds to cache an NxDomain or NoData answer in the packetcache.
This setting’s maximum is capped to packetcache.ttl.
i.e. setting packetcache-ttl=15 and keeping packetcache-negative-ttl at the default will lower packetcache-negative-ttl to 15.
packetcache.servfail_ttl¶packetcache-ttl=15 and keeping packetcache-servfail-ttl at the default will lower packetcache-servfail-ttl to 15.”)60Maximum number of seconds to cache an answer indicating a failure to resolve in the packet cache.
Before version 4.6.0 only ServFail answers were considered as such. Starting with 4.6.0, all responses with a code other than NoError and NXDomain, or without records in the answer and authority sections, are considered as a failure to resolve.
Since 4.9.0, negative answers are handled separately from resolving failures.
packetcache.shards¶New in version 4.9.0.
1024Sets the number of shards in the packet cache. If you have high contention as reported by packetcache-contented/packetcache-acquired,
you can try to enlarge this value or run with fewer threads.
packetcache.ttl¶Changed in version 4.9.0: The default was changed from 3600 (1 hour) to 86400 (24 hours).
86400Maximum number of seconds to cache an item in the packet cache, no matter what the original TTL specified.
recordcache.limit_qtype_any¶New in version 4.9.9.
New in version 5.0.9.
New in version 5.1.2.
trueLimit answers to ANY queries constructed from the record cache in size.
Trying to retrieve more than recordcache.max_rrset_size records will result in a ServFail’,
recordcache.locked_ttl_perc¶New in version 4.8.0.
0Replace record sets in the record cache only after this percentage of the original TTL has passed. The PowerDNS Recursor already has several mechanisms to protect against spoofing attempts. This adds an extra layer of protection—as it limits the window of time cache updates are accepted—at the cost of a less efficient record cache.
The default value of 0 means no extra locking occurs. When non-zero, record sets received (e.g. in the Additional Section) will not replace existing record sets in the record cache until the given percentage of the original TTL has expired. A value of 100 means only expired record sets will be replaced.
There are a few cases where records will be replaced anyway:
recordcache.max_cache_bogus_ttl¶New in version 4.2.0.
3600Maximum number of seconds to cache an item in the DNS cache (negative or positive) if its DNSSEC validation failed, no matter what the original TTL specified, to reduce the impact of a broken domain.
recordcache.max_entries¶1000000Maximum number of DNS record cache entries, shared by all threads since 4.4.0. Each entry associates a name and type with a record set. The size of the negative cache is 10% of this number.
recordcache.max_negative_ttl¶3600A query for which there is authoritatively no answer is cached to quickly deny a record’s existence later on, without putting a heavy load on the remote server. In practice, caches can become saturated with hundreds of thousands of hosts which are tried only once. This setting, which defaults to 3600 seconds, puts a maximum on the amount of time negative entries are cached.
recordcache.max_rrset_size¶New in version 4.9.9.
New in version 5.0.9.
New in version 5.1.2.
256Maximum size of RRSets in cache.
Trying to retrieve larger RRSets will result in a ServFail.’,
recordcache.max_ttl¶Changed in version 4.1.0: The minimum value of this setting is 15. i.e. setting this to lower than 15 will make this value 15.
86400Maximum number of seconds to cache an item in the DNS cache, no matter what the original TTL specified. This value also controls the refresh period of cached root data. See Handling of root hints for more information on this.
recordcache.refresh_on_ttl_perc¶New in version 4.5.0.
0Sets the ‘refresh almost expired’ percentage of the record cache. Whenever a record is fetched from the packet or record cache
and only refresh-on-ttl-perc percent or less of its original TTL is left, a task is queued to refetch the name/type combination to
update the record cache. In most cases this causes future queries to always see a non-expired record cache entry.
A typical value is 10. If the value is zero, this functionality is disabled.
recordcache.serve_stale_extensions¶New in version 4.8.0.
0Maximum number of times an expired record’s TTL is extended by 30s when serving stale.
Extension only occurs if a record cannot be refreshed.
A value of 0 means the Serve Stale mechanism is not used.
To allow records becoming stale to be served for an hour, use a value of 120.
See Serve Stale for a description of the Serve Stale mechanism.
recordcache.shards¶New in version 4.4.0.
1024Sets the number of shards in the record cache. If you have high
contention as reported by
record-cache-contented/record-cache-acquired, you can try to
enlarge this value or run with fewer threads.
recordcache.zonetocaches¶New in version 5.1.0.
[]Sequence of ZoneToCache entries
recursor.allow_trust_anchor_query¶New in version 4.3.0.
falseAllow trustanchor.server CH TXT and negativetrustanchor.server CH TXT queries to view the configured DNSSEC (negative) trust anchors.
recursor.allowed_additional_qtypes¶New in version 5.1.0.
[]Sequence of AllowedAdditionalQType
recursor.any_to_tcp¶falseAnswer questions for the ANY type on UDP with a truncated packet that refers the remote server to TCP. Useful for mitigating ANY reflection attacks.
recursor.auth_zones¶[]Zones read from these files (in BIND format) are served authoritatively (but without the AA bit set in responses). DNSSEC is not supported. Example:
recursor:
auth-zones:
- zone: example.org
file: /var/zones/example.org
- zone: powerdns.com
file: /var/zones/powerdns.com
recursor.chroot¶If set, chroot to this directory for more security. This is not recommended; instead, we recommend containing PowerDNS using operating system features. We ship systemd unit files with our packages to make this easy.
Make sure that /dev/log is available from within the chroot.
Logging will silently fail over time otherwise (on logrotate).
When using chroot, all other paths (except for recursor.config_dir) set in the configuration are relative to the new root.
When running on a system where systemd manages services, chroot does not work out of the box, as PowerDNS cannot use the NOTIFY_SOCKET.
Either do not chroot on these systems or set the ‘Type’ of this service to ‘simple’ instead of ‘notify’ (refer to the systemd documentation on how to modify unit-files).
recursor.config_dir¶Location of configuration directory (where recursor.conf or recursor.yml is stored).
Usually /etc/powerdns, but this depends on SYSCONFDIR during compile-time.
Use default or set on command line.
recursor.config_name¶When running multiple recursors on the same server, read settings from recursor-name.conf, this will also rename the binary image.
recursor.cpu_map¶Set CPU affinity for threads, asking the scheduler to run those threads on a single CPU, or a set of CPUs. This parameter accepts a space separated list of thread-id=cpu-id, or thread-id=cpu-id-1,cpu-id-2,…,cpu-id-N. For example, to make the worker thread 0 run on CPU id 0 and the worker thread 1 on CPUs 1 and 2:
recursor:
cpu_map: 0=0 1=1,2
The thread handling the control channel, the webserver and other internal stuff has been assigned id 0, the distributor threads if any are assigned id 1 and counting, and the worker threads follow behind. The number of distributor threads is determined by incoming.distributor_threads, the number of worker threads is determined by the recursor.threads setting.
This parameter is only available if the OS provides the pthread_setaffinity_np() function.
Note that depending on the configuration the Recursor can start more threads. Typically these threads will sleep most of the time. These threads cannot be specified in this setting as their thread-ids are left unspecified.
recursor.daemon¶Changed in version 4.0.0: Default is now no, was yes before.
falseOperate in the background.
recursor.dns64_prefix¶New in version 4.4.0.
Enable DNS64 (RFC 6147) support using the supplied /96 IPv6 prefix. This will generate ‘fake’ AAAA records for names
with only A records, as well as ‘fake’ PTR records to make sure that reverse lookup of DNS64-generated IPv6 addresses
generate the right name.
See DNS64 support for more flexible but slower alternatives using Lua.
recursor.etc_hosts_file¶/etc/hostsThe path to the /etc/hosts file, or equivalent. This file can be used to serve data authoritatively using recursor.export_etc_hosts.
recursor.event_trace_enabled¶New in version 4.6.0.
0Enable the recording and logging of ref:event traces. This is an experimental feature and subject to change. Possible values are 0: (disabled), 1 (add information to protobuf logging messages) and 2 (write to log) and 3 (both).
recursor.export_etc_hosts¶falseIf set, this flag will export the host names and IP addresses mentioned in /etc/hosts.
recursor.export_etc_hosts_search_suffix¶If set, all hostnames in the recursor.export_etc_hosts file are loaded in canonical form, based on this suffix, unless the name contains a ‘.’, in which case the name is unchanged.
So an entry called ‘pc’ with export-etc-hosts-search-suffix='home.com' will lead to the generation of ‘pc.home.com’ within the recursor.
An entry called ‘server1.home’ will be stored as ‘server1.home’, regardless of this setting.
recursor.extended_resolution_errors¶New in version 4.5.0.
Changed in version 5.0.0: Default changed to enabled, previously it was disabled.
trueIf set, the recursor will add an EDNS Extended Error (RFC 8914) to responses when resolution failed, like DNSSEC validation errors, explaining the reason it failed. This setting is not needed to allow setting custom error codes from Lua or from a RPZ hit.
recursor.forward_zones¶Changed in version 5.2.0: Zones having notify_allowed set will be added to incoming.allow_notify_for.
[]Queries for zones listed here will be forwarded to the IP address listed. i.e.
recursor:
forward-zones:
- zone: example.org
forwarders:
- 203.0.113.210
- zone: powerdns.com
forwarders:
- 2001:DB8::BEEF:5
Multiple IP addresses can be specified and port numbers other than 53 can be configured:
recursor:
forward-zones:
- zone: example.org
forwarders:
- 203.0.113.210:5300
- 127.0.0.1
- zone: powerdns.com
forwarders:
- 127.0.0.1
- 198.51.100.10:530
- '[2001:DB8::1:3]:5300'
Forwarded queries have the recursion desired (RD) bit set to 0, meaning that this setting is intended to forward queries to authoritative servers.
If an NS record set for a subzone of the forwarded zone is learned, that record set will be used to determine addresses for name servers of the subzone.
This allows e.g. a forward to a local authoritative server holding a copy of the root zone, delegations received from that server will work.
Note: When an NS record for a subzone is learned and the IP address for that nameserver is included in the IP ranges in outgoing.dont_query,
SERVFAIL is returned.
IMPORTANT: When using DNSSEC validation (which is default), forwards to non-delegated (e.g. internal) zones that have a DNSSEC signed parent zone will validate as Bogus.
To prevent this, add a Negative Trust Anchor (NTA) for this zone in the recursor.lua_config_file with addNTA('your.zone', 'A comment').
If this forwarded zone is signed, instead of adding NTA, add the DS record to the recursor.lua_config_file.
See the DNSSEC in the PowerDNS Recursor information.
recursor.forward_zones_file¶Changed in version 4.0.0: (Old style settings only) Comments are allowed, everything behind # is ignored.
Changed in version 4.6.0: (Old style settings only) Zones prefixed with a ^ are added to the allow-notify-for list. Both prefix characters can be used if desired, in any order.
Same as recursor.forward_zones, parsed from a file as a sequence of ZoneForward.
- zone: example1.com
forwarders:
- 127.0.0.1
- 127.0.0.1:5353
- '[::1]:53'
- zone: example2.com
forwarders:
- ::1
recurse: true
notify_allowed: true
The DNSSEC notes from recursor.forward_zones apply here as well.
recursor.forward_zones_recurse¶[]Like regular recursor.forward_zones, but forwarded queries have the recursion desired (RD) bit set to 1, meaning that this setting is intended to forward queries to other recursive servers.
In contrast to regular forwarding, the rule that delegations of the forwarded subzones are respected is not active.
This is because we rely on the forwarder to resolve the query fully.
See recursor.forward_zones for additional options (such as supplying multiple recursive servers) and an important note about DNSSEC.
recursor.forwarding_catalog_zones¶New in version 5.2.0.
[]Sequence of ForwardingCatalogZone
recursor.hint_file¶Changed in version 4.6.2: Introduced the value no to disable root-hints processing.
Changed in version 4.9.0: Introduced the value no-refresh to disable both root-hints processing and periodic refresh of the cached root NS records.
If set, the root-hints are read from this file. If empty, the default built-in root hints are used.
In some special cases, processing the root hints is not needed, for example when forwarding all queries to another recursor.
For these special cases, it is possible to disable the processing of root hints by setting the value to no or no-refresh.
See Handling of root hints for more information on root hints handling.
recursor.ignore_unknown_settings¶[]Names of settings to be ignored while parsing configuration files, if the setting name is unknown to PowerDNS.
Useful during upgrade testing.
recursor.include_dir¶Directory to scan for additional config files. All files that end with .yml are loaded in order using POSIX as locale.
recursor.latency_statistic_size¶10000Indication of how many queries will be averaged to get the average latency reported by the ‘qa-latency’ metric.
recursor.lua_config_file¶If set, and Lua support is compiled in, this will load an additional configuration file for newer features and more complicated setups. See Advanced Configuration Using Lua for the options that can be set in this file.
recursor.lua_dns_script¶Path to a lua file to manipulate the Recursor’s answers. See Scripting PowerDNS Recursor for more information.
recursor.lua_global_include_dir¶When creating a Lua context, all *.lua files in the directory are loaded into the Lua context.
recursor.lua_maintenance_interval¶New in version 4.2.0.
1The interval between calls to the Lua user defined maintenance() function in seconds. See Maintenance callback
recursor.lua_start_stop_script¶New in version 5.2.0.
Load this Lua script on startup and shutdown and run the Lua function on_recursor_start on startup and the Lua function on_recursor_stop on a nice shutdown (using rec_control quit-nicely of the Recursor process.
recursor.max_chain_length¶New in version 5.1.0.
0The maximum number of queries that can be attached to an outgoing request chain. Attaching requests to a chain saves on outgoing queries, but the processing of a chain when the reply to the outgoing query comes in might result in a large outgoing traffic spike. Reducing the maximum chain length mitigates this. If this value is zero, no maximum is enforced, though the maximum number of mthreads (recursor.max_mthreads) also limits the chain length.
recursor.max_cnames_followed¶New in version 5.1.0.
10Maximum length of a CNAME chain. If a CNAME chain exceeds this length, a ServFail answer will be returned.
Previously, this limit was fixed at 10.
recursor.max_generate_steps¶New in version 4.3.0.
0Maximum number of steps for a ‘$GENERATE’ directive when parsing a zone file. This is a protection measure to prevent consuming a lot of CPU and memory when untrusted zones are loaded. Default to 0 which means unlimited.
recursor.max_include_depth¶New in version 4.6.0.
20Maximum number of nested $INCLUDE directives while processing a zone file.
Zero mean no $INCLUDE directives will be accepted.
recursor.max_mthreads¶2048Maximum number of simultaneous MTasker threads, per worker thread.
recursor.max_recursion_depth¶Changed in version 4.1.0: Before 4.1.0, this settings was unlimited.
Changed in version 4.9.0: Before 4.9.0 this setting’s default was 40 and the limit on CNAME chains (fixed at 16) acted as a bound on he recursion depth.
16Total maximum number of internal recursion calls the server may use to answer a single query. 0 means unlimited. The value of recursor.stack_size should be increased together with this one to prevent the stack from overflowing. If recursor.qname_minimization is enabled, the fallback code in case of a failing resolve is allowed an additional max-recursion-depth/2.
recursor.max_total_msec¶7000Total maximum number of milliseconds of wallclock time the server may use to answer a single query. 0 means unlimited.
recursor.minimum_ttl_override¶Changed in version 4.5.0: Old versions used default 0.
1This setting artificially raises all TTLs to be at least this long.
Setting this to a value greater than 1 technically is an RFC violation, but might improve performance a lot.
Using a value of 0 impacts performance of TTL 0 records greatly, since it forces the recursor to contact
authoritative servers each time a client requests them.
Can be set at runtime using rec_control set-minimum-ttl 3600.
recursor.nothing_below_nxdomain¶New in version 4.3.0.
dnssecno, dnssec, yes.The type of RFC 8020 handling using cached NXDOMAIN responses. This RFC specifies that NXDOMAIN means that the DNS tree under the denied name MUST be empty. When an NXDOMAIN exists in the cache for a shorter name than the qname, no lookup is done and an NXDOMAIN is sent to the client.
For instance, when foo.example.net is negatively cached, any query
matching *.foo.example.net will be answered with NXDOMAIN directly
without consulting authoritative servers.
recursor.public_suffix_list_file¶New in version 4.2.0.
Path to the Public Suffix List file, if any. If set, PowerDNS will try to load the Public Suffix List from this file instead of using the built-in list. The PSL is used to group the queries by relevant domain names when displaying the top queries.
recursor.qname_max_minimize_count¶New in version 5.0.0.
10Max minimize count parameter, described in RFC 9156. This is the maximum number of iterations
of the Query Name Minimization Algorithm.
recursor.qname_minimization¶New in version 4.3.0.
trueEnable Query Name Minimization. This implements a relaxed form of Query Name Mimimization as described in RFC 9156.
recursor.qname_minimize_one_label¶New in version 5.0.0.
4Minimize one label parameter, described in RFC 9156.
The value for the number of iterations of the Query Name Minimization Algorithm that should only have one label appended.
This value has precedence over recursor.qname_max_minimize_count.
recursor.root_nx_trust¶Changed in version 4.0.0: Default is yes now, was no before 4.0.0
trueIf set, an NXDOMAIN from the root-servers will serve as a blanket NXDOMAIN for the entire TLD the query belonged to. The effect of this is far fewer queries to the root-servers.
recursor.rpzs¶New in version 5.1.0.
[]Sequence of RPZ entries.
recursor.save_parent_ns_set¶New in version 4.7.0.
trueIf set, a parent (non-authoritative) NS set is saved if it contains more entries than a newly encountered child (authoritative) NS set for the same domain.
The saved parent NS set is tried if resolution using the child NS set fails.
recursor.security_poll_suffix¶secpoll.powerdns.com.Domain name from which to query security update notifications. Setting this to an empty string disables secpoll.
recursor.serve_rfc1918¶trueThis makes the server authoritatively aware of: 10.in-addr.arpa, 168.192.in-addr.arpa, 16-31.172.in-addr.arpa, which saves load on the AS112 servers.
Individual parts of these zones can still be loaded or forwarded.
recursor.serve_rfc6303¶New in version 5.1.3.
New in version 5.2.0.
trueThis makes the server authoritatively aware of the zones in RFC 6303 not covered by RFC 1918. Individual parts of these zones can still be loaded or forwarded. recursor.serve_rfc1918 must be enabled for this option to take effect.
recursor.server_id¶*runtime determined*The reply given by The PowerDNS recursor to a query for ‘id.server’ with its hostname, useful for in clusters. When a query contains the NSID EDNS0 Option, this value is returned in the response as the NSID value.
This setting can be used to override the answer given to these queries. Set to ‘disabled’ to disable NSID and ‘id.server’ answers.
Query example (where 192.0.2.14 is your server):
dig @192.0.2.14 CHAOS TXT id.server.
dig @192.0.2.14 example.com IN A +nsid
recursor.setgid¶PowerDNS can change its user and group id after binding to its socket. Can be used for better security.
recursor.setuid¶PowerDNS can change its user and group id after binding to its socket. Can be used for better security.
recursor.socket_dir¶Where to store the control socket and pidfile.
The default depends on LOCALSTATEDIR or the --with-socketdir setting when building (usually /var/run or /run).
When using recursor.chroot the default becomes /.
The default value is overruled by the RUNTIME_DIRECTORY environment variable when that variable has a value (e.g. under systemd).
recursor.socket_group¶Group and mode of the controlsocket. Owner and group can be specified by name, mode is in octal.
recursor.socket_mode¶Mode of the controlsocket. Owner and group can be specified by name, mode is in octal.
recursor.socket_owner¶Owner of the controlsocket. Owner and group can be specified by name, mode is in octal.
recursor.sortlists¶New in version 5.1.0.
[]Sequence of sort lists.
recursor.spoof_nearmiss_max¶Changed in version 4.5.0: Older versions used 20 as the default value.
1If set to non-zero, PowerDNS will assume it is being spoofed after seeing this many answers with the wrong id.
recursor.stack_cache_size¶New in version 4.9.0.
100Maximum number of mthread stacks that can be cached for later reuse, per thread. Caching these stacks reduces the CPU load at the cost of a slightly higher memory usage, each cached stack consuming stack-size bytes of memory. It makes no sense to cache more stacks than the value of max-mthreads, since there will never be more stacks than that in use at a given time.
recursor.stack_size¶200000Size in bytes of the stack of each mthread.
recursor.stats_api_disabled_list¶New in version 4.5.0.
A sequence of statistic names, that are disabled when retrieving the complete list of statistics via the API for performance reasons. These statistics can still be retrieved individually by specifically asking for it.
recursor.stats_carbon_disabled_list¶New in version 4.5.0.
A sequence of statistic names, that are prevented from being exported via carbon for performance reasons.
recursor.stats_rec_control_disabled_list¶New in version 4.5.0.
A sequence of statistic names, that are disabled when retrieving the complete list of statistics via rec_control get-all, for performance reasons. These statistics can still be retrieved individually.
recursor.stats_ringbuffer_entries¶10000Number of entries in the remotes ringbuffer, which keeps statistics on who is querying your server.
Can be read out using rec_control top-remotes.
recursor.stats_snmp_disabled_list¶New in version 4.5.0.
A sequence of statistic names, that are prevented from being exported via SNMP, for performance reasons.
recursor.system_resolver_interval¶New in version 5.1.0.
0Sets the check interval (in seconds) of the system resolver feature. All names known by the system resolver subsystem are periodically checked for changing values.
If the TTL of a name has expired, it is checked by re-resolving it.
if a change is detected, the recursor performs an equivalent of rec_control reload-zones.
This settings sets the interval between the checks. If set to zero (the default), the value recursor.system_resolver_ttl is used.
recursor.system_resolver_self_resolve_check¶New in version 5.1.0.
trueWarn on potential self-resolve. If this check draws the wrong conclusion, you can disable it.
recursor.system_resolver_ttl¶New in version 5.1.0.
0Sets TTL in seconds of the system resolver feature. If not equal to zero names can be used for forwarding targets. The names will be resolved by the system resolver configured in the OS.
The TTL is used as a time to live to see if the names used in forwarding resolve to a different address than before.
If the TTL is expired, a re-resolve will be done by the next iteration of the check function;
if a change is detected, the recursor performs an equivalent of rec_control reload-zones.
Make sure the recursor itself is not used by the system resolver! Default is 0 (not enabled). A suggested value is 60.
recursor.tcp_threads¶New in version 5.0.0.
1Spawn this number of TCP processing threads on startup.
recursor.threads¶2Spawn this number of threads on startup.
recursor.version_string¶*runtime determined*By default, PowerDNS replies to the ‘version.bind’ query with its version number. Security conscious users may wish to override the reply PowerDNS issues.
recursor.write_pid¶trueIf a PID file should be written to recursor.socket_dir
snmp.agent¶New in version 4.1.0.
falseIf set to true and PowerDNS has been compiled with SNMP support, it will register as an SNMP agent to provide statistics and be able to send traps.
snmp.daemon_socket¶New in version 4.5.0.
If not empty and snmp-agent is set to true, indicates how PowerDNS should contact the SNMP daemon to register as an SNMP agent.
webservice.address¶127.0.0.1IP address for the webserver to listen on.
webservice.allow_from¶Changed in version 4.1.0: Default is now 127.0.0.1,::1, was 0.0.0.0/0,::/0 before.
[127.0.0.1, '::1']These IPs and subnets are allowed to access the webserver. Note that specifying an IP address without a netmask uses an implicit netmask of /32 or /128.
webservice.api_dir¶New in version 4.0.0.
Directory where the REST API stores its configuration and zones. For configuration updates to work, recursor.include_dir should have the same value when using old-style settings. When using YAML settings recursor.include_dir and webservice.api_dir must have a different value.
webservice.api_key¶New in version 4.0.0.
Changed in version 4.6.0: This setting now accepts a hashed and salted version.
Static pre-shared authentication key for access to the REST API. Since 4.6.0 the key can be hashed and salted using rec_control hash-password instead of being stored in the configuration in plaintext, but the plaintext version is still supported.
webservice.hash_plaintext_credentials¶New in version 4.6.0.
falseWhether passwords and API keys supplied in the configuration as plaintext should be hashed during startup, to prevent the plaintext versions from staying in memory. Doing so increases significantly the cost of verifying credentials and is thus disabled by default. Note that this option only applies to credentials stored in the configuration as plaintext, but hashed credentials are supported without enabling this option.
webservice.loglevel¶New in version 4.2.0.
normalOne of none, normal, detailed.
The amount of logging the webserver must do. ‘none’ means no useful webserver information will be logged.
When set to ‘normal’, the webserver will log a line per request that should be familiar:
[webserver] e235780e-a5cf-415e-9326-9d33383e739e 127.0.0.1:55376 'GET /api/v1/servers/localhost/bla HTTP/1.1' 404 196
When set to ‘detailed’, all information about the request and response are logged:
[webserver] e235780e-a5cf-415e-9326-9d33383e739e Request Details:
[webserver] e235780e-a5cf-415e-9326-9d33383e739e Headers:
[webserver] e235780e-a5cf-415e-9326-9d33383e739e accept: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8
[webserver] e235780e-a5cf-415e-9326-9d33383e739e accept-encoding: gzip, deflate
[webserver] e235780e-a5cf-415e-9326-9d33383e739e accept-language: en-US,en;q=0.5
[webserver] e235780e-a5cf-415e-9326-9d33383e739e connection: keep-alive
[webserver] e235780e-a5cf-415e-9326-9d33383e739e dnt: 1
[webserver] e235780e-a5cf-415e-9326-9d33383e739e host: 127.0.0.1:8081
[webserver] e235780e-a5cf-415e-9326-9d33383e739e upgrade-insecure-requests: 1
[webserver] e235780e-a5cf-415e-9326-9d33383e739e user-agent: Mozilla/5.0 (X11; Linux x86_64; rv:64.0) Gecko/20100101 Firefox/64.0
[webserver] e235780e-a5cf-415e-9326-9d33383e739e No body
[webserver] e235780e-a5cf-415e-9326-9d33383e739e Response details:
[webserver] e235780e-a5cf-415e-9326-9d33383e739e Headers:
[webserver] e235780e-a5cf-415e-9326-9d33383e739e Connection: close
[webserver] e235780e-a5cf-415e-9326-9d33383e739e Content-Length: 49
[webserver] e235780e-a5cf-415e-9326-9d33383e739e Content-Type: text/html; charset=utf-8
[webserver] e235780e-a5cf-415e-9326-9d33383e739e Server: PowerDNS/0.0.15896.0.gaba8bab3ab
[webserver] e235780e-a5cf-415e-9326-9d33383e739e Full body:
[webserver] e235780e-a5cf-415e-9326-9d33383e739e <!html><title>Not Found</title><h1>Not Found</h1>
[webserver] e235780e-a5cf-415e-9326-9d33383e739e 127.0.0.1:55376 'GET /api/v1/servers/localhost/bla HTTP/1.1' 404 196
The value between the hooks is a UUID that is generated for each request. This can be used to find all lines related to a single request.
Note
The webserver logs these line on the NOTICE level. The logging.loglevel seting must be 5 or higher for these lines to end up in the log.
webservice.password¶Changed in version 4.6.0: This setting now accepts a hashed and salted version.
Password required to access the webserver. Since 4.6.0 the password can be hashed and salted using rec_control hash-password instead of being present in the configuration in plaintext, but the plaintext version is still supported.
webservice.port¶8082TCP port where the webserver should listen on.