xref: /freebsd/contrib/unbound/doc/example.conf.in (revision b5663de9eb877cb7ebb54c4ae4eb81007bb17df4)
1b7579f77SDag-Erling Smørgrav#
2b7579f77SDag-Erling Smørgrav# Example configuration file.
3b7579f77SDag-Erling Smørgrav#
4*b5663de9SDag-Erling Smørgrav# See unbound.conf(5) man page, version 1.5.10.
5b7579f77SDag-Erling Smørgrav#
6b7579f77SDag-Erling Smørgrav# this is a comment.
7b7579f77SDag-Erling Smørgrav
8b7579f77SDag-Erling Smørgrav#Use this to include other text into the file.
9b7579f77SDag-Erling Smørgrav#include: "otherfile.conf"
10b7579f77SDag-Erling Smørgrav
11b7579f77SDag-Erling Smørgrav# The server clause sets the main parameters.
12b7579f77SDag-Erling Smørgravserver:
13b7579f77SDag-Erling Smørgrav	# whitespace is not necessary, but looks cleaner.
14b7579f77SDag-Erling Smørgrav
15b7579f77SDag-Erling Smørgrav	# verbosity number, 0 is least verbose. 1 is default.
16b7579f77SDag-Erling Smørgrav	verbosity: 1
17b7579f77SDag-Erling Smørgrav
18b7579f77SDag-Erling Smørgrav	# print statistics to the log (for every thread) every N seconds.
19b7579f77SDag-Erling Smørgrav	# Set to "" or 0 to disable. Default is disabled.
20b7579f77SDag-Erling Smørgrav	# statistics-interval: 0
21b7579f77SDag-Erling Smørgrav
22b7579f77SDag-Erling Smørgrav	# enable cumulative statistics, without clearing them after printing.
23b7579f77SDag-Erling Smørgrav	# statistics-cumulative: no
24b7579f77SDag-Erling Smørgrav
25b7579f77SDag-Erling Smørgrav	# enable extended statistics (query types, answer codes, status)
26b7579f77SDag-Erling Smørgrav	# printed from unbound-control. default off, because of speed.
27b7579f77SDag-Erling Smørgrav	# extended-statistics: no
28b7579f77SDag-Erling Smørgrav
29b7579f77SDag-Erling Smørgrav	# number of threads to create. 1 disables threading.
30b7579f77SDag-Erling Smørgrav	# num-threads: 1
31b7579f77SDag-Erling Smørgrav
32b7579f77SDag-Erling Smørgrav	# specify the interfaces to answer queries from by ip-address.
33b7579f77SDag-Erling Smørgrav	# The default is to listen to localhost (127.0.0.1 and ::1).
34b7579f77SDag-Erling Smørgrav	# specify 0.0.0.0 and ::0 to bind to all available interfaces.
35b7579f77SDag-Erling Smørgrav	# specify every interface[@port] on a new 'interface:' labelled line.
36b7579f77SDag-Erling Smørgrav	# The listen interfaces are not changed on reload, only on restart.
37b7579f77SDag-Erling Smørgrav	# interface: 192.0.2.153
38b7579f77SDag-Erling Smørgrav	# interface: 192.0.2.154
39b7579f77SDag-Erling Smørgrav	# interface: 192.0.2.154@5003
40b7579f77SDag-Erling Smørgrav	# interface: 2001:DB8::5
41b7579f77SDag-Erling Smørgrav
42b7579f77SDag-Erling Smørgrav	# enable this feature to copy the source address of queries to reply.
43b7579f77SDag-Erling Smørgrav	# Socket options are not supported on all platforms. experimental.
44b7579f77SDag-Erling Smørgrav	# interface-automatic: no
45b7579f77SDag-Erling Smørgrav
46b7579f77SDag-Erling Smørgrav	# port to answer queries from
47b7579f77SDag-Erling Smørgrav	# port: 53
48b7579f77SDag-Erling Smørgrav
49b7579f77SDag-Erling Smørgrav	# specify the interfaces to send outgoing queries to authoritative
50b7579f77SDag-Erling Smørgrav	# server from by ip-address. If none, the default (all) interface
51b7579f77SDag-Erling Smørgrav	# is used. Specify every interface on a 'outgoing-interface:' line.
52b7579f77SDag-Erling Smørgrav	# outgoing-interface: 192.0.2.153
53b7579f77SDag-Erling Smørgrav	# outgoing-interface: 2001:DB8::5
54b7579f77SDag-Erling Smørgrav	# outgoing-interface: 2001:DB8::6
55b7579f77SDag-Erling Smørgrav
56*b5663de9SDag-Erling Smørgrav	# Specify a netblock to use remainder 64 bits as random bits for
57*b5663de9SDag-Erling Smørgrav	# upstream queries.  Uses freebind option (Linux).
58*b5663de9SDag-Erling Smørgrav	# outgoing-interface: 2001:DB8::/64
59*b5663de9SDag-Erling Smørgrav	# Also (Linux:) ip -6 addr add 2001:db8::/64 dev lo
60*b5663de9SDag-Erling Smørgrav	# And: ip -6 route add local 2001:db8::/64 dev lo
61*b5663de9SDag-Erling Smørgrav	# And set prefer-ip6: yes to use the ip6 randomness from a netblock.
62*b5663de9SDag-Erling Smørgrav	# Set this to yes to prefer ipv6 upstream servers over ipv4.
63*b5663de9SDag-Erling Smørgrav	# prefer-ip6: no
64*b5663de9SDag-Erling Smørgrav
65b7579f77SDag-Erling Smørgrav	# number of ports to allocate per thread, determines the size of the
66b7579f77SDag-Erling Smørgrav	# port range that can be open simultaneously.  About double the
67b7579f77SDag-Erling Smørgrav	# num-queries-per-thread, or, use as many as the OS will allow you.
68b7579f77SDag-Erling Smørgrav	# outgoing-range: 4096
69b7579f77SDag-Erling Smørgrav
70b7579f77SDag-Erling Smørgrav	# permit unbound to use this port number or port range for
71b7579f77SDag-Erling Smørgrav	# making outgoing queries, using an outgoing interface.
72b7579f77SDag-Erling Smørgrav	# outgoing-port-permit: 32768
73b7579f77SDag-Erling Smørgrav
74b7579f77SDag-Erling Smørgrav	# deny unbound the use this of port number or port range for
75b7579f77SDag-Erling Smørgrav	# making outgoing queries, using an outgoing interface.
76b7579f77SDag-Erling Smørgrav	# Use this to make sure unbound does not grab a UDP port that some
77b7579f77SDag-Erling Smørgrav	# other server on this computer needs. The default is to avoid
78b7579f77SDag-Erling Smørgrav	# IANA-assigned port numbers.
798ed2b524SDag-Erling Smørgrav	# If multiple outgoing-port-permit and outgoing-port-avoid options
808ed2b524SDag-Erling Smørgrav	# are present, they are processed in order.
81b7579f77SDag-Erling Smørgrav	# outgoing-port-avoid: "3200-3208"
82b7579f77SDag-Erling Smørgrav
83b7579f77SDag-Erling Smørgrav	# number of outgoing simultaneous tcp buffers to hold per thread.
84b7579f77SDag-Erling Smørgrav	# outgoing-num-tcp: 10
85b7579f77SDag-Erling Smørgrav
86b7579f77SDag-Erling Smørgrav	# number of incoming simultaneous tcp buffers to hold per thread.
87b7579f77SDag-Erling Smørgrav	# incoming-num-tcp: 10
88b7579f77SDag-Erling Smørgrav
89b7579f77SDag-Erling Smørgrav	# buffer size for UDP port 53 incoming (SO_RCVBUF socket option).
90b7579f77SDag-Erling Smørgrav	# 0 is system default.  Use 4m to catch query spikes for busy servers.
91b7579f77SDag-Erling Smørgrav	# so-rcvbuf: 0
92b7579f77SDag-Erling Smørgrav
93b7579f77SDag-Erling Smørgrav	# buffer size for UDP port 53 outgoing (SO_SNDBUF socket option).
94b7579f77SDag-Erling Smørgrav	# 0 is system default.  Use 4m to handle spikes on very busy servers.
95b7579f77SDag-Erling Smørgrav	# so-sndbuf: 0
96b7579f77SDag-Erling Smørgrav
97ff825849SDag-Erling Smørgrav	# use SO_REUSEPORT to distribute queries over threads.
9817d15b25SDag-Erling Smørgrav	# so-reuseport: no
9917d15b25SDag-Erling Smørgrav
10009a3aaf3SDag-Erling Smørgrav	# use IP_TRANSPARENT so the interface: addresses can be non-local
10109a3aaf3SDag-Erling Smørgrav	# and you can config non-existing IPs that are going to work later on
102f61ef7f6SDag-Erling Smørgrav	# (uses IP_BINDANY on FreeBSD).
10309a3aaf3SDag-Erling Smørgrav	# ip-transparent: no
10409a3aaf3SDag-Erling Smørgrav
105e2d15004SDag-Erling Smørgrav	# use IP_FREEBIND so the interface: addresses can be non-local
106e2d15004SDag-Erling Smørgrav	# and you can bind to nonexisting IPs and interfaces that are down.
107e2d15004SDag-Erling Smørgrav	# Linux only.  On Linux you also have ip-transparent that is similar.
108e2d15004SDag-Erling Smørgrav	# ip-freebind: no
109e2d15004SDag-Erling Smørgrav
110b7579f77SDag-Erling Smørgrav	# EDNS reassembly buffer to advertise to UDP peers (the actual buffer
111b7579f77SDag-Erling Smørgrav	# is set with msg-buffer-size). 1480 can solve fragmentation (timeouts).
112b7579f77SDag-Erling Smørgrav	# edns-buffer-size: 4096
113b7579f77SDag-Erling Smørgrav
11417d15b25SDag-Erling Smørgrav	# Maximum UDP response size (not applied to TCP response).
11517d15b25SDag-Erling Smørgrav	# Suggested values are 512 to 4096. Default is 4096. 65536 disables it.
11617d15b25SDag-Erling Smørgrav	# max-udp-size: 4096
11717d15b25SDag-Erling Smørgrav
118b7579f77SDag-Erling Smørgrav	# buffer size for handling DNS data. No messages larger than this
119b7579f77SDag-Erling Smørgrav	# size can be sent or received, by UDP or TCP. In bytes.
120b7579f77SDag-Erling Smørgrav	# msg-buffer-size: 65552
121b7579f77SDag-Erling Smørgrav
122b7579f77SDag-Erling Smørgrav	# the amount of memory to use for the message cache.
123b7579f77SDag-Erling Smørgrav	# plain value in bytes or you can append k, m or G. default is "4Mb".
124b7579f77SDag-Erling Smørgrav	# msg-cache-size: 4m
125b7579f77SDag-Erling Smørgrav
126b7579f77SDag-Erling Smørgrav	# the number of slabs to use for the message cache.
127b7579f77SDag-Erling Smørgrav	# the number of slabs must be a power of 2.
128b7579f77SDag-Erling Smørgrav	# more slabs reduce lock contention, but fragment memory usage.
129b7579f77SDag-Erling Smørgrav	# msg-cache-slabs: 4
130b7579f77SDag-Erling Smørgrav
131b7579f77SDag-Erling Smørgrav	# the number of queries that a thread gets to service.
132b7579f77SDag-Erling Smørgrav	# num-queries-per-thread: 1024
133b7579f77SDag-Erling Smørgrav
134b7579f77SDag-Erling Smørgrav	# if very busy, 50% queries run to completion, 50% get timeout in msec
135b7579f77SDag-Erling Smørgrav	# jostle-timeout: 200
136b7579f77SDag-Erling Smørgrav
13717d15b25SDag-Erling Smørgrav	# msec to wait before close of port on timeout UDP. 0 disables.
13817d15b25SDag-Erling Smørgrav	# delay-close: 0
13917d15b25SDag-Erling Smørgrav
140b7579f77SDag-Erling Smørgrav	# the amount of memory to use for the RRset cache.
141b7579f77SDag-Erling Smørgrav	# plain value in bytes or you can append k, m or G. default is "4Mb".
142b7579f77SDag-Erling Smørgrav	# rrset-cache-size: 4m
143b7579f77SDag-Erling Smørgrav
144b7579f77SDag-Erling Smørgrav	# the number of slabs to use for the RRset cache.
145b7579f77SDag-Erling Smørgrav	# the number of slabs must be a power of 2.
146b7579f77SDag-Erling Smørgrav	# more slabs reduce lock contention, but fragment memory usage.
147b7579f77SDag-Erling Smørgrav	# rrset-cache-slabs: 4
148b7579f77SDag-Erling Smørgrav
149b7579f77SDag-Erling Smørgrav	# the time to live (TTL) value lower bound, in seconds. Default 0.
150b7579f77SDag-Erling Smørgrav	# If more than an hour could easily give trouble due to stale data.
151b7579f77SDag-Erling Smørgrav	# cache-min-ttl: 0
152b7579f77SDag-Erling Smørgrav
153b7579f77SDag-Erling Smørgrav	# the time to live (TTL) value cap for RRsets and messages in the
154b7579f77SDag-Erling Smørgrav	# cache. Items are not cached for longer. In seconds.
155b7579f77SDag-Erling Smørgrav	# cache-max-ttl: 86400
156b7579f77SDag-Erling Smørgrav
15709a3aaf3SDag-Erling Smørgrav	# the time to live (TTL) value cap for negative responses in the cache
15809a3aaf3SDag-Erling Smørgrav	# cache-max-negative-ttl: 3600
15909a3aaf3SDag-Erling Smørgrav
160b7579f77SDag-Erling Smørgrav	# the time to live (TTL) value for cached roundtrip times, lameness and
161b7579f77SDag-Erling Smørgrav	# EDNS version information for hosts. In seconds.
162b7579f77SDag-Erling Smørgrav	# infra-host-ttl: 900
163b7579f77SDag-Erling Smørgrav
1646480faa8SDag-Erling Smørgrav	# minimum wait time for responses, increase if uplink is long. In msec.
1656480faa8SDag-Erling Smørgrav	# infra-cache-min-rtt: 50
1666480faa8SDag-Erling Smørgrav
167b7579f77SDag-Erling Smørgrav	# the number of slabs to use for the Infrastructure cache.
168b7579f77SDag-Erling Smørgrav	# the number of slabs must be a power of 2.
169b7579f77SDag-Erling Smørgrav	# more slabs reduce lock contention, but fragment memory usage.
170b7579f77SDag-Erling Smørgrav	# infra-cache-slabs: 4
171b7579f77SDag-Erling Smørgrav
172b7579f77SDag-Erling Smørgrav	# the maximum number of hosts that are cached (roundtrip, EDNS, lame).
173b7579f77SDag-Erling Smørgrav	# infra-cache-numhosts: 10000
174b7579f77SDag-Erling Smørgrav
175*b5663de9SDag-Erling Smørgrav	# define a number of tags here, use with local-zone, access-control.
176*b5663de9SDag-Erling Smørgrav	# repeat the define-tag statement to add additional tags.
177*b5663de9SDag-Erling Smørgrav	# define-tag: "tag1 tag2 tag3"
178*b5663de9SDag-Erling Smørgrav
179b7579f77SDag-Erling Smørgrav	# Enable IPv4, "yes" or "no".
180b7579f77SDag-Erling Smørgrav	# do-ip4: yes
181b7579f77SDag-Erling Smørgrav
182b7579f77SDag-Erling Smørgrav	# Enable IPv6, "yes" or "no".
183b7579f77SDag-Erling Smørgrav	# do-ip6: yes
184b7579f77SDag-Erling Smørgrav
185b7579f77SDag-Erling Smørgrav	# Enable UDP, "yes" or "no".
186b7579f77SDag-Erling Smørgrav	# do-udp: yes
187b7579f77SDag-Erling Smørgrav
188b7579f77SDag-Erling Smørgrav	# Enable TCP, "yes" or "no".
189b7579f77SDag-Erling Smørgrav	# do-tcp: yes
190b7579f77SDag-Erling Smørgrav
191b7579f77SDag-Erling Smørgrav	# upstream connections use TCP only (and no UDP), "yes" or "no"
192b7579f77SDag-Erling Smørgrav	# useful for tunneling scenarios, default no.
193b7579f77SDag-Erling Smørgrav	# tcp-upstream: no
194b7579f77SDag-Erling Smørgrav
195f61ef7f6SDag-Erling Smørgrav	# Maximum segment size (MSS) of TCP socket on which the server
196f61ef7f6SDag-Erling Smørgrav	# responds to queries. Default is 0, system default MSS.
197f61ef7f6SDag-Erling Smørgrav	# tcp-mss: 0
198f61ef7f6SDag-Erling Smørgrav
199f61ef7f6SDag-Erling Smørgrav	# Maximum segment size (MSS) of TCP socket for outgoing queries.
200f61ef7f6SDag-Erling Smørgrav	# Default is 0, system default MSS.
201f61ef7f6SDag-Erling Smørgrav	# outgoing-tcp-mss: 0
202f61ef7f6SDag-Erling Smørgrav
203b7579f77SDag-Erling Smørgrav	# Detach from the terminal, run in background, "yes" or "no".
204b7579f77SDag-Erling Smørgrav	# do-daemonize: yes
205b7579f77SDag-Erling Smørgrav
206b7579f77SDag-Erling Smørgrav	# control which clients are allowed to make (recursive) queries
207b7579f77SDag-Erling Smørgrav	# to this server. Specify classless netblocks with /size and action.
208b7579f77SDag-Erling Smørgrav	# By default everything is refused, except for localhost.
209b7579f77SDag-Erling Smørgrav	# Choose deny (drop message), refuse (polite error reply),
210b7579f77SDag-Erling Smørgrav	# allow (recursive ok), allow_snoop (recursive and nonrecursive ok)
21117d15b25SDag-Erling Smørgrav	# deny_non_local (drop queries unless can be answered from local-data)
21217d15b25SDag-Erling Smørgrav	# refuse_non_local (like deny_non_local but polite error reply).
213b7579f77SDag-Erling Smørgrav	# access-control: 0.0.0.0/0 refuse
214b7579f77SDag-Erling Smørgrav	# access-control: 127.0.0.0/8 allow
215b7579f77SDag-Erling Smørgrav	# access-control: ::0/0 refuse
216b7579f77SDag-Erling Smørgrav	# access-control: ::1 allow
217b7579f77SDag-Erling Smørgrav	# access-control: ::ffff:127.0.0.1 allow
218b7579f77SDag-Erling Smørgrav
219*b5663de9SDag-Erling Smørgrav	# tag access-control with list of tags (in "" with spaces between)
220*b5663de9SDag-Erling Smørgrav	# Clients using this access control element use localzones that
221*b5663de9SDag-Erling Smørgrav	# are tagged with one of these tags.
222*b5663de9SDag-Erling Smørgrav	# access-control-tag: 192.0.2.0/24 "tag2 tag3"
223*b5663de9SDag-Erling Smørgrav
224*b5663de9SDag-Erling Smørgrav	# set action for particular tag for given access control element
225*b5663de9SDag-Erling Smørgrav	# if you have multiple tag values, the tag used to lookup the action
226*b5663de9SDag-Erling Smørgrav	# is the first tag match between access-control-tag and local-zone-tag
227*b5663de9SDag-Erling Smørgrav	# where "first" comes from the order of the define-tag values.
228*b5663de9SDag-Erling Smørgrav	# access-control-tag-action: 192.0.2.0/24 tag3 refuse
229*b5663de9SDag-Erling Smørgrav
230*b5663de9SDag-Erling Smørgrav	# set redirect data for particular tag for access control element
231*b5663de9SDag-Erling Smørgrav	# access-control-tag-data: 192.0.2.0/24 tag2 "A 127.0.0.1"
232*b5663de9SDag-Erling Smørgrav
233b7579f77SDag-Erling Smørgrav	# if given, a chroot(2) is done to the given directory.
234b7579f77SDag-Erling Smørgrav	# i.e. you can chroot to the working directory, for example,
235b7579f77SDag-Erling Smørgrav	# for extra security, but make sure all files are in that directory.
236b7579f77SDag-Erling Smørgrav	#
237b7579f77SDag-Erling Smørgrav	# If chroot is enabled, you should pass the configfile (from the
238b7579f77SDag-Erling Smørgrav	# commandline) as a full path from the original root. After the
239b7579f77SDag-Erling Smørgrav	# chroot has been performed the now defunct portion of the config
240b7579f77SDag-Erling Smørgrav	# file path is removed to be able to reread the config after a reload.
241b7579f77SDag-Erling Smørgrav	#
242b7579f77SDag-Erling Smørgrav	# All other file paths (working dir, logfile, roothints, and
243b7579f77SDag-Erling Smørgrav	# key files) can be specified in several ways:
244b7579f77SDag-Erling Smørgrav	# 	o as an absolute path relative to the new root.
245b7579f77SDag-Erling Smørgrav	# 	o as a relative path to the working directory.
246b7579f77SDag-Erling Smørgrav	# 	o as an absolute path relative to the original root.
247b7579f77SDag-Erling Smørgrav	# In the last case the path is adjusted to remove the unused portion.
248b7579f77SDag-Erling Smørgrav	#
249b7579f77SDag-Erling Smørgrav	# The pid file can be absolute and outside of the chroot, it is
250b7579f77SDag-Erling Smørgrav	# written just prior to performing the chroot and dropping permissions.
251b7579f77SDag-Erling Smørgrav	#
252b7579f77SDag-Erling Smørgrav	# Additionally, unbound may need to access /dev/random (for entropy).
253b7579f77SDag-Erling Smørgrav	# How to do this is specific to your OS.
254b7579f77SDag-Erling Smørgrav	#
255b7579f77SDag-Erling Smørgrav	# If you give "" no chroot is performed. The path must not end in a /.
256b7579f77SDag-Erling Smørgrav	# chroot: "@UNBOUND_CHROOT_DIR@"
257b7579f77SDag-Erling Smørgrav
258b7579f77SDag-Erling Smørgrav	# if given, user privileges are dropped (after binding port),
259b7579f77SDag-Erling Smørgrav	# and the given username is assumed. Default is user "unbound".
260b7579f77SDag-Erling Smørgrav	# If you give "" no privileges are dropped.
261b7579f77SDag-Erling Smørgrav	# username: "@UNBOUND_USERNAME@"
262b7579f77SDag-Erling Smørgrav
263b7579f77SDag-Erling Smørgrav	# the working directory. The relative files in this config are
264b7579f77SDag-Erling Smørgrav	# relative to this directory. If you give "" the working directory
265b7579f77SDag-Erling Smørgrav	# is not changed.
266*b5663de9SDag-Erling Smørgrav	# If you give a server: directory: dir before include: file statements
267*b5663de9SDag-Erling Smørgrav	# then those includes can be relative to the working directory.
268b7579f77SDag-Erling Smørgrav	# directory: "@UNBOUND_RUN_DIR@"
269b7579f77SDag-Erling Smørgrav
270b7579f77SDag-Erling Smørgrav	# the log file, "" means log to stderr.
271b7579f77SDag-Erling Smørgrav	# Use of this option sets use-syslog to "no".
272b7579f77SDag-Erling Smørgrav	# logfile: ""
273b7579f77SDag-Erling Smørgrav
274b7579f77SDag-Erling Smørgrav	# Log to syslog(3) if yes. The log facility LOG_DAEMON is used to
275b7579f77SDag-Erling Smørgrav	# log to, with identity "unbound". If yes, it overrides the logfile.
276b7579f77SDag-Erling Smørgrav	# use-syslog: yes
277b7579f77SDag-Erling Smørgrav
278b7579f77SDag-Erling Smørgrav	# print UTC timestamp in ascii to logfile, default is epoch in seconds.
279b7579f77SDag-Erling Smørgrav	# log-time-ascii: no
280b7579f77SDag-Erling Smørgrav
281b7579f77SDag-Erling Smørgrav	# print one line with time, IP, name, type, class for every query.
282b7579f77SDag-Erling Smørgrav	# log-queries: no
283b7579f77SDag-Erling Smørgrav
284b7579f77SDag-Erling Smørgrav	# the pid file. Can be an absolute path outside of chroot/work dir.
285b7579f77SDag-Erling Smørgrav	# pidfile: "@UNBOUND_PIDFILE@"
286b7579f77SDag-Erling Smørgrav
287b7579f77SDag-Erling Smørgrav	# file to read root hints from.
28805ab2901SDag-Erling Smørgrav	# get one from https://www.internic.net/domain/named.cache
289b7579f77SDag-Erling Smørgrav	# root-hints: ""
290b7579f77SDag-Erling Smørgrav
291b7579f77SDag-Erling Smørgrav	# enable to not answer id.server and hostname.bind queries.
292b7579f77SDag-Erling Smørgrav	# hide-identity: no
293b7579f77SDag-Erling Smørgrav
294b7579f77SDag-Erling Smørgrav	# enable to not answer version.server and version.bind queries.
295b7579f77SDag-Erling Smørgrav	# hide-version: no
296b7579f77SDag-Erling Smørgrav
297b7579f77SDag-Erling Smørgrav	# the identity to report. Leave "" or default to return hostname.
298b7579f77SDag-Erling Smørgrav	# identity: ""
299b7579f77SDag-Erling Smørgrav
300b7579f77SDag-Erling Smørgrav	# the version to report. Leave "" or default to return package version.
301b7579f77SDag-Erling Smørgrav	# version: ""
302b7579f77SDag-Erling Smørgrav
303b7579f77SDag-Erling Smørgrav	# the target fetch policy.
304b7579f77SDag-Erling Smørgrav	# series of integers describing the policy per dependency depth.
305b7579f77SDag-Erling Smørgrav	# The number of values in the list determines the maximum dependency
306b7579f77SDag-Erling Smørgrav	# depth the recursor will pursue before giving up. Each integer means:
307b7579f77SDag-Erling Smørgrav	# 	-1 : fetch all targets opportunistically,
308b7579f77SDag-Erling Smørgrav	# 	0: fetch on demand,
309b7579f77SDag-Erling Smørgrav	#	positive value: fetch that many targets opportunistically.
310b7579f77SDag-Erling Smørgrav	# Enclose the list of numbers between quotes ("").
311b7579f77SDag-Erling Smørgrav	# target-fetch-policy: "3 2 1 0 0"
312b7579f77SDag-Erling Smørgrav
313b7579f77SDag-Erling Smørgrav	# Harden against very small EDNS buffer sizes.
314b7579f77SDag-Erling Smørgrav	# harden-short-bufsize: no
315b7579f77SDag-Erling Smørgrav
316b7579f77SDag-Erling Smørgrav	# Harden against unseemly large queries.
317b7579f77SDag-Erling Smørgrav	# harden-large-queries: no
318b7579f77SDag-Erling Smørgrav
319b7579f77SDag-Erling Smørgrav	# Harden against out of zone rrsets, to avoid spoofing attempts.
320b7579f77SDag-Erling Smørgrav	# harden-glue: yes
321b7579f77SDag-Erling Smørgrav
322b7579f77SDag-Erling Smørgrav	# Harden against receiving dnssec-stripped data. If you turn it
323b7579f77SDag-Erling Smørgrav	# off, failing to validate dnskey data for a trustanchor will
324b7579f77SDag-Erling Smørgrav	# trigger insecure mode for that zone (like without a trustanchor).
325b7579f77SDag-Erling Smørgrav	# Default on, which insists on dnssec data for trust-anchored zones.
326b7579f77SDag-Erling Smørgrav	# harden-dnssec-stripped: yes
327b7579f77SDag-Erling Smørgrav
328b7579f77SDag-Erling Smørgrav	# Harden against queries that fall under dnssec-signed nxdomain names.
329b7579f77SDag-Erling Smørgrav	# harden-below-nxdomain: no
330b7579f77SDag-Erling Smørgrav
331b7579f77SDag-Erling Smørgrav        # Harden the referral path by performing additional queries for
332b7579f77SDag-Erling Smørgrav	# infrastructure data.  Validates the replies (if possible).
333b7579f77SDag-Erling Smørgrav	# Default off, because the lookups burden the server.  Experimental
334b7579f77SDag-Erling Smørgrav	# implementation of draft-wijngaards-dnsext-resolver-side-mitigation.
335b7579f77SDag-Erling Smørgrav	# harden-referral-path: no
336b7579f77SDag-Erling Smørgrav
33709a3aaf3SDag-Erling Smørgrav	# Harden against algorithm downgrade when multiple algorithms are
33809a3aaf3SDag-Erling Smørgrav	# advertised in the DS record.  If no, allows the weakest algorithm
33909a3aaf3SDag-Erling Smørgrav	# to validate the zone.
340b75612f8SDag-Erling Smørgrav	# harden-algo-downgrade: no
34109a3aaf3SDag-Erling Smørgrav
34205ab2901SDag-Erling Smørgrav	# Sent minimum amount of information to upstream servers to enhance
34305ab2901SDag-Erling Smørgrav	# privacy. Only sent minimum required labels of the QNAME and set QTYPE
34405ab2901SDag-Erling Smørgrav	# to NS when possible.
34505ab2901SDag-Erling Smørgrav	# qname-minimisation: no
34605ab2901SDag-Erling Smørgrav
347b7579f77SDag-Erling Smørgrav	# Use 0x20-encoded random bits in the query to foil spoof attempts.
348b7579f77SDag-Erling Smørgrav	# This feature is an experimental implementation of draft dns-0x20.
349b7579f77SDag-Erling Smørgrav	# use-caps-for-id: no
350b7579f77SDag-Erling Smørgrav
35109a3aaf3SDag-Erling Smørgrav	# Domains (and domains in them) without support for dns-0x20 and
35209a3aaf3SDag-Erling Smørgrav	# the fallback fails because they keep sending different answers.
35309a3aaf3SDag-Erling Smørgrav	# caps-whitelist: "licdn.com"
354*b5663de9SDag-Erling Smørgrav	# caps-whitelist: "senderbase.org"
35509a3aaf3SDag-Erling Smørgrav
356b7579f77SDag-Erling Smørgrav	# Enforce privacy of these addresses. Strips them away from answers.
357b7579f77SDag-Erling Smørgrav	# It may cause DNSSEC validation to additionally mark it as bogus.
358b7579f77SDag-Erling Smørgrav	# Protects against 'DNS Rebinding' (uses browser as network proxy).
359b7579f77SDag-Erling Smørgrav	# Only 'private-domain' and 'local-data' names are allowed to have
360b7579f77SDag-Erling Smørgrav	# these private addresses. No default.
361b7579f77SDag-Erling Smørgrav	# private-address: 10.0.0.0/8
362b7579f77SDag-Erling Smørgrav	# private-address: 172.16.0.0/12
363b7579f77SDag-Erling Smørgrav	# private-address: 192.168.0.0/16
364b7579f77SDag-Erling Smørgrav	# private-address: 169.254.0.0/16
365b7579f77SDag-Erling Smørgrav	# private-address: fd00::/8
366b7579f77SDag-Erling Smørgrav	# private-address: fe80::/10
36705ab2901SDag-Erling Smørgrav	# private-address: ::ffff:0:0/96
368b7579f77SDag-Erling Smørgrav
369b7579f77SDag-Erling Smørgrav	# Allow the domain (and its subdomains) to contain private addresses.
370b7579f77SDag-Erling Smørgrav	# local-data statements are allowed to contain private addresses too.
371b7579f77SDag-Erling Smørgrav	# private-domain: "example.com"
372b7579f77SDag-Erling Smørgrav
373b7579f77SDag-Erling Smørgrav	# If nonzero, unwanted replies are not only reported in statistics,
374b7579f77SDag-Erling Smørgrav	# but also a running total is kept per thread. If it reaches the
375b7579f77SDag-Erling Smørgrav	# threshold, a warning is printed and a defensive action is taken,
376b7579f77SDag-Erling Smørgrav	# the cache is cleared to flush potential poison out of it.
377b7579f77SDag-Erling Smørgrav	# A suggested value is 10000000, the default is 0 (turned off).
378b7579f77SDag-Erling Smørgrav	# unwanted-reply-threshold: 0
379b7579f77SDag-Erling Smørgrav
380b7579f77SDag-Erling Smørgrav	# Do not query the following addresses. No DNS queries are sent there.
381b7579f77SDag-Erling Smørgrav	# List one address per entry. List classless netblocks with /size,
382b7579f77SDag-Erling Smørgrav	# do-not-query-address: 127.0.0.1/8
383b7579f77SDag-Erling Smørgrav	# do-not-query-address: ::1
384b7579f77SDag-Erling Smørgrav
385b7579f77SDag-Erling Smørgrav	# if yes, the above default do-not-query-address entries are present.
386b7579f77SDag-Erling Smørgrav	# if no, localhost can be queried (for testing and debugging).
387b7579f77SDag-Erling Smørgrav	# do-not-query-localhost: yes
388b7579f77SDag-Erling Smørgrav
389b7579f77SDag-Erling Smørgrav	# if yes, perform prefetching of almost expired message cache entries.
390b7579f77SDag-Erling Smørgrav	# prefetch: no
391b7579f77SDag-Erling Smørgrav
392b7579f77SDag-Erling Smørgrav	# if yes, perform key lookups adjacent to normal lookups.
393b7579f77SDag-Erling Smørgrav	# prefetch-key: no
394b7579f77SDag-Erling Smørgrav
395b7579f77SDag-Erling Smørgrav	# if yes, Unbound rotates RRSet order in response.
396b7579f77SDag-Erling Smørgrav	# rrset-roundrobin: no
397b7579f77SDag-Erling Smørgrav
398b7579f77SDag-Erling Smørgrav	# if yes, Unbound doesn't insert authority/additional sections
399b7579f77SDag-Erling Smørgrav	# into response messages when those sections are not required.
400b7579f77SDag-Erling Smørgrav	# minimal-responses: no
401b7579f77SDag-Erling Smørgrav
402e2d15004SDag-Erling Smørgrav	# true to disable DNSSEC lameness check in iterator.
403e2d15004SDag-Erling Smørgrav	# disable-dnssec-lame-check: no
404e2d15004SDag-Erling Smørgrav
405b7579f77SDag-Erling Smørgrav	# module configuration of the server. A string with identifiers
406ff825849SDag-Erling Smørgrav	# separated by spaces. Syntax: "[dns64] [validator] iterator"
407b7579f77SDag-Erling Smørgrav	# module-config: "validator iterator"
408b7579f77SDag-Erling Smørgrav
409b7579f77SDag-Erling Smørgrav	# File with trusted keys, kept uptodate using RFC5011 probes,
410b7579f77SDag-Erling Smørgrav	# initial file like trust-anchor-file, then it stores metadata.
411b7579f77SDag-Erling Smørgrav	# Use several entries, one per domain name, to track multiple zones.
412b7579f77SDag-Erling Smørgrav	#
413b7579f77SDag-Erling Smørgrav	# If you want to perform DNSSEC validation, run unbound-anchor before
414b7579f77SDag-Erling Smørgrav	# you start unbound (i.e. in the system boot scripts).  And enable:
415b7579f77SDag-Erling Smørgrav	# Please note usage of unbound-anchor root anchor is at your own risk
416b7579f77SDag-Erling Smørgrav	# and under the terms of our LICENSE (see that file in the source).
417b7579f77SDag-Erling Smørgrav	# auto-trust-anchor-file: "@UNBOUND_ROOTKEY_FILE@"
418b7579f77SDag-Erling Smørgrav
419b7579f77SDag-Erling Smørgrav	# File with DLV trusted keys. Same format as trust-anchor-file.
420b7579f77SDag-Erling Smørgrav	# There can be only one DLV configured, it is trusted from root down.
42109a3aaf3SDag-Erling Smørgrav	# DLV is going to be decommissioned.  Please do not use it any more.
422b7579f77SDag-Erling Smørgrav	# dlv-anchor-file: "dlv.isc.org.key"
423b7579f77SDag-Erling Smørgrav
424b7579f77SDag-Erling Smørgrav	# File with trusted keys for validation. Specify more than one file
425b7579f77SDag-Erling Smørgrav	# with several entries, one file per entry.
426b7579f77SDag-Erling Smørgrav	# Zone file format, with DS and DNSKEY entries.
427b7579f77SDag-Erling Smørgrav	# Note this gets out of date, use auto-trust-anchor-file please.
428b7579f77SDag-Erling Smørgrav	# trust-anchor-file: ""
429b7579f77SDag-Erling Smørgrav
430b7579f77SDag-Erling Smørgrav	# Trusted key for validation. DS or DNSKEY. specify the RR on a
431b7579f77SDag-Erling Smørgrav	# single line, surrounded by "". TTL is ignored. class is IN default.
432b7579f77SDag-Erling Smørgrav	# Note this gets out of date, use auto-trust-anchor-file please.
433b7579f77SDag-Erling Smørgrav	# (These examples are from August 2007 and may not be valid anymore).
434b7579f77SDag-Erling Smørgrav	# trust-anchor: "nlnetlabs.nl. DNSKEY 257 3 5 AQPzzTWMz8qSWIQlfRnPckx2BiVmkVN6LPupO3mbz7FhLSnm26n6iG9N Lby97Ji453aWZY3M5/xJBSOS2vWtco2t8C0+xeO1bc/d6ZTy32DHchpW 6rDH1vp86Ll+ha0tmwyy9QP7y2bVw5zSbFCrefk8qCUBgfHm9bHzMG1U BYtEIQ=="
435b7579f77SDag-Erling Smørgrav	# trust-anchor: "jelte.nlnetlabs.nl. DS 42860 5 1 14D739EB566D2B1A5E216A0BA4D17FA9B038BE4A"
436b7579f77SDag-Erling Smørgrav
437b7579f77SDag-Erling Smørgrav	# File with trusted keys for validation. Specify more than one file
438b7579f77SDag-Erling Smørgrav	# with several entries, one file per entry. Like trust-anchor-file
439b7579f77SDag-Erling Smørgrav	# but has a different file format. Format is BIND-9 style format,
440b7579f77SDag-Erling Smørgrav	# the trusted-keys { name flag proto algo "key"; }; clauses are read.
441b7579f77SDag-Erling Smørgrav	# you need external update procedures to track changes in keys.
442b7579f77SDag-Erling Smørgrav	# trusted-keys-file: ""
443b7579f77SDag-Erling Smørgrav
444b7579f77SDag-Erling Smørgrav	# Ignore chain of trust. Domain is treated as insecure.
445b7579f77SDag-Erling Smørgrav	# domain-insecure: "example.com"
446b7579f77SDag-Erling Smørgrav
447b7579f77SDag-Erling Smørgrav	# Override the date for validation with a specific fixed date.
448b7579f77SDag-Erling Smørgrav	# Do not set this unless you are debugging signature inception
449b7579f77SDag-Erling Smørgrav	# and expiration. "" or "0" turns the feature off. -1 ignores date.
450b7579f77SDag-Erling Smørgrav	# val-override-date: ""
451b7579f77SDag-Erling Smørgrav
452b7579f77SDag-Erling Smørgrav	# The time to live for bogus data, rrsets and messages. This avoids
453b7579f77SDag-Erling Smørgrav	# some of the revalidation, until the time interval expires. in secs.
454b7579f77SDag-Erling Smørgrav	# val-bogus-ttl: 60
455b7579f77SDag-Erling Smørgrav
456b7579f77SDag-Erling Smørgrav	# The signature inception and expiration dates are allowed to be off
457b7579f77SDag-Erling Smørgrav	# by 10% of the signature lifetime (expir-incep) from our local clock.
458b7579f77SDag-Erling Smørgrav	# This leeway is capped with a minimum and a maximum.  In seconds.
459b7579f77SDag-Erling Smørgrav	# val-sig-skew-min: 3600
460b7579f77SDag-Erling Smørgrav	# val-sig-skew-max: 86400
461b7579f77SDag-Erling Smørgrav
462b7579f77SDag-Erling Smørgrav	# Should additional section of secure message also be kept clean of
463b7579f77SDag-Erling Smørgrav	# unsecure data. Useful to shield the users of this validator from
464b7579f77SDag-Erling Smørgrav	# potential bogus data in the additional section. All unsigned data
465b7579f77SDag-Erling Smørgrav	# in the additional section is removed from secure messages.
466b7579f77SDag-Erling Smørgrav	# val-clean-additional: yes
467b7579f77SDag-Erling Smørgrav
468b7579f77SDag-Erling Smørgrav	# Turn permissive mode on to permit bogus messages. Thus, messages
469b7579f77SDag-Erling Smørgrav	# for which security checks failed will be returned to clients,
470b7579f77SDag-Erling Smørgrav	# instead of SERVFAIL. It still performs the security checks, which
471b7579f77SDag-Erling Smørgrav	# result in interesting log files and possibly the AD bit in
472b7579f77SDag-Erling Smørgrav	# replies if the message is found secure. The default is off.
473b7579f77SDag-Erling Smørgrav	# val-permissive-mode: no
474b7579f77SDag-Erling Smørgrav
475b7579f77SDag-Erling Smørgrav	# Ignore the CD flag in incoming queries and refuse them bogus data.
476b7579f77SDag-Erling Smørgrav	# Enable it if the only clients of unbound are legacy servers (w2008)
477b7579f77SDag-Erling Smørgrav	# that set CD but cannot validate themselves.
478b7579f77SDag-Erling Smørgrav	# ignore-cd-flag: no
479b7579f77SDag-Erling Smørgrav
480b7579f77SDag-Erling Smørgrav	# Have the validator log failed validations for your diagnosis.
481b7579f77SDag-Erling Smørgrav	# 0: off. 1: A line per failed user query. 2: With reason and bad IP.
482b7579f77SDag-Erling Smørgrav	# val-log-level: 0
483b7579f77SDag-Erling Smørgrav
484b7579f77SDag-Erling Smørgrav	# It is possible to configure NSEC3 maximum iteration counts per
485b7579f77SDag-Erling Smørgrav	# keysize. Keep this table very short, as linear search is done.
486b7579f77SDag-Erling Smørgrav	# A message with an NSEC3 with larger count is marked insecure.
487b7579f77SDag-Erling Smørgrav	# List in ascending order the keysize and count values.
488b7579f77SDag-Erling Smørgrav	# val-nsec3-keysize-iterations: "1024 150 2048 500 4096 2500"
489b7579f77SDag-Erling Smørgrav
490b7579f77SDag-Erling Smørgrav	# instruct the auto-trust-anchor-file probing to add anchors after ttl.
491b7579f77SDag-Erling Smørgrav	# add-holddown: 2592000 # 30 days
492b7579f77SDag-Erling Smørgrav
493b7579f77SDag-Erling Smørgrav	# instruct the auto-trust-anchor-file probing to del anchors after ttl.
494b7579f77SDag-Erling Smørgrav	# del-holddown: 2592000 # 30 days
495b7579f77SDag-Erling Smørgrav
496b7579f77SDag-Erling Smørgrav	# auto-trust-anchor-file probing removes missing anchors after ttl.
497b7579f77SDag-Erling Smørgrav	# If the value 0 is given, missing anchors are not removed.
498b7579f77SDag-Erling Smørgrav	# keep-missing: 31622400 # 366 days
499b7579f77SDag-Erling Smørgrav
500e2d15004SDag-Erling Smørgrav	# debug option that allows very small holddown times for key rollover,
501e2d15004SDag-Erling Smørgrav	# otherwise the RFC mandates probe intervals must be at least 1 hour.
502b75612f8SDag-Erling Smørgrav	# permit-small-holddown: no
503b75612f8SDag-Erling Smørgrav
504b7579f77SDag-Erling Smørgrav	# the amount of memory to use for the key cache.
505b7579f77SDag-Erling Smørgrav	# plain value in bytes or you can append k, m or G. default is "4Mb".
506b7579f77SDag-Erling Smørgrav	# key-cache-size: 4m
507b7579f77SDag-Erling Smørgrav
508b7579f77SDag-Erling Smørgrav	# the number of slabs to use for the key cache.
509b7579f77SDag-Erling Smørgrav	# the number of slabs must be a power of 2.
510b7579f77SDag-Erling Smørgrav	# more slabs reduce lock contention, but fragment memory usage.
511b7579f77SDag-Erling Smørgrav	# key-cache-slabs: 4
512b7579f77SDag-Erling Smørgrav
513b7579f77SDag-Erling Smørgrav	# the amount of memory to use for the negative cache (used for DLV).
514b7579f77SDag-Erling Smørgrav	# plain value in bytes or you can append k, m or G. default is "1Mb".
515b7579f77SDag-Erling Smørgrav	# neg-cache-size: 1m
516b7579f77SDag-Erling Smørgrav
51717d15b25SDag-Erling Smørgrav	# By default, for a number of zones a small default 'nothing here'
51817d15b25SDag-Erling Smørgrav	# reply is built-in.  Query traffic is thus blocked.  If you
51917d15b25SDag-Erling Smørgrav	# wish to serve such zone you can unblock them by uncommenting one
52017d15b25SDag-Erling Smørgrav	# of the nodefault statements below.
52117d15b25SDag-Erling Smørgrav	# You may also have to use domain-insecure: zone to make DNSSEC work,
52217d15b25SDag-Erling Smørgrav	# unless you have your own trust anchors for this zone.
52317d15b25SDag-Erling Smørgrav	# local-zone: "localhost." nodefault
52417d15b25SDag-Erling Smørgrav	# local-zone: "127.in-addr.arpa." nodefault
52517d15b25SDag-Erling Smørgrav	# local-zone: "1.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.ip6.arpa." nodefault
526f61ef7f6SDag-Erling Smørgrav	# local-zone: "onion." nodefault
52717d15b25SDag-Erling Smørgrav	# local-zone: "10.in-addr.arpa." nodefault
52817d15b25SDag-Erling Smørgrav	# local-zone: "16.172.in-addr.arpa." nodefault
52917d15b25SDag-Erling Smørgrav	# local-zone: "17.172.in-addr.arpa." nodefault
53017d15b25SDag-Erling Smørgrav	# local-zone: "18.172.in-addr.arpa." nodefault
53117d15b25SDag-Erling Smørgrav	# local-zone: "19.172.in-addr.arpa." nodefault
53217d15b25SDag-Erling Smørgrav	# local-zone: "20.172.in-addr.arpa." nodefault
53317d15b25SDag-Erling Smørgrav	# local-zone: "21.172.in-addr.arpa." nodefault
53417d15b25SDag-Erling Smørgrav	# local-zone: "22.172.in-addr.arpa." nodefault
53517d15b25SDag-Erling Smørgrav	# local-zone: "23.172.in-addr.arpa." nodefault
53617d15b25SDag-Erling Smørgrav	# local-zone: "24.172.in-addr.arpa." nodefault
53717d15b25SDag-Erling Smørgrav	# local-zone: "25.172.in-addr.arpa." nodefault
53817d15b25SDag-Erling Smørgrav	# local-zone: "26.172.in-addr.arpa." nodefault
53917d15b25SDag-Erling Smørgrav	# local-zone: "27.172.in-addr.arpa." nodefault
54017d15b25SDag-Erling Smørgrav	# local-zone: "28.172.in-addr.arpa." nodefault
54117d15b25SDag-Erling Smørgrav	# local-zone: "29.172.in-addr.arpa." nodefault
54217d15b25SDag-Erling Smørgrav	# local-zone: "30.172.in-addr.arpa." nodefault
54317d15b25SDag-Erling Smørgrav	# local-zone: "31.172.in-addr.arpa." nodefault
54417d15b25SDag-Erling Smørgrav	# local-zone: "168.192.in-addr.arpa." nodefault
54517d15b25SDag-Erling Smørgrav	# local-zone: "0.in-addr.arpa." nodefault
54617d15b25SDag-Erling Smørgrav	# local-zone: "254.169.in-addr.arpa." nodefault
54717d15b25SDag-Erling Smørgrav	# local-zone: "2.0.192.in-addr.arpa." nodefault
54817d15b25SDag-Erling Smørgrav	# local-zone: "100.51.198.in-addr.arpa." nodefault
54917d15b25SDag-Erling Smørgrav	# local-zone: "113.0.203.in-addr.arpa." nodefault
55017d15b25SDag-Erling Smørgrav	# local-zone: "255.255.255.255.in-addr.arpa." nodefault
55117d15b25SDag-Erling Smørgrav	# local-zone: "0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.ip6.arpa." nodefault
55217d15b25SDag-Erling Smørgrav	# local-zone: "d.f.ip6.arpa." nodefault
55317d15b25SDag-Erling Smørgrav	# local-zone: "8.e.f.ip6.arpa." nodefault
55417d15b25SDag-Erling Smørgrav	# local-zone: "9.e.f.ip6.arpa." nodefault
55517d15b25SDag-Erling Smørgrav	# local-zone: "a.e.f.ip6.arpa." nodefault
55617d15b25SDag-Erling Smørgrav	# local-zone: "b.e.f.ip6.arpa." nodefault
55717d15b25SDag-Erling Smørgrav	# local-zone: "8.b.d.0.1.0.0.2.ip6.arpa." nodefault
558ff825849SDag-Erling Smørgrav	# And for 64.100.in-addr.arpa. to 127.100.in-addr.arpa.
559ff825849SDag-Erling Smørgrav
5600de4f1bfSDag-Erling Smørgrav	# If unbound is running service for the local host then it is useful
561ff825849SDag-Erling Smørgrav	# to perform lan-wide lookups to the upstream, and unblock the
562ff825849SDag-Erling Smørgrav	# long list of local-zones above.  If this unbound is a dns server
563ff825849SDag-Erling Smørgrav	# for a network of computers, disabled is better and stops information
564ff825849SDag-Erling Smørgrav	# leakage of local lan information.
565ff825849SDag-Erling Smørgrav	# unblock-lan-zones: no
56617d15b25SDag-Erling Smørgrav
5670de4f1bfSDag-Erling Smørgrav	# The insecure-lan-zones option disables validation for
5680de4f1bfSDag-Erling Smørgrav	# these zones, as if they were all listed as domain-insecure.
5690de4f1bfSDag-Erling Smørgrav	# insecure-lan-zones: no
5700de4f1bfSDag-Erling Smørgrav
571b7579f77SDag-Erling Smørgrav	# a number of locally served zones can be configured.
572b7579f77SDag-Erling Smørgrav	# 	local-zone: <zone> <type>
573b7579f77SDag-Erling Smørgrav	# 	local-data: "<resource record string>"
574b7579f77SDag-Erling Smørgrav	# o deny serves local data (if any), else, drops queries.
575b7579f77SDag-Erling Smørgrav	# o refuse serves local data (if any), else, replies with error.
576b7579f77SDag-Erling Smørgrav	# o static serves local data, else, nxdomain or nodata answer.
577b7579f77SDag-Erling Smørgrav	# o transparent gives local data, but resolves normally for other names
578b7579f77SDag-Erling Smørgrav	# o redirect serves the zone data for any subdomain in the zone.
579b7579f77SDag-Erling Smørgrav	# o nodefault can be used to normally resolve AS112 zones.
580b7579f77SDag-Erling Smørgrav	# o typetransparent resolves normally for other types and other names
5816480faa8SDag-Erling Smørgrav	# o inform resolves normally, but logs client IP address
58209a3aaf3SDag-Erling Smørgrav	# o inform_deny drops queries and logs client IP address
583*b5663de9SDag-Erling Smørgrav	# o always_transparent, always_refuse, always_nxdomain, resolve in
584*b5663de9SDag-Erling Smørgrav	#   that way but ignore local data for that name.
585b7579f77SDag-Erling Smørgrav	#
586b7579f77SDag-Erling Smørgrav	# defaults are localhost address, reverse for 127.0.0.1 and ::1
587b7579f77SDag-Erling Smørgrav	# and nxdomain for AS112 zones. If you configure one of these zones
588b7579f77SDag-Erling Smørgrav	# the default content is omitted, or you can omit it with 'nodefault'.
589b7579f77SDag-Erling Smørgrav	#
590b7579f77SDag-Erling Smørgrav	# If you configure local-data without specifying local-zone, by
591b7579f77SDag-Erling Smørgrav	# default a transparent local-zone is created for the data.
592b7579f77SDag-Erling Smørgrav	#
593b7579f77SDag-Erling Smørgrav	# You can add locally served data with
594b7579f77SDag-Erling Smørgrav	# local-zone: "local." static
595b7579f77SDag-Erling Smørgrav	# local-data: "mycomputer.local. IN A 192.0.2.51"
596b7579f77SDag-Erling Smørgrav	# local-data: 'mytext.local TXT "content of text record"'
597b7579f77SDag-Erling Smørgrav	#
598b7579f77SDag-Erling Smørgrav	# You can override certain queries with
599b7579f77SDag-Erling Smørgrav	# local-data: "adserver.example.com A 127.0.0.1"
600b7579f77SDag-Erling Smørgrav	#
601b7579f77SDag-Erling Smørgrav	# You can redirect a domain to a fixed address with
602b7579f77SDag-Erling Smørgrav	# (this makes example.com, www.example.com, etc, all go to 192.0.2.3)
603b7579f77SDag-Erling Smørgrav	# local-zone: "example.com" redirect
604b7579f77SDag-Erling Smørgrav	# local-data: "example.com A 192.0.2.3"
605b7579f77SDag-Erling Smørgrav	#
606b7579f77SDag-Erling Smørgrav	# Shorthand to make PTR records, "IPv4 name" or "IPv6 name".
607b7579f77SDag-Erling Smørgrav	# You can also add PTR records using local-data directly, but then
608b7579f77SDag-Erling Smørgrav	# you need to do the reverse notation yourself.
609b7579f77SDag-Erling Smørgrav	# local-data-ptr: "192.0.2.3 www.example.com"
610b7579f77SDag-Erling Smørgrav
611*b5663de9SDag-Erling Smørgrav	# tag a localzone with a list of tag names (in "" with spaces between)
612*b5663de9SDag-Erling Smørgrav	# local-zone-tag: "example.com" "tag2 tag3"
613*b5663de9SDag-Erling Smørgrav
614*b5663de9SDag-Erling Smørgrav	# add a netblock specific override to a localzone, with zone type
615*b5663de9SDag-Erling Smørgrav	# local-zone-override: "example.com" 192.0.2.0/24 refuse
616*b5663de9SDag-Erling Smørgrav
617b7579f77SDag-Erling Smørgrav	# service clients over SSL (on the TCP sockets), with plain DNS inside
618b7579f77SDag-Erling Smørgrav	# the SSL stream.  Give the certificate to use and private key.
619b7579f77SDag-Erling Smørgrav	# default is "" (disabled).  requires restart to take effect.
620b7579f77SDag-Erling Smørgrav	# ssl-service-key: "path/to/privatekeyfile.key"
621b7579f77SDag-Erling Smørgrav	# ssl-service-pem: "path/to/publiccertfile.pem"
62205ab2901SDag-Erling Smørgrav	# ssl-port: 853
623b7579f77SDag-Erling Smørgrav
624b7579f77SDag-Erling Smørgrav	# request upstream over SSL (with plain DNS inside the SSL stream).
625b7579f77SDag-Erling Smørgrav	# Default is no.  Can be turned on and off with unbound-control.
626b7579f77SDag-Erling Smørgrav	# ssl-upstream: no
627b7579f77SDag-Erling Smørgrav
628ff825849SDag-Erling Smørgrav	# DNS64 prefix. Must be specified when DNS64 is use.
629ff825849SDag-Erling Smørgrav	# Enable dns64 in module-config.  Used to synthesize IPv6 from IPv4.
630ff825849SDag-Erling Smørgrav	# dns64-prefix: 64:ff9b::0/96
631ff825849SDag-Erling Smørgrav
63209a3aaf3SDag-Erling Smørgrav	# ratelimit for uncached, new queries, this limits recursion effort.
63309a3aaf3SDag-Erling Smørgrav	# ratelimiting is experimental, and may help against randomqueryflood.
63409a3aaf3SDag-Erling Smørgrav	# if 0(default) it is disabled, otherwise state qps allowed per zone.
63509a3aaf3SDag-Erling Smørgrav	# ratelimit: 0
63609a3aaf3SDag-Erling Smørgrav
63709a3aaf3SDag-Erling Smørgrav	# ratelimits are tracked in a cache, size in bytes of cache (or k,m).
63809a3aaf3SDag-Erling Smørgrav	# ratelimit-size: 4m
63909a3aaf3SDag-Erling Smørgrav	# ratelimit cache slabs, reduces lock contention if equal to cpucount.
64009a3aaf3SDag-Erling Smørgrav	# ratelimit-slabs: 4
64109a3aaf3SDag-Erling Smørgrav
64209a3aaf3SDag-Erling Smørgrav	# 0 blocks when ratelimited, otherwise let 1/xth traffic through
64309a3aaf3SDag-Erling Smørgrav	# ratelimit-factor: 10
64409a3aaf3SDag-Erling Smørgrav
64509a3aaf3SDag-Erling Smørgrav	# override the ratelimit for a specific domain name.
64609a3aaf3SDag-Erling Smørgrav	# give this setting multiple times to have multiple overrides.
64709a3aaf3SDag-Erling Smørgrav	# ratelimit-for-domain: example.com 1000
64809a3aaf3SDag-Erling Smørgrav	# override the ratelimits for all domains below a domain name
64909a3aaf3SDag-Erling Smørgrav	# can give this multiple times, the name closest to the zone is used.
650*b5663de9SDag-Erling Smørgrav	# ratelimit-below-domain: com 1000
65109a3aaf3SDag-Erling Smørgrav
652b7579f77SDag-Erling Smørgrav# Python config section. To enable:
653b7579f77SDag-Erling Smørgrav# o use --with-pythonmodule to configure before compiling.
654b7579f77SDag-Erling Smørgrav# o list python in the module-config string (above) to enable.
655b7579f77SDag-Erling Smørgrav# o and give a python-script to run.
656b7579f77SDag-Erling Smørgravpython:
657b7579f77SDag-Erling Smørgrav	# Script file to load
658b7579f77SDag-Erling Smørgrav	# python-script: "@UNBOUND_SHARE_DIR@/ubmodule-tst.py"
659b7579f77SDag-Erling Smørgrav
660b7579f77SDag-Erling Smørgrav# Remote control config section.
661b7579f77SDag-Erling Smørgravremote-control:
662b7579f77SDag-Erling Smørgrav	# Enable remote control with unbound-control(8) here.
663b7579f77SDag-Erling Smørgrav	# set up the keys and certificates with unbound-control-setup.
664b7579f77SDag-Erling Smørgrav	# control-enable: no
665b7579f77SDag-Erling Smørgrav
6666480faa8SDag-Erling Smørgrav	# Set to no and use an absolute path as control-interface to use
6676480faa8SDag-Erling Smørgrav	# a unix local named pipe for unbound-control.
6686480faa8SDag-Erling Smørgrav	# control-use-cert: yes
6696480faa8SDag-Erling Smørgrav
670b7579f77SDag-Erling Smørgrav	# what interfaces are listened to for remote control.
671b7579f77SDag-Erling Smørgrav	# give 0.0.0.0 and ::0 to listen to all interfaces.
672b7579f77SDag-Erling Smørgrav	# control-interface: 127.0.0.1
673b7579f77SDag-Erling Smørgrav	# control-interface: ::1
674b7579f77SDag-Erling Smørgrav
675b7579f77SDag-Erling Smørgrav	# port number for remote control operations.
676b7579f77SDag-Erling Smørgrav	# control-port: 8953
677b7579f77SDag-Erling Smørgrav
678b7579f77SDag-Erling Smørgrav	# unbound server key file.
679b7579f77SDag-Erling Smørgrav	# server-key-file: "@UNBOUND_RUN_DIR@/unbound_server.key"
680b7579f77SDag-Erling Smørgrav
681b7579f77SDag-Erling Smørgrav	# unbound server certificate file.
682b7579f77SDag-Erling Smørgrav	# server-cert-file: "@UNBOUND_RUN_DIR@/unbound_server.pem"
683b7579f77SDag-Erling Smørgrav
684b7579f77SDag-Erling Smørgrav	# unbound-control key file.
685b7579f77SDag-Erling Smørgrav	# control-key-file: "@UNBOUND_RUN_DIR@/unbound_control.key"
686b7579f77SDag-Erling Smørgrav
687b7579f77SDag-Erling Smørgrav	# unbound-control certificate file.
688b7579f77SDag-Erling Smørgrav	# control-cert-file: "@UNBOUND_RUN_DIR@/unbound_control.pem"
689b7579f77SDag-Erling Smørgrav
690b7579f77SDag-Erling Smørgrav# Stub zones.
691b7579f77SDag-Erling Smørgrav# Create entries like below, to make all queries for 'example.com' and
692b7579f77SDag-Erling Smørgrav# 'example.org' go to the given list of nameservers. list zero or more
693b7579f77SDag-Erling Smørgrav# nameservers by hostname or by ipaddress. If you set stub-prime to yes,
694b7579f77SDag-Erling Smørgrav# the list is treated as priming hints (default is no).
695b7579f77SDag-Erling Smørgrav# With stub-first yes, it attempts without the stub if it fails.
696b75612f8SDag-Erling Smørgrav# Consider adding domain-insecure: name and local-zone: name nodefault
697b75612f8SDag-Erling Smørgrav# to the server: section if the stub is a locally served zone.
698b7579f77SDag-Erling Smørgrav# stub-zone:
699b7579f77SDag-Erling Smørgrav#	name: "example.com"
700b7579f77SDag-Erling Smørgrav#	stub-addr: 192.0.2.68
701b7579f77SDag-Erling Smørgrav#	stub-prime: no
702b7579f77SDag-Erling Smørgrav#	stub-first: no
703b7579f77SDag-Erling Smørgrav# stub-zone:
704b7579f77SDag-Erling Smørgrav#	name: "example.org"
705b7579f77SDag-Erling Smørgrav#	stub-host: ns.example.com.
706b7579f77SDag-Erling Smørgrav
707b7579f77SDag-Erling Smørgrav# Forward zones
708b7579f77SDag-Erling Smørgrav# Create entries like below, to make all queries for 'example.com' and
709b7579f77SDag-Erling Smørgrav# 'example.org' go to the given list of servers. These servers have to handle
710b7579f77SDag-Erling Smørgrav# recursion to other nameservers. List zero or more nameservers by hostname
711b7579f77SDag-Erling Smørgrav# or by ipaddress. Use an entry with name "." to forward all queries.
712b7579f77SDag-Erling Smørgrav# If you enable forward-first, it attempts without the forward if it fails.
713b7579f77SDag-Erling Smørgrav# forward-zone:
714b7579f77SDag-Erling Smørgrav# 	name: "example.com"
715b7579f77SDag-Erling Smørgrav# 	forward-addr: 192.0.2.68
716b7579f77SDag-Erling Smørgrav# 	forward-addr: 192.0.2.73@5355  # forward to port 5355.
717b7579f77SDag-Erling Smørgrav# 	forward-first: no
718b7579f77SDag-Erling Smørgrav# forward-zone:
719b7579f77SDag-Erling Smørgrav# 	name: "example.org"
720b7579f77SDag-Erling Smørgrav# 	forward-host: fwd.example.com
721