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