1 Authoritative Server Settings
2 =============================
4 All PowerDNS Authoritative Server settings are listed here, excluding
5 those that originate from backends, which are documented in the relevant
6 chapters. These settings can be set inside ``pdns.conf`` or on the
7 commandline when invoking the ``pdns`` binary.
9 You can use ``+=`` syntax to set some variables incrementally, but this
10 requires you to have at least one non-incremental setting for the
11 variable to act as base setting. This is mostly useful for
12 :ref:`setting-include-dir` directive.
14 For boolean settings, specifying the name of the setting without a value
25 .. versionadded:: 4.0.0
27 Allow 8 bit DNS queries.
29 .. _setting-allow-axfr-ips:
34 - IP ranges, separated by commas
35 - Default: 127.0.0.0/8,::1
37 If set, only these IP addresses or netmasks will be able to perform
40 .. _setting-allow-dnsupdate-from:
42 ``allow-dnsupdate-from``
43 ------------------------
45 - IP ranges, separated by commas
46 - Default: 127.0.0.0/8,::1
48 Allow DNS updates from these IP ranges. Set to empty string to honour ``ALLOW-DNSUPDATE-FROM`` in :ref:`metadata-allow-dnsupdate-from`.
50 .. _setting-allow-notify-from:
55 - IP ranges, separated by commas
56 - Default: 0.0.0.0/0,::/0
58 Allow AXFR NOTIFY from these IP ranges. Setting this to an empty string
59 will drop all incoming notifies.
61 .. _setting-allow-recursion:
66 - IP ranges, separated by commas
70 Recursion has been removed, see :doc:`guides/recursion`
72 By specifying ``allow-recursion``, recursion can be restricted to
73 netmasks specified. The default is to allow recursion from everywhere.
74 Example: ``allow-recursion=198.51.100.0/24, 10.0.0.0/8, 192.0.2.4``.
76 .. _setting-allow-unsigned-notify:
78 ``allow-unsigned-notify``
79 -------------------------
84 .. versionadded:: 4.0.0
86 Turning this off requires all notifications that are received to be
87 signed by valid TSIG signature for the zone.
89 .. _setting-allow-unsigned-supermaster:
91 ``allow-unsigned-supermaster``
92 ------------------------------
97 .. versionadded:: 4.0.0
99 Turning this off requires all supermaster notifications to be signed by
100 valid TSIG signature. It will accept any existing key on slave.
102 .. _setting-also-notify:
107 - IP addresses, separated by commas
109 When notifying a domain, also notify these nameservers. Example:
110 ``also-notify=192.0.2.1, 203.0.113.167``. The IP addresses listed in
111 ``also-notify`` always receive a notification. Even if they do not match
112 the list in :ref:`setting-only-notify`.
114 .. _setting-any-to-tcp:
122 .. versionchanged:: 4.0.1
125 Answer questions for the ANY on UDP with a truncated packet that refers
126 the remote server to TCP. Useful for mitigating reflection attacks.
136 Enable/disable the :doc:`http-api/index`.
145 .. versionadded:: 4.0.0
147 Static pre-shared authentication key for access to the REST API.
149 .. _setting-api-readonly:
157 .. versionadded:: 4.0.0
158 .. versionchanged:: 4.2.0
159 This setting has been removed in 4.2.0.
161 Disallow data modification through the REST API when set.
163 .. _setting-axfr-lower-serial:
165 ``axfr-lower-serial``
166 ---------------------
171 .. versionadded:: 4.0.4
173 Also AXFR a zone from a master with a lower serial.
175 .. _setting-cache-ttl:
183 Seconds to store packets in the :ref:`packet-cache`. A value of 0 will disable the cache.
185 .. _setting-carbon-instance:
193 .. versionadded:: 4.2.0
195 Set the instance or third string of the metric key. Be careful not to include
196 any dots in this setting, unless you know what you are doing.
197 See :ref:`metricscarbon`
199 .. _setting-carbon-interval:
207 If sending carbon updates, this is the interval between them in seconds.
208 See :ref:`metricscarbon`.
210 .. _setting-carbon-namespace:
218 .. versionadded:: 4.2.0
220 Set the namespace or first string of the metric key. Be careful not to include
221 any dots in this setting, unless you know what you are doing.
222 See :ref:`metricscarbon`
224 .. _setting-carbon-ourname:
230 - Default: the hostname of the server
232 If sending carbon updates, if set, this will override our hostname. Be
233 careful not to include any dots in this setting, unless you know what
234 you are doing. See :ref:`metricscarbon`
236 .. _setting-carbon-server:
243 Send all available metrics to this server via the carbon protocol, which
244 is used by graphite and metronome. It has to be an address (no
245 hostnames). Moreover you can specify more than one server using a comma delimited list, ex:
246 carbon-server=10.10.10.10,10.10.10.20.
247 You may specify an alternate port by appending :port, ex:
248 127.0.0.1:2004. See :ref:`metricscarbon`.
257 If set, chroot to this directory for more security. See :doc:`security`.
259 Make sure that ``/dev/log`` is available from within the chroot. Logging
260 will silently fail over time otherwise (on logrotate).
262 When setting ``chroot``, all other paths in the config (except for
263 :ref:`setting-config-dir` and :ref:`setting-module-dir`)
264 set in the configuration are relative to the new root.
266 When running on a system where systemd manages services, ``chroot`` does
267 not work out of the box, as PowerDNS cannot use the ``NOTIFY_SOCKET``.
268 Either don't ``chroot`` on these systems or set the 'Type' of the this
269 service to 'simple' instead of 'notify' (refer to the systemd
270 documentation on how to modify unit-files)
272 .. _setting-config-dir:
279 Location of configuration directory (``pdns.conf``). Usually
280 ``/etc/powerdns``, but this depends on ``SYSCONFDIR`` during
283 .. _setting-config-name:
290 Name of this virtual configuration - will rename the binary image. See
291 :doc:`guides/virtual-instances`.
293 .. _setting-control-console:
298 Debugging switch - don't use.
310 .. _setting-default-api-rectify:
312 ``default-api-rectify``
313 -----------------------
317 .. versionadded:: 4.2.0
319 The value of :ref:`metadata-api-rectify` if it is not set on the zone.
322 Pre 4.2.0 the default was always no.
324 .. _setting-default-ksk-algorithms:
325 .. _setting-default-ksk-algorithm:
327 ``default-ksk-algorithm``
328 -------------------------
333 .. versionchanged:: 4.1.0
334 Renamed from ``default-ksk-algorithms``. No longer supports multiple algorithm names.
336 The algorithm that should be used for the KSK when running
337 :doc:`pdnsutil secure-zone <manpages/pdnsutil.1>` or using the :doc:`Zone API endpoint <http-api/cryptokey>`
338 to enable DNSSEC. Must be one of:
343 * ecdsa256 (ECDSA P-256 with SHA256)
344 * ecdsa384 (ECDSA P-384 with SHA384)
349 Actual supported algorithms depend on the crypto-libraries
350 PowerDNS was compiled against. To check the supported DNSSEC algoritms
351 in your build of PowerDNS, run ``pdnsutil list-algorithms``.
353 .. _setting-default-ksk-size:
359 - Default: whichever is default for `default-ksk-algorithm`_
361 The default keysize for the KSK generated with :doc:`pdnsutil secure-zone <dnssec/pdnsutil>`.
362 Only relevant for algorithms with non-fixed keysizes (like RSA).
364 .. _setting-default-soa-edit:
372 Use this soa-edit value for all zones if no
373 :ref:`metadata-soa-edit` metadata value is set.
375 .. _setting-default-soa-edit-signed:
377 ``default-soa-edit-signed``
378 ---------------------------
383 Use this soa-edit value for all signed zones if no
384 :ref:`metadata-soa-edit` metadata value is set.
385 Overrides :ref:`setting-default-soa-edit`
387 .. _setting-default-soa-mail:
394 .. deprecated:: 4.2.0
395 This setting has been deprecated and will be removed in 4.3.0
397 Mail address to insert in the SOA record if none set in the backend.
399 .. _setting-default-soa-name:
405 - Default: a.misconfigured.powerdns.server
407 .. deprecated:: 4.2.0
408 This setting has been deprecated and will be removed in 4.3.0
410 Name to insert in the SOA record if none set in the backend.
412 .. _setting-default-ttl:
420 TTL to use when none is provided.
422 .. _setting-default-zsk-algorithms:
423 .. _setting-default-zsk-algorithm:
425 ``default-zsk-algorithm``
426 --------------------------
431 .. versionchanged:: 4.1.0
432 Renamed from ``default-zsk-algorithms``. Does no longer support multiple algorithm names.
434 The algorithm that should be used for the ZSK when running
435 :doc:`pdnsutil secure-zone <manpages/pdnsutil.1>` or using the :doc:`Zone API endpoint <http-api/cryptokey>`
436 to enable DNSSEC. Must be one of:
441 * ecdsa256 (ECDSA P-256 with SHA256)
442 * ecdsa384 (ECDSA P-384 with SHA384)
447 Actual supported algorithms depend on the crypto-libraries
448 PowerDNS was compiled against. To check the supported DNSSEC algoritms
449 in your build of PowerDNS, run ``pdnsutil list-algorithms``.
451 .. _setting-default-zsk-size:
457 - Default: 0 (automatic default for `default-zsk-algorithm`_)
459 The default keysize for the ZSK generated with :doc:`pdnsutil secure-zone <dnssec/pdnsutil>`.
460 Only relevant for algorithms with non-fixed keysizes (like RSA).
462 .. _setting-direct-dnskey:
470 Read additional DNSKEY, CDS and CDNSKEY records from the records table/your BIND zonefile. If not
471 set, DNSKEY, CDS and CDNSKEY records in the zonefiles are ignored.
473 .. _setting-disable-axfr:
481 Do not allow zone transfers.
483 .. _setting-disable-axfr-rectify:
485 ``disable-axfr-rectify``
486 ------------------------
491 Disable the rectify step during an outgoing AXFR. Only required for
494 .. _setting-disable-syslog:
502 Do not log to syslog, only to stdout. Use this setting when running
503 inside a supervisor that handles logging (like systemd).
506 Do not use this setting in combination with :ref:`setting-daemon` as all
507 logging will disappear.
509 .. _setting-disable-tcp:
517 .. versionchanged:: 4.2.0
518 This setting has been removed
520 Do not listen to TCP queries. Breaks RFC compliance.
522 .. _setting-distributor-threads:
524 ``distributor-threads``
525 -----------------------
530 Number of Distributor (backend) threads to start per receiver thread.
531 See :doc:`performance`.
533 .. _setting-dname-processing:
541 Synthesise CNAME records from DNAME records as required. This
542 approximately doubles query load. **Do not combine with DNSSEC!**
544 .. _setting-dnssec-key-cache-ttl:
546 ``dnssec-key-cache-ttl``
547 ------------------------
552 Seconds to cache DNSSEC keys from the database. A value of 0 disables
555 .. _setting-dnsupdate:
563 Enable/Disable DNS update (RFC2136) support. See :doc:`dnsupdate` for more.
565 .. _setting-do-ipv6-additional-processing:
567 ``do-ipv6-additional-processing``
568 ---------------------------------
573 Perform AAAA additional processing. This sends AAAA records in the
574 ADDITIONAL section when sending a referral.
576 .. _setting-domain-metadata-cache-ttl:
578 ``domain-metadata-cache-ttl``
579 -----------------------------
584 Seconds to cache domain metadata from the database. A value of 0
587 .. _setting-edns-subnet-processing:
589 ``edns-subnet-processing``
590 --------------------------
595 Enables EDNS subnet processing, for backends that support it.
597 .. _setting-enable-lua-records:
599 ``enable-lua-records``
600 ----------------------
602 - One of ``no``, ``yes`` (or empty), or ``shared``, String
605 .. versionadded:: 4.2.0
607 Globally enable the :doc:`LUA records <lua-records/index>` feature.
609 To use shared LUA states, set this to ``shared``, see :ref:`lua-records-shared-state`.
611 .. _setting-entropy-source:
617 - Default: /dev/urandom
619 Entropy source file to use.
621 .. _setting-expand-alias:
629 .. versionadded:: 4.1.0
631 If this is enabled, ALIAS records are expanded (synthesised to their
634 If this is disabled (the default), ALIAS records will not be expanded and
635 the server will will return NODATA for A/AAAA queries for such names.
638 :ref:`setting-resolver` must also be set for ALIAS expansion to work!
641 In PowerDNS Authoritative Server 4.0.x, this setting did not exist and
642 ALIAS was always expanded.
644 .. _setting-forward-dnsupdate:
646 ``forward-dnsupdate``
647 ---------------------
652 Forward DNS updates sent to a slave to the master.
654 .. _setting-forward-notify:
659 - IP addresses, separated by commas
661 IP addresses to forward received notifications to regardless of master
665 The intended use is in anycast environments where it might be
666 necessary for a proxy server to perform the AXFR. The usual checks are
667 performed before any received notification is forwarded.
669 .. _setting-guardian:
677 Run within a guardian process. See :ref:`running-guardian`.
679 .. _setting-include-dir:
686 Directory to scan for additional config files. All files that end with
687 .conf are loaded in order using ``POSIX`` as locale.
694 - Backend names, separated by commas
696 Which backends to launch and order to query them in. Launches backends.
697 In its most simple form, supply all backends that need to be launched.
702 launch=bind,gmysql,remote
704 If you find that you need to query a backend multiple times with
705 different configuration, you can specify a name for later
706 instantiations. e.g.:
710 launch=gmysql,gmysql:server2
712 In this case, there are 2 instances of the gmysql backend, one by the
713 normal name and the second one is called 'server2'. The backend
714 configuration item names change: e.g. ``gmysql-host`` is available to
715 configure the ``host`` setting of the first or main instance, and
716 ``gmysql-server2-host`` for the second one.
718 Running multiple instances of the BIND backend is not allowed.
720 .. _setting-load-modules:
725 - Paths, separated by commas
727 If backends are available in nonstandard directories, specify their
728 location here. Multiple files can be loaded if separated by commas. Only
729 available in non-static distributions.
731 .. _setting-local-address:
736 - IPv4 Addresses, separated by commas or whitespace
739 Local IP address to which we bind. It is highly advised to bind to
740 specific interfaces and not use the default 'bind to any'. This causes
741 big problems if you have multiple IP addresses. Unix does not provide a
742 way of figuring out what IP address a packet was sent to when binding to
745 .. _setting-local-address-nonexist-fail:
747 ``local-address-nonexist-fail``
748 -------------------------------
753 Fail to start if one or more of the
754 :ref:`setting-local-address`'s do not exist on this server.
756 .. _setting-local-ipv6:
761 - IPv6 Addresses, separated by commas or whitespace
764 Local IPv6 address to which we bind. It is highly advised to bind to
765 specific interfaces and not use the default 'bind to any'. This causes
766 big problems if you have multiple IP addresses.
768 .. _setting-local-ipv6-nonexist-fail:
770 ``local-ipv6-nonexist-fail``
771 ----------------------------
776 Fail to start if one or more of the :ref:`setting-local-ipv6`
777 addresses do not exist on this server.
779 .. _setting-local-port:
787 The port on which we listen. Only one port possible.
789 .. _setting-log-dns-details:
797 If set to 'no', informative-only DNS details will not even be sent to
798 syslog, improving performance.
800 .. _setting-log-dns-queries:
808 Tell PowerDNS to log all incoming DNS queries. This will lead to a lot
809 of logging! Only enable for debugging! Set :ref:`setting-loglevel`
810 to at least 5 to see the logs.
812 .. _setting-log-timestamp:
820 .. versionadded:: 4.1.0
822 When printing log lines to stdout, prefix them with timestamps.
823 Disable this if the process supervisor timestamps these lines already.
826 The systemd unit file supplied with the source code already disables timestamp printing
828 .. _setting-logging-facility:
833 If set to a digit, logging is performed under this LOCAL facility. See :ref:`logging-to-syslog`.
834 Do not pass names like 'local0'!
836 .. _setting-loglevel:
844 Amount of logging. Higher is more. Do not set below 3. Corresponds to "syslog" level values,
845 e.g. error = 3, warning = 4, notice = 5, info = 6
847 .. _setting-lua-axfr-script:
855 .. versionadded:: 4.1.0
857 Script to be used to edit incoming AXFRs, see :ref:`modes-of-operation-axfrfilter`
859 .. _setting-lua-prequery-script:
861 ``lua-prequery-script``
862 -----------------------
866 Lua script to run before answering a query. This is a feature used
867 internally for regression testing. The API of this functionality is not
868 guaranteed to be stable, and is in fact likely to change.
870 .. _setting-lua-records-exec-limit:
872 ``lua-records-exec-limit``
873 -----------------------------
878 Limit LUA records scripts to ``lua-records-exec-limit`` instructions.
879 Setting this to any value less than or equal to 0 will set no limit.
889 Turn on master support. See :ref:`master-operation`.
891 .. _setting-max-cache-entries:
893 ``max-cache-entries``
894 ---------------------
899 .. versionchanged:: 4.1.0
900 The packet and query caches are distinct. Previously, this setting was used for
901 both the packet and query caches. See :ref:`setting-max-packet-cache-entries` for
902 the packet-cache setting.
904 Maximum number of entries in the query cache. 1 million (the default)
905 will generally suffice for most installations.
907 .. _setting-max-ent-entries:
915 Maximum number of empty non-terminals to add to a zone. This is a
916 protection measure to avoid database explosion due to long names.
918 .. _setting-max-nsec3-iterations:
920 ``max-nsec3-iterations``
921 ------------------------
926 Limit the number of NSEC3 hash iterations for zone configurations.
927 For more information see :ref:`dnssec-operational-nsec-modes-params`.
929 .. _setting-max-packet-cache-entries:
931 ``max-packet-cache-entries``
932 ----------------------------
937 .. versionadded:: 4.1.0
939 Maximum number of entries in the packet cache. 1 million (the default)
940 will generally suffice for most installations.
942 .. _setting-max-queue-length:
950 If this many packets are waiting for database attention, consider the
951 situation hopeless and respawn.
953 .. _setting-max-signature-cache-entries:
955 ``max-signature-cache-entries``
956 -------------------------------
959 - Default: 2^31-1 (on most systems), 2^63-1 (on ILP64 systems)
961 Maximum number of signatures cache entries
963 .. _setting-max-tcp-connection-duration:
965 ``max-tcp-connection-duration``
966 -------------------------------
971 Maximum time in seconds that a TCP DNS connection is allowed to stay
972 open. 0 means unlimited. Note that exchanges related to an AXFR or IXFR
973 are not affected by this setting.
975 .. _setting-max-tcp-connections:
977 ``max-tcp-connections``
978 -----------------------
983 Allow this many incoming TCP DNS connections simultaneously.
985 .. _setting-max-tcp-connections-per-client:
987 ``max-tcp-connections-per-client``
988 ----------------------------------
993 Maximum number of simultaneous TCP connections per client. 0 means
996 .. _setting-max-tcp-transactions-per-conn:
998 ``max-tcp-transactions-per-conn``
999 ---------------------------------
1004 Allow this many DNS queries in a single TCP transaction. 0 means
1005 unlimited. Note that exchanges related to an AXFR or IXFR are not
1006 affected by this setting.
1008 .. _setting-module-dir:
1015 Directory for modules. Default depends on ``PKGLIBDIR`` during
1018 .. _setting-negquery-cache-ttl:
1020 ``negquery-cache-ttl``
1021 ----------------------
1026 Seconds to store queries with no answer in the Query Cache. See :ref:`query-cache`.
1028 .. _setting-no-config:
1036 Do not attempt to read the configuration file. Useful for configuration
1037 by parameters from the command line only.
1039 .. _setting-no-shuffle:
1047 Do not attempt to shuffle query results, used for regression testing.
1049 .. _setting-non-local-bind:
1057 Bind to addresses even if one or more of the
1058 :ref:`setting-local-address`'s do not exist on this server.
1059 Setting this option will enable the needed socket options to allow
1060 binding to non-local addresses. This feature is intended to facilitate
1061 ip-failover setups, but it may also mask configuration issues and for
1062 this reason it is disabled by default.
1064 .. _setting-only-notify:
1069 - IP Ranges, separated by commas or whitespace
1070 - Default: 0.0.0.0/0, ::/0
1072 For type=MASTER zones (or SLAVE zones with slave-renotify enabled)
1073 PowerDNS automatically sends NOTIFYs to the name servers specified in
1074 the NS records. By specifying networks/mask as whitelist, the targets
1075 can be limited. The default is to notify the world. To completely
1076 disable these NOTIFYs set ``only-notify`` to an empty value. Independent
1077 of this setting, the IP addresses or netmasks configured with
1078 :ref:`setting-also-notify` and ``ALSO-NOTIFY`` domain metadata
1079 always receive AXFR NOTIFYs.
1081 IP addresses and netmasks can be excluded by prefixing them with a ``!``.
1082 To notify all IP addresses apart from the 192.168.0.0/24 subnet use the following::
1084 only-notify=0.0.0.0/0, ::/0, !192.168.0.0/24
1087 Even if NOTIFYs are limited by a netmask, PowerDNS first has to
1088 resolve all the hostnames to check their IP addresses against the
1089 specified whitelist. The resolving may take considerable time,
1090 especially if those hostnames are slow to resolve. If you do not need to
1091 NOTIFY the slaves defined in the NS records (e.g. you are using another
1092 method to distribute the zone data to the slaves), then set
1093 :ref:`setting-only-notify` to an empty value and specify the notification targets
1094 explicitly using :ref:`setting-also-notify` and/or
1095 :ref:`metadata-also-notify` domain metadata to avoid this potential bottleneck.
1098 If your slaves support an Internet Protocol version, which your master does not,
1099 then set ``only-notify`` to include only supported protocol version.
1100 Otherwise there will be error trying to resolve address.
1102 For example, slaves support both IPv4 and IPv6, but PowerDNS master have only IPv4,
1103 so allow only IPv4 with ``only-notify``:
1107 only-notify=0.0.0.0/0
1109 .. _setting-out-of-zone-additional-processing:
1111 ``out-of-zone-additional-processing``
1112 -------------------------------------
1117 .. deprecated:: 4.2.0
1118 This setting has been removed.
1120 Do out of zone additional processing. This means that if a malicious
1121 user adds a '.com' zone to your server, it is not used for other domains
1122 and will not contaminate answers. Do not enable this setting if you run
1123 a public DNS service with untrusted users.
1125 The docs had previously indicated that the default was "no", but the
1126 default has been "yes" since 2005.
1128 .. _setting-outgoing-axfr-expand-alias:
1130 ``outgoing-axfr-expand-alias``
1131 ------------------------------
1136 If this is enabled, ALIAS records are expanded (synthesised to their
1137 A/AAAA) during outgoing AXFR. This means slaves will not automatically
1138 follow changes in those A/AAAA records unless you AXFR regularly!
1140 If this is disabled (the default), ALIAS records are sent verbatim
1141 during outgoing AXFR. Note that if your slaves do not support ALIAS,
1142 they will return NODATA for A/AAAA queries for such names.
1144 .. _setting-overload-queue-length:
1146 ``overload-queue-length``
1147 -------------------------
1150 - Default: 0 (disabled)
1152 If this many packets are waiting for database attention, answer any new
1153 questions strictly from the packet cache.
1155 .. _setting-prevent-self-notification:
1157 ``prevent-self-notification``
1158 -----------------------------
1163 PowerDNS Authoritative Server attempts to not send out notifications to
1164 itself in master mode. In very complicated situations we could guess
1165 wrong and not notify a server that should be notified. In that case, set
1166 prevent-self-notification to "no".
1168 .. _setting-query-cache-ttl:
1176 Seconds to store queries with an answer in the Query Cache. See :ref:`query-cache`.
1178 .. _setting-query-local-address:
1180 ``query-local-address``
1181 -----------------------
1186 The IP address to use as a source address for sending queries. Useful if
1187 you have multiple IPs and PowerDNS is not bound to the IP address your
1188 operating system uses by default for outgoing packets.
1190 .. _setting-query-local-address6:
1192 ``query-local-address6``
1193 ------------------------
1198 Source IP address for sending IPv6 queries.
1200 .. _setting-query-logging:
1208 Boolean, hints to a backend that it should log a textual representation
1209 of queries it performs. Can be set at runtime.
1211 .. _setting-queue-limit:
1219 Maximum number of milliseconds to queue a query. See :doc:`performance`.
1221 .. _setting-receiver-threads:
1223 ``receiver-threads``
1224 --------------------
1229 Number of receiver (listening) threads to start. See :doc:`performance`.
1231 .. _setting-recursive-cache-ttl:
1233 ``recursive-cache-ttl``
1234 -----------------------
1239 .. deprecated:: 4.1.0
1240 Recursion has been removed, see :doc:`guides/recursion`
1242 Seconds to store recursive packets in the :ref:`packet-cache`.
1244 .. _setting-recursor:
1251 .. deprecated:: 4.1.0
1252 Recursion has been removed, see :doc:`guides/recursion`
1254 If set, recursive queries will be handed to the recursor specified here.
1256 .. _setting-resolver:
1261 - IP Addresses with optional port, separated by commas
1263 .. versionadded:: 4.1.0
1265 Use these resolver addresses for ALIAS and the internal stub resolver.
1266 If this is not set, ``/etc/resolv.conf`` is parsed for upstream
1269 .. _setting-retrieval-threads:
1271 ``retrieval-threads``
1272 ---------------------
1277 Number of AXFR slave threads to start.
1279 .. _setting-reuseport:
1287 On Linux 3.9 and some BSD kernels the ``SO_REUSEPORT`` option allows
1288 each receiver-thread to open a new socket on the same port which allows
1289 for much higher performance on multi-core boxes. Setting this option
1290 will enable use of ``SO_REUSEPORT`` when available and seamlessly fall
1291 back to a single socket when it is not available. A side-effect is that
1292 you can start multiple servers on the same IP/port combination which may
1293 or may not be a good idea. You could use this to enable transparent
1294 restarts, but it may also mask configuration issues and for this reason
1295 it is disabled by default.
1305 Specify which random number generator to use. Permissible choises are:
1307 - auto - choose automatically
1308 - sodium - Use libsodium ``randombytes_uniform``
1309 - openssl - Use libcrypto ``RAND_bytes``
1310 - getrandom - Use libc getrandom, falls back to urandom if it does not really work
1311 - arc4random - Use BSD ``arc4random_uniform``
1312 - urandom - Use ``/dev/urandom``
1313 - kiss - Use simple settable deterministic RNG. **FOR TESTING PURPOSES ONLY!**
1316 Not all choises are available on all systems.
1318 .. _setting-security-poll-suffix:
1320 ``security-poll-suffix``
1321 ------------------------
1324 - Default: secpoll.powerdns.com.
1326 Domain name from which to query security update notifications. Setting
1327 this to an empty string disables secpoll.
1329 .. _setting-send-signed-notify:
1331 ``send-signed-notify``
1332 ----------------------
1337 If yes, outgoing NOTIFYs will be signed if a TSIG key is configured for the zone.
1338 If there are multiple TSIG keys configured for a domain, PowerDNS will use the
1339 first one retrieved from the backend, which may not be the correct one for the
1340 respective slave. Hence, in setups with multiple slaves with different TSIG keys
1341 it may be required to send NOTIFYs unsigned.
1343 .. _setting-server-id:
1349 - Default: The hostname of the server
1351 This is the server ID that will be returned on an EDNS NSID query.
1360 If set, change group id to this gid for more security. See :doc:`security`.
1369 If set, change user id to this uid for more security. See :doc:`security`.
1371 .. _setting-signing-threads:
1379 Tell PowerDNS how many threads to use for signing. It might help improve
1380 signing speed by changing this number.
1390 Turn on slave support. See :ref:`slave-operation`.
1392 .. _setting-slave-cycle-interval:
1394 ``slave-cycle-interval``
1395 ------------------------
1400 On a master, this is the amount of seconds between the master checking
1401 the SOA serials in its database to determine to send out NOTIFYs to the
1402 slaves. On slaves, this is the number of seconds between the slave
1403 checking for updates to zones.
1405 .. _setting-slave-renotify:
1413 This setting will make PowerDNS renotify the slaves after an AXFR is
1414 *received* from a master. This is useful when using when running a
1417 .. _setting-soa-expire-default:
1419 ``soa-expire-default``
1420 ----------------------
1425 .. deprecated:: 4.2.0
1426 This setting has been deprecated and will be removed in 4.3.0
1428 Default :ref:`types-soa` expire.
1430 .. _setting-soa-minimum-ttl:
1438 .. deprecated:: 4.2.0
1439 This setting has been deprecated and will be removed in 4.3.0
1441 Default :ref:`types-soa` minimum ttl.
1443 .. _setting-soa-refresh-default:
1445 ``soa-refresh-default``
1446 -----------------------
1451 .. deprecated:: 4.2.0
1452 This setting has been deprecated and will be removed in 4.3.0
1454 Default :ref:`types-soa` refresh.
1456 .. _setting-soa-retry-default:
1458 ``soa-retry-default``
1459 ---------------------
1464 .. deprecated:: 4.2.0
1465 This setting has been deprecated and will be removed in 4.3.0
1467 Default :ref:`types-soa` retry.
1469 .. _setting-socket-dir:
1476 Where the controlsocket will live. The default depends on
1477 ``LOCALSTATEDIR`` during compile-time (usually ``/var/run`` or
1478 ``/run``). See :ref:`control-socket`.
1480 This path will also contain the pidfile for this instance of PowerDNS
1481 called ``pdns.pid`` by default. See :ref:`setting-config-name`
1482 and :doc:`Virtual Hosting <guides/virtual-instances>` how this can differ.
1484 .. _setting-superslave:
1492 .. versionadded:: 4.1.9
1493 In versions before 4.1.9, this setting did not exist and supermaster support
1494 was enabled by default.
1496 .. versionchanged:: 4.2.0
1497 Before 4.2.0, the default was yes.
1499 Turn on supermaster support. See :ref:`supermaster-operation`.
1501 .. _setting-tcp-control-address:
1503 ``tcp-control-address``
1504 -----------------------
1508 Address to bind to for TCP control.
1510 .. _setting-tcp-control-port:
1512 ``tcp-control-port``
1513 --------------------
1518 Port to bind to for TCP control.
1520 .. _setting-tcp-control-range:
1522 ``tcp-control-range``
1523 ---------------------
1525 - IP Ranges, separated by commas or whitespace
1527 Limit TCP control to a specific client range.
1529 .. _setting-tcp-control-secret:
1531 ``tcp-control-secret``
1532 ----------------------
1536 Password for TCP control.
1538 .. _setting-tcp-fast-open:
1544 - Default: 0 (Disabled)
1546 .. versionadded:: 4.1.0
1548 Enable TCP Fast Open support, if available, on the listening sockets.
1549 The numerical value supplied is used as the queue size, 0 meaning
1552 .. _setting-tcp-idle-timeout:
1554 ``tcp-idle-timeout``
1555 --------------------
1560 Maximum time in seconds that a TCP DNS connection is allowed to stay
1561 open while being idle, meaning without PowerDNS receiving or sending
1564 .. _setting-traceback-handler:
1566 ``traceback-handler``
1567 ---------------------
1572 Enable the Linux-only traceback handler.
1574 .. _setting-trusted-notification-proxy:
1576 ``trusted-notification-proxy``
1577 ------------------------------
1581 IP address of incoming notification proxy
1583 .. _setting-udp-truncation-threshold:
1585 ``udp-truncation-threshold``
1586 ----------------------------
1587 .. versionchanged:: 4.2.0
1588 Before 4.2.0, the default was 1680
1593 EDNS0 allows for large UDP response datagrams, which can potentially
1594 raise performance. Large responses however also have downsides in terms
1595 of reflection attacks. Maximum value is 65535, but values above
1596 4096 should probably not be attempted.
1600 1232 is the largest number of payload bytes that can fit in the smallest IPv6 packet.
1601 IPv6 has a minimum MTU of 1280 bytes (:rfc:`RFC 8200, section 5 <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.
1603 .. _setting-version-string:
1608 - Any of: ``anonymous``, ``powerdns``, ``full``, String
1611 When queried for its version over DNS
1612 (``dig chaos txt version.bind @pdns.ip.address``), PowerDNS normally
1613 responds truthfully. With this setting you can overrule what will be
1614 returned. Set the ``version-string`` to ``full`` to get the default
1615 behaviour, to ``powerdns`` to just make it state
1616 ``Served by PowerDNS - https://www.powerdns.com/``. The ``anonymous``
1617 setting will return a ServFail, much like Microsoft nameservers do. You
1618 can set this response to a custom value as well.
1620 .. _setting-webserver:
1628 Start a webserver for monitoring. See :doc:`performance`".
1630 .. versionchanged:: 4.1.0
1631 It was necessary to enable the webserver to use the REST API, this is no longer the case.
1633 .. _setting-webserver-address:
1635 ``webserver-address``
1636 ---------------------
1639 - Default: 127.0.0.1
1641 IP Address for webserver/API to listen on.
1643 .. _setting-webserver-allow-from:
1645 ``webserver-allow-from``
1646 ------------------------
1648 - IP ranges, separated by commas or whitespace
1649 - Default: 127.0.0.1,::1
1651 .. versionchanged:: 4.1.0
1653 Default is now 127.0.0.1,::1, was 0.0.0.0/0,::/0 before.
1655 Webserver/API access is only allowed from these subnets.
1657 .. _setting-webserver-loglevel:
1659 ``webserver-loglevel``
1660 ----------------------
1661 .. versionadded:: 4.2.0
1663 - String, one of "none", "normal", "detailed"
1665 The amount of logging the webserver must do. "none" means no useful webserver information will be logged.
1666 When set to "normal", the webserver will log a line per request that should be familiar::
1668 [webserver] e235780e-a5cf-415e-9326-9d33383e739e 127.0.0.1:55376 "GET /api/v1/servers/localhost/bla HTTP/1.1" 404 196
1670 When set to "detailed", all information about the request and response are logged::
1672 [webserver] e235780e-a5cf-415e-9326-9d33383e739e Request Details:
1673 [webserver] e235780e-a5cf-415e-9326-9d33383e739e Headers:
1674 [webserver] e235780e-a5cf-415e-9326-9d33383e739e accept: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8
1675 [webserver] e235780e-a5cf-415e-9326-9d33383e739e accept-encoding: gzip, deflate
1676 [webserver] e235780e-a5cf-415e-9326-9d33383e739e accept-language: en-US,en;q=0.5
1677 [webserver] e235780e-a5cf-415e-9326-9d33383e739e connection: keep-alive
1678 [webserver] e235780e-a5cf-415e-9326-9d33383e739e dnt: 1
1679 [webserver] e235780e-a5cf-415e-9326-9d33383e739e host: 127.0.0.1:8081
1680 [webserver] e235780e-a5cf-415e-9326-9d33383e739e upgrade-insecure-requests: 1
1681 [webserver] e235780e-a5cf-415e-9326-9d33383e739e user-agent: Mozilla/5.0 (X11; Linux x86_64; rv:64.0) Gecko/20100101 Firefox/64.0
1682 [webserver] e235780e-a5cf-415e-9326-9d33383e739e No body
1683 [webserver] e235780e-a5cf-415e-9326-9d33383e739e Response details:
1684 [webserver] e235780e-a5cf-415e-9326-9d33383e739e Headers:
1685 [webserver] e235780e-a5cf-415e-9326-9d33383e739e Connection: close
1686 [webserver] e235780e-a5cf-415e-9326-9d33383e739e Content-Length: 49
1687 [webserver] e235780e-a5cf-415e-9326-9d33383e739e Content-Type: text/html; charset=utf-8
1688 [webserver] e235780e-a5cf-415e-9326-9d33383e739e Server: PowerDNS/0.0.15896.0.gaba8bab3ab
1689 [webserver] e235780e-a5cf-415e-9326-9d33383e739e Full body:
1690 [webserver] e235780e-a5cf-415e-9326-9d33383e739e <!html><title>Not Found</title><h1>Not Found</h1>
1691 [webserver] e235780e-a5cf-415e-9326-9d33383e739e 127.0.0.1:55376 "GET /api/v1/servers/localhost/bla HTTP/1.1" 404 196
1693 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.
1696 The webserver logs these line on the NOTICE level. The :ref:`setting-loglevel` seting must be 5 or higher for these lines to end up in the log.
1698 .. _setting-webserver-max-bodysize:
1700 ``webserver-max-bodysize``
1701 --------------------------
1702 .. versionadded:: 4.2.0
1707 Maximum request/response body size in megabytes.
1709 .. _setting-webserver-password:
1711 ``webserver-password``
1712 ----------------------
1716 The plaintext password required for accessing the webserver.
1718 .. _setting-webserver-port:
1726 The port where webserver/API will listen on.
1728 .. _setting-webserver-print-arguments:
1730 ``webserver-print-arguments``
1731 -----------------------------
1736 If the webserver should print arguments.
1738 .. _setting-write-pid:
1746 If a PID file should be written.
1748 .. _setting-xfr-max-received-mbytes:
1750 ``xfr-max-received-mbytes``
1751 ---------------------------
1756 Specifies the maximum number of received megabytes allowed on an
1757 incoming AXFR/IXFR update, to prevent resource exhaustion. A value of 0
1758 means no restriction.
projects / thirdparty / pdns.git / blob