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`.
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 Mail address to insert in the SOA record if none set in the backend.
396 .. _setting-default-soa-name:
402 - Default: a.misconfigured.powerdns.server
404 Name to insert in the SOA record if none set in the backend.
406 .. _setting-default-ttl:
414 TTL to use when none is provided.
416 .. _setting-default-zsk-algorithms:
417 .. _setting-default-zsk-algorithm:
419 ``default-zsk-algorithm``
420 --------------------------
425 .. versionchanged:: 4.1.0
426 Renamed from ``default-zsk-algorithms``. Does no longer support multiple algorithm names.
428 The algorithm that should be used for the ZSK when running
429 :doc:`pdnsutil secure-zone <manpages/pdnsutil.1>` or using the :doc:`Zone API endpoint <http-api/cryptokey>`
430 to enable DNSSEC. Must be one of:
435 * ecdsa256 (ECDSA P-256 with SHA256)
436 * ecdsa384 (ECDSA P-384 with SHA384)
441 Actual supported algorithms depend on the crypto-libraries
442 PowerDNS was compiled against. To check the supported DNSSEC algoritms
443 in your build of PowerDNS, run ``pdnsutil list-algorithms``.
445 .. _setting-default-zsk-size:
451 - Default: 0 (automatic default for `default-zsk-algorithm`_)
453 The default keysize for the ZSK generated with :doc:`pdnsutil secure-zone <dnssec/pdnsutil>`.
454 Only relevant for algorithms with non-fixed keysizes (like RSA).
456 .. _setting-direct-dnskey:
464 Read additional DNSKEY, CDS and CDNSKEY records from the records table/your BIND zonefile. If not
465 set, DNSKEY, CDS and CDNSKEY records in the zonefiles are ignored.
467 .. _setting-disable-axfr:
475 Do not allow zone transfers.
477 .. _setting-disable-axfr-rectify:
479 ``disable-axfr-rectify``
480 ------------------------
485 Disable the rectify step during an outgoing AXFR. Only required for
488 .. _setting-disable-syslog:
496 Do not log to syslog, only to stdout. Use this setting when running
497 inside a supervisor that handles logging (like systemd).
500 Do not use this setting in combination with :ref:`setting-daemon` as all
501 logging will disappear.
503 .. _setting-disable-tcp:
511 .. versionchanged:: 4.2.0
512 This setting has been removed
514 Do not listen to TCP queries. Breaks RFC compliance.
516 .. _setting-distributor-threads:
518 ``distributor-threads``
519 -----------------------
524 Number of Distributor (backend) threads to start per receiver thread.
525 See :doc:`performance`.
527 .. _setting-dname-processing:
535 Synthesise CNAME records from DNAME records as required. This
536 approximately doubles query load. **Do not combine with DNSSEC!**
538 .. _setting-dnssec-key-cache-ttl:
540 ``dnssec-key-cache-ttl``
541 ------------------------
546 Seconds to cache DNSSEC keys from the database. A value of 0 disables
549 .. _setting-dnsupdate:
557 Enable/Disable DNS update (RFC2136) support. See :doc:`dnsupdate` for more.
559 .. _setting-do-ipv6-additional-processing:
561 ``do-ipv6-additional-processing``
562 ---------------------------------
567 Perform AAAA additional processing. This sends AAAA records in the
568 ADDITIONAL section when sending a referral.
570 .. _setting-domain-metadata-cache-ttl:
572 ``domain-metadata-cache-ttl``
573 -----------------------------
578 Seconds to cache domain metadata from the database. A value of 0
581 .. _setting-edns-subnet-processing:
583 ``edns-subnet-processing``
584 --------------------------
589 Enables EDNS subnet processing, for backends that support it.
591 .. _setting-enable-lua-records:
593 ``enable-lua-records``
594 ----------------------
599 Enable globally the LUA records feature
601 .. _setting-entropy-source:
607 - Default: /dev/urandom
609 Entropy source file to use.
611 .. _setting-expand-alias:
619 .. versionadded:: 4.1.0
621 If this is enabled, ALIAS records are expanded (synthesised to their
624 If this is disabled (the default), ALIAS records will not be expanded and
625 the server will will return NODATA for A/AAAA queries for such names.
628 :ref:`setting-resolver` must also be set for ALIAS expansion to work!
631 In PowerDNS Authoritative Server 4.0.x, this setting did not exist and
632 ALIAS was always expanded.
634 .. _setting-forward-dnsupdate:
636 ``forward-dnsupdate``
637 ---------------------
642 Forward DNS updates sent to a slave to the master.
644 .. _setting-forward-notify:
649 - IP addresses, separated by commas
651 IP addresses to forward received notifications to regardless of master
655 The intended use is in anycast environments where it might be
656 necessary for a proxy server to perform the AXFR. The usual checks are
657 performed before any received notification is forwarded.
659 .. _setting-guardian:
667 Run within a guardian process. See :ref:`running-guardian`.
669 .. _setting-include-dir:
676 Directory to scan for additional config files. All files that end with
677 .conf are loaded in order using ``POSIX`` as locale.
684 - Backend names, separated by commas
686 Which backends to launch and order to query them in. Launches backends.
687 In its most simple form, supply all backends that need to be launched.
692 launch=bind,gmysql,remote
694 If you find that you need to query a backend multiple times with
695 different configuration, you can specify a name for later
696 instantiations. e.g.:
700 launch=gmysql,gmysql:server2
702 In this case, there are 2 instances of the gmysql backend, one by the
703 normal name and the second one is called 'server2'. The backend
704 configuration item names change: e.g. ``gmysql-host`` is available to
705 configure the ``host`` setting of the first or main instance, and
706 ``gmysql-server2-host`` for the second one.
708 Running multiple instances of the BIND backend is not allowed.
710 .. _setting-load-modules:
715 - Paths, separated by commas
717 If backends are available in nonstandard directories, specify their
718 location here. Multiple files can be loaded if separated by commas. Only
719 available in non-static distributions.
721 .. _setting-local-address:
726 - IPv4 Addresses, separated by commas or whitespace
729 Local IP address to which we bind. It is highly advised to bind to
730 specific interfaces and not use the default 'bind to any'. This causes
731 big problems if you have multiple IP addresses. Unix does not provide a
732 way of figuring out what IP address a packet was sent to when binding to
735 .. _setting-local-address-nonexist-fail:
737 ``local-address-nonexist-fail``
738 -------------------------------
743 Fail to start if one or more of the
744 :ref:`setting-local-address`'s do not exist on this server.
746 .. _setting-local-ipv6:
751 - IPv6 Addresses, separated by commas or whitespace
754 Local IPv6 address to which we bind. It is highly advised to bind to
755 specific interfaces and not use the default 'bind to any'. This causes
756 big problems if you have multiple IP addresses.
758 .. _setting-local-ipv6-nonexist-fail:
760 ``local-ipv6-nonexist-fail``
761 ----------------------------
766 Fail to start if one or more of the :ref:`setting-local-ipv6`
767 addresses do not exist on this server.
769 .. _setting-local-port:
777 The port on which we listen. Only one port possible.
779 .. _setting-log-dns-details:
787 If set to 'no', informative-only DNS details will not even be sent to
788 syslog, improving performance.
790 .. _setting-log-dns-queries:
798 Tell PowerDNS to log all incoming DNS queries. This will lead to a lot
799 of logging! Only enable for debugging! Set :ref:`setting-loglevel`
800 to at least 5 to see the logs.
802 .. _setting-log-timestamp:
810 .. versionadded:: 4.1.0
812 When printing log lines to stdout, prefix them with timestamps.
813 Disable this if the process supervisor timestamps these lines already.
816 The systemd unit file supplied with the source code already disables timestamp printing
818 .. _setting-logging-facility:
823 If set to a digit, logging is performed under this LOCAL facility. See :ref:`logging-to-syslog`.
824 Do not pass names like 'local0'!
826 .. _setting-loglevel:
834 Amount of logging. Higher is more. Do not set below 3. Corresponds to "syslog" level values,
835 e.g. error = 3, warning = 4, notice = 5, info = 6
837 .. _setting-lua-axfr-script:
845 .. versionadded:: 4.1.0
847 Script to be used to edit incoming AXFRs, see :ref:`modes-of-operation-axfrfilter`
849 .. _setting-lua-prequery-script:
851 ``lua-prequery-script``
852 -----------------------
856 Lua script to run before answering a query. This is a feature used
857 internally for regression testing. The API of this functionality is not
858 guaranteed to be stable, and is in fact likely to change.
860 .. _setting-lua-records-exec-limit:
862 ``lua-records-exec-limit``
863 -----------------------------
868 Limit LUA records scripts to ``lua-records-exec-limit`` instructions.
869 Setting this to any value less than or equal to 0 will set no limit.
879 Turn on master support. See :ref:`master-operation`.
881 .. _setting-max-cache-entries:
883 ``max-cache-entries``
884 ---------------------
889 .. versionchanged:: 4.1.0
890 The packet and query caches are distinct. Previously, this setting was used for
891 both the packet and query caches. See :ref:`setting-max-packet-cache-entries` for
892 the packet-cache setting.
894 Maximum number of entries in the query cache. 1 million (the default)
895 will generally suffice for most installations.
897 .. _setting-max-ent-entries:
905 Maximum number of empty non-terminals to add to a zone. This is a
906 protection measure to avoid database explosion due to long names.
908 .. _setting-max-nsec3-iterations:
910 ``max-nsec3-iterations``
911 ------------------------
916 Limit the number of NSEC3 hash iterations for zone configurations.
917 For more information see :ref:`dnssec-operational-nsec-modes-params`.
919 .. _setting-max-packet-cache-entries:
921 ``max-packet-cache-entries``
922 ----------------------------
927 .. versionadded:: 4.1.0
929 Maximum number of entries in the packet cache. 1 million (the default)
930 will generally suffice for most installations.
932 .. _setting-max-queue-length:
940 If this many packets are waiting for database attention, consider the
941 situation hopeless and respawn.
943 .. _setting-max-signature-cache-entries:
945 ``max-signature-cache-entries``
946 -------------------------------
949 - Default: 2^31-1 (on most systems), 2^63-1 (on ILP64 systems)
951 Maximum number of signatures cache entries
953 .. _setting-max-tcp-connection-duration:
955 ``max-tcp-connection-duration``
956 -------------------------------
961 Maximum time in seconds that a TCP DNS connection is allowed to stay
962 open. 0 means unlimited. Note that exchanges related to an AXFR or IXFR
963 are not affected by this setting.
965 .. _setting-max-tcp-connections:
967 ``max-tcp-connections``
968 -----------------------
973 Allow this many incoming TCP DNS connections simultaneously.
975 .. _setting-max-tcp-connections-per-client:
977 ``max-tcp-connections-per-client``
978 ----------------------------------
983 Maximum number of simultaneous TCP connections per client. 0 means
986 .. _setting-max-tcp-transactions-per-conn:
988 ``max-tcp-transactions-per-conn``
989 ---------------------------------
994 Allow this many DNS queries in a single TCP transaction. 0 means
995 unlimited. Note that exchanges related to an AXFR or IXFR are not
996 affected by this setting.
998 .. _setting-module-dir:
1005 Directory for modules. Default depends on ``PKGLIBDIR`` during
1008 .. _setting-negquery-cache-ttl:
1010 ``negquery-cache-ttl``
1011 ----------------------
1016 Seconds to store queries with no answer in the Query Cache. See :ref:`query-cache`.
1018 .. _setting-no-config:
1026 Do not attempt to read the configuration file. Useful for configuration
1027 by parameters from the command line only.
1029 .. _setting-no-shuffle:
1037 Do not attempt to shuffle query results, used for regression testing.
1039 .. _setting-non-local-bind:
1047 Bind to addresses even if one or more of the
1048 :ref:`setting-local-address`'s do not exist on this server.
1049 Setting this option will enable the needed socket options to allow
1050 binding to non-local addresses. This feature is intended to facilitate
1051 ip-failover setups, but it may also mask configuration issues and for
1052 this reason it is disabled by default.
1054 .. _setting-only-notify:
1059 - IP Ranges, separated by commas or whitespace
1060 - Default: 0.0.0.0/0, ::/0
1062 For type=MASTER zones (or SLAVE zones with slave-renotify enabled)
1063 PowerDNS automatically sends NOTIFYs to the name servers specified in
1064 the NS records. By specifying networks/mask as whitelist, the targets
1065 can be limited. The default is to notify the world. To completely
1066 disable these NOTIFYs set ``only-notify`` to an empty value. Independent
1067 of this setting, the IP addresses or netmasks configured with
1068 :ref:`setting-also-notify` and ``ALSO-NOTIFY`` domain metadata
1069 always receive AXFR NOTIFYs.
1071 IP addresses and netmasks can be excluded by prefixing them with a ``!``.
1072 To notify all IP addresses apart from the 192.168.0.0/24 subnet use the following::
1074 only-notify=0.0.0.0/0, ::/0, !192.168.0.0/24
1077 Even if NOTIFYs are limited by a netmask, PowerDNS first has to
1078 resolve all the hostnames to check their IP addresses against the
1079 specified whitelist. The resolving may take considerable time,
1080 especially if those hostnames are slow to resolve. If you do not need to
1081 NOTIFY the slaves defined in the NS records (e.g. you are using another
1082 method to distribute the zone data to the slaves), then set
1083 :ref:`setting-only-notify` to an empty value and specify the notification targets
1084 explicitly using :ref:`setting-also-notify` and/or
1085 :ref:`metadata-also-notify` domain metadata to avoid this potential bottleneck.
1088 If your slaves support an Internet Protocol version, which your master does not,
1089 then set ``only-notify`` to include only supported protocol version.
1090 Otherwise there will be error trying to resolve address.
1092 For example, slaves support both IPv4 and IPv6, but PowerDNS master have only IPv4,
1093 so allow only IPv4 with ``only-notify``:
1097 only-notify=0.0.0.0/0
1099 .. _setting-out-of-zone-additional-processing:
1101 ``out-of-zone-additional-processing``
1102 -------------------------------------
1107 .. deprecated:: 4.2.0
1108 This setting has been removed.
1110 Do out of zone additional processing. This means that if a malicious
1111 user adds a '.com' zone to your server, it is not used for other domains
1112 and will not contaminate answers. Do not enable this setting if you run
1113 a public DNS service with untrusted users.
1115 The docs had previously indicated that the default was "no", but the
1116 default has been "yes" since 2005.
1118 .. _setting-outgoing-axfr-expand-alias:
1120 ``outgoing-axfr-expand-alias``
1121 ------------------------------
1126 If this is enabled, ALIAS records are expanded (synthesised to their
1127 A/AAAA) during outgoing AXFR. This means slaves will not automatically
1128 follow changes in those A/AAAA records unless you AXFR regularly!
1130 If this is disabled (the default), ALIAS records are sent verbatim
1131 during outgoing AXFR. Note that if your slaves do not support ALIAS,
1132 they will return NODATA for A/AAAA queries for such names.
1134 .. _setting-overload-queue-length:
1136 ``overload-queue-length``
1137 -------------------------
1140 - Default: 0 (disabled)
1142 If this many packets are waiting for database attention, answer any new
1143 questions strictly from the packet cache.
1145 .. _setting-prevent-self-notification:
1147 ``prevent-self-notification``
1148 -----------------------------
1153 PowerDNS Authoritative Server attempts to not send out notifications to
1154 itself in master mode. In very complicated situations we could guess
1155 wrong and not notify a server that should be notified. In that case, set
1156 prevent-self-notification to "no".
1158 .. _setting-query-cache-ttl:
1166 Seconds to store queries with an answer in the Query Cache. See :ref:`query-cache`.
1168 .. _setting-query-local-address:
1170 ``query-local-address``
1171 -----------------------
1176 The IP address to use as a source address for sending queries. Useful if
1177 you have multiple IPs and PowerDNS is not bound to the IP address your
1178 operating system uses by default for outgoing packets.
1180 .. _setting-query-local-address6:
1182 ``query-local-address6``
1183 ------------------------
1188 Source IP address for sending IPv6 queries.
1190 .. _setting-query-logging:
1198 Boolean, hints to a backend that it should log a textual representation
1199 of queries it performs. Can be set at runtime.
1201 .. _setting-queue-limit:
1209 Maximum number of milliseconds to queue a query. See :doc:`performance`.
1211 .. _setting-receiver-threads:
1213 ``receiver-threads``
1214 --------------------
1219 Number of receiver (listening) threads to start. See :doc:`performance`.
1221 .. _setting-recursive-cache-ttl:
1223 ``recursive-cache-ttl``
1224 -----------------------
1229 .. deprecated:: 4.1.0
1230 Recursion has been removed, see :doc:`guides/recursion`
1232 Seconds to store recursive packets in the :ref:`packet-cache`.
1234 .. _setting-recursor:
1241 .. deprecated:: 4.1.0
1242 Recursion has been removed, see :doc:`guides/recursion`
1244 If set, recursive queries will be handed to the recursor specified here.
1246 .. _setting-resolver:
1251 - IP Addresses with optional port, separated by commas
1253 .. versionadded:: 4.1.0
1255 Use these resolver addresses for ALIAS and the internal stub resolver.
1256 If this is not set, ``/etc/resolv.conf`` is parsed for upstream
1259 .. _setting-retrieval-threads:
1261 ``retrieval-threads``
1262 ---------------------
1267 Number of AXFR slave threads to start.
1269 .. _setting-reuseport:
1277 On Linux 3.9 and some BSD kernels the ``SO_REUSEPORT`` option allows
1278 each receiver-thread to open a new socket on the same port which allows
1279 for much higher performance on multi-core boxes. Setting this option
1280 will enable use of ``SO_REUSEPORT`` when available and seamlessly fall
1281 back to a single socket when it is not available. A side-effect is that
1282 you can start multiple servers on the same IP/port combination which may
1283 or may not be a good idea. You could use this to enable transparent
1284 restarts, but it may also mask configuration issues and for this reason
1285 it is disabled by default.
1295 Specify which random number generator to use. Permissible choises are:
1297 - auto - choose automatically
1298 - sodium - Use libsodium ``randombytes_uniform``
1299 - openssl - Use libcrypto ``RAND_bytes``
1300 - getrandom - Use libc getrandom, falls back to urandom if it does not really work
1301 - arc4random - Use BSD ``arc4random_uniform``
1302 - urandom - Use ``/dev/urandom``
1303 - kiss - Use simple settable deterministic RNG. **FOR TESTING PURPOSES ONLY!**
1306 Not all choises are available on all systems.
1308 .. _setting-security-poll-suffix:
1310 ``security-poll-suffix``
1311 ------------------------
1314 - Default: secpoll.powerdns.com.
1316 Domain name from which to query security update notifications. Setting
1317 this to an empty string disables secpoll.
1319 .. _setting-send-signed-notify:
1321 ``send-signed-notify``
1322 ----------------------
1327 If yes, outgoing NOTIFYs will be signed if a TSIG key is configured for the zone.
1328 If there are multiple TSIG keys configured for a domain, PowerDNS will use the
1329 first one retrieved from the backend, which may not be the correct one for the
1330 respective slave. Hence, in setups with multiple slaves with different TSIG keys
1331 it may be required to send NOTIFYs unsigned.
1333 .. _setting-server-id:
1339 - Default: The hostname of the server
1341 This is the server ID that will be returned on an EDNS NSID query.
1350 If set, change group id to this gid for more security. See :doc:`security`.
1359 If set, change user id to this uid for more security. See :doc:`security`.
1361 .. _setting-signing-threads:
1369 Tell PowerDNS how many threads to use for signing. It might help improve
1370 signing speed by changing this number.
1380 Turn on slave support. See :ref:`slave-operation`.
1382 .. _setting-slave-cycle-interval:
1384 ``slave-cycle-interval``
1385 ------------------------
1390 On a master, this is the amount of seconds between the master checking
1391 the SOA serials in its database to determine to send out NOTIFYs to the
1392 slaves. On slaves, this is the number of seconds between the slave
1393 checking for updates to zones.
1395 .. _setting-slave-renotify:
1403 This setting will make PowerDNS renotify the slaves after an AXFR is
1404 *received* from a master. This is useful when using when running a
1407 .. _setting-soa-expire-default:
1409 ``soa-expire-default``
1410 ----------------------
1415 Default :ref:`types-soa` expire.
1417 .. _setting-soa-minimum-ttl:
1425 Default :ref:`types-soa` minimum ttl.
1427 .. _setting-soa-refresh-default:
1429 ``soa-refresh-default``
1430 -----------------------
1435 Default :ref:`types-soa` refresh.
1437 .. _setting-soa-retry-default:
1439 ``soa-retry-default``
1440 ---------------------
1445 Default :ref:`types-soa` retry.
1447 .. _setting-socket-dir:
1454 Where the controlsocket will live. The default depends on
1455 ``LOCALSTATEDIR`` during compile-time (usually ``/var/run`` or
1456 ``/run``). See :ref:`control-socket`.
1458 This path will also contain the pidfile for this instance of PowerDNS
1459 called ``pdns.pid`` by default. See :ref:`setting-config-name`
1460 and :doc:`Virtual Hosting <guides/virtual-instances>` how this can differ.
1462 .. _setting-superslave:
1470 .. versionadded:: 4.2.0
1471 In versions before 4.2.x, this setting did not exist and supermaster support
1472 was enabled by default.
1474 Turn on supermaster support. See :ref:`supermaster-operation`.
1476 .. _setting-tcp-control-address:
1478 ``tcp-control-address``
1479 -----------------------
1483 Address to bind to for TCP control.
1485 .. _setting-tcp-control-port:
1487 ``tcp-control-port``
1488 --------------------
1493 Port to bind to for TCP control.
1495 .. _setting-tcp-control-range:
1497 ``tcp-control-range``
1498 ---------------------
1500 - IP Ranges, separated by commas or whitespace
1502 Limit TCP control to a specific client range.
1504 .. _setting-tcp-control-secret:
1506 ``tcp-control-secret``
1507 ----------------------
1511 Password for TCP control.
1513 .. _setting-tcp-fast-open:
1519 - Default: 0 (Disabled)
1521 .. versionadded:: 4.1.0
1523 Enable TCP Fast Open support, if available, on the listening sockets.
1524 The numerical value supplied is used as the queue size, 0 meaning
1527 .. _setting-tcp-idle-timeout:
1529 ``tcp-idle-timeout``
1530 --------------------
1535 Maximum time in seconds that a TCP DNS connection is allowed to stay
1536 open while being idle, meaning without PowerDNS receiving or sending
1539 .. _setting-traceback-handler:
1541 ``traceback-handler``
1542 ---------------------
1547 Enable the Linux-only traceback handler.
1549 .. _setting-trusted-notification-proxy:
1551 ``trusted-notification-proxy``
1552 ------------------------------
1556 IP address of incoming notification proxy
1558 .. _setting-udp-truncation-threshold:
1560 ``udp-truncation-threshold``
1561 ----------------------------
1562 .. versionchanged:: 4.2.0
1563 Before 4.2.0, the default was 1680
1568 EDNS0 allows for large UDP response datagrams, which can potentially
1569 raise performance. Large responses however also have downsides in terms
1570 of reflection attacks. Maximum value is 65535, but values above
1571 4096 should probably not be attempted.
1575 1232 is the largest number of payload bytes that can fit in the smallest IPv6 packet.
1576 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.
1578 .. _setting-version-string:
1583 - Any of: ``anonymous``, ``powerdns``, ``full``, String
1586 When queried for its version over DNS
1587 (``dig chaos txt version.bind @pdns.ip.address``), PowerDNS normally
1588 responds truthfully. With this setting you can overrule what will be
1589 returned. Set the ``version-string`` to ``full`` to get the default
1590 behaviour, to ``powerdns`` to just make it state
1591 ``served by PowerDNS - http://www.powerdns.com``. The ``anonymous``
1592 setting will return a ServFail, much like Microsoft nameservers do. You
1593 can set this response to a custom value as well.
1595 .. _setting-webserver:
1603 Start a webserver for monitoring. See :doc:`performance`".
1605 .. versionchanged:: 4.1.0
1606 It was necessary to enable the webserver to use the REST API, this is no longer the case.
1608 .. _setting-webserver-address:
1610 ``webserver-address``
1611 ---------------------
1614 - Default: 127.0.0.1
1616 IP Address for webserver/API to listen on.
1618 .. _setting-webserver-allow-from:
1620 ``webserver-allow-from``
1621 ------------------------
1623 - IP ranges, separated by commas or whitespace
1624 - Default: 127.0.0.1,::1
1626 .. versionchanged:: 4.1.0
1628 Default is now 127.0.0.1,::1, was 0.0.0.0/0,::/0 before.
1630 Webserver/API access is only allowed from these subnets.
1632 .. _setting-webserver-loglevel:
1634 ``webserver-loglevel``
1635 ----------------------
1636 .. versionadded:: 4.2.0
1638 - String, one of "none", "normal", "detailed"
1640 The amount of logging the webserver must do. "none" means no useful webserver information will be logged.
1641 When set to "normal", the webserver will log a line per request that should be familiar::
1643 [webserver] e235780e-a5cf-415e-9326-9d33383e739e 127.0.0.1:55376 "GET /api/v1/servers/localhost/bla HTTP/1.1" 404 196
1645 When set to "detailed", all information about the request and response are logged::
1647 [webserver] e235780e-a5cf-415e-9326-9d33383e739e Request Details:
1648 [webserver] e235780e-a5cf-415e-9326-9d33383e739e Headers:
1649 [webserver] e235780e-a5cf-415e-9326-9d33383e739e accept: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8
1650 [webserver] e235780e-a5cf-415e-9326-9d33383e739e accept-encoding: gzip, deflate
1651 [webserver] e235780e-a5cf-415e-9326-9d33383e739e accept-language: en-US,en;q=0.5
1652 [webserver] e235780e-a5cf-415e-9326-9d33383e739e connection: keep-alive
1653 [webserver] e235780e-a5cf-415e-9326-9d33383e739e dnt: 1
1654 [webserver] e235780e-a5cf-415e-9326-9d33383e739e host: 127.0.0.1:8081
1655 [webserver] e235780e-a5cf-415e-9326-9d33383e739e upgrade-insecure-requests: 1
1656 [webserver] e235780e-a5cf-415e-9326-9d33383e739e user-agent: Mozilla/5.0 (X11; Linux x86_64; rv:64.0) Gecko/20100101 Firefox/64.0
1657 [webserver] e235780e-a5cf-415e-9326-9d33383e739e No body
1658 [webserver] e235780e-a5cf-415e-9326-9d33383e739e Response details:
1659 [webserver] e235780e-a5cf-415e-9326-9d33383e739e Headers:
1660 [webserver] e235780e-a5cf-415e-9326-9d33383e739e Connection: close
1661 [webserver] e235780e-a5cf-415e-9326-9d33383e739e Content-Length: 49
1662 [webserver] e235780e-a5cf-415e-9326-9d33383e739e Content-Type: text/html; charset=utf-8
1663 [webserver] e235780e-a5cf-415e-9326-9d33383e739e Server: PowerDNS/0.0.15896.0.gaba8bab3ab
1664 [webserver] e235780e-a5cf-415e-9326-9d33383e739e Full body:
1665 [webserver] e235780e-a5cf-415e-9326-9d33383e739e <!html><title>Not Found</title><h1>Not Found</h1>
1666 [webserver] e235780e-a5cf-415e-9326-9d33383e739e 127.0.0.1:55376 "GET /api/v1/servers/localhost/bla HTTP/1.1" 404 196
1668 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.
1671 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.
1673 .. _setting-webserver-password:
1675 ``webserver-password``
1676 ----------------------
1680 The plaintext password required for accessing the webserver.
1682 .. _setting-webserver-port:
1690 The port where webserver/API will listen on.
1692 .. _setting-webserver-print-arguments:
1694 ``webserver-print-arguments``
1695 -----------------------------
1700 If the webserver should print arguments.
1702 .. _setting-write-pid:
1710 If a PID file should be written.
1712 .. _setting-xfr-max-received-mbytes:
1714 ``xfr-max-received-mbytes``
1715 ---------------------------
1720 Specifies the maximum number of received megabytes allowed on an
1721 incoming AXFR/IXFR update, to prevent resource exhaustion. A value of 0
1722 means no restriction.
projects / thirdparty / pdns.git / blob