xref: /freebsd/contrib/unbound/doc/example.conf.in (revision 865f46b255599c4a645e84a4cbb5ea7abdc0e207)
1b7579f77SDag-Erling Smørgrav#
2b7579f77SDag-Erling Smørgrav# Example configuration file.
3b7579f77SDag-Erling Smørgrav#
4*865f46b2SCy Schubert# See unbound.conf(5) man page, version 1.17.0.
5b7579f77SDag-Erling Smørgrav#
6b7579f77SDag-Erling Smørgrav# this is a comment.
7b7579f77SDag-Erling Smørgrav
825039b37SCy Schubert# Use this anywhere in the file to include other text into this file.
9b7579f77SDag-Erling Smørgrav#include: "otherfile.conf"
10b7579f77SDag-Erling Smørgrav
1125039b37SCy Schubert# Use this anywhere in the file to include other text, that explicitly starts a
1225039b37SCy Schubert# clause, into this file. Text after this directive needs to start a clause.
1325039b37SCy Schubert#include-toplevel: "otherfile.conf"
1425039b37SCy Schubert
15b7579f77SDag-Erling Smørgrav# The server clause sets the main parameters.
16b7579f77SDag-Erling Smørgravserver:
17b7579f77SDag-Erling Smørgrav	# whitespace is not necessary, but looks cleaner.
18b7579f77SDag-Erling Smørgrav
19b7579f77SDag-Erling Smørgrav	# verbosity number, 0 is least verbose. 1 is default.
20*865f46b2SCy Schubert	# verbosity: 1
21b7579f77SDag-Erling Smørgrav
22b7579f77SDag-Erling Smørgrav	# print statistics to the log (for every thread) every N seconds.
23b7579f77SDag-Erling Smørgrav	# Set to "" or 0 to disable. Default is disabled.
24b7579f77SDag-Erling Smørgrav	# statistics-interval: 0
25b7579f77SDag-Erling Smørgrav
2665b390aaSDag-Erling Smørgrav	# enable shm for stats, default no.  if you enable also enable
2765b390aaSDag-Erling Smørgrav	# statistics-interval, every time it also writes stats to the
2865b390aaSDag-Erling Smørgrav	# shared memory segment keyed with shm-key.
2965b390aaSDag-Erling Smørgrav	# shm-enable: no
3065b390aaSDag-Erling Smørgrav
3165b390aaSDag-Erling Smørgrav	# shm for stats uses this key, and key+1 for the shared mem segment.
3265b390aaSDag-Erling Smørgrav	# shm-key: 11777
3365b390aaSDag-Erling Smørgrav
34b7579f77SDag-Erling Smørgrav	# enable cumulative statistics, without clearing them after printing.
35b7579f77SDag-Erling Smørgrav	# statistics-cumulative: no
36b7579f77SDag-Erling Smørgrav
37b7579f77SDag-Erling Smørgrav	# enable extended statistics (query types, answer codes, status)
38b7579f77SDag-Erling Smørgrav	# printed from unbound-control. default off, because of speed.
39b7579f77SDag-Erling Smørgrav	# extended-statistics: no
40b7579f77SDag-Erling Smørgrav
41b7579f77SDag-Erling Smørgrav	# number of threads to create. 1 disables threading.
42b7579f77SDag-Erling Smørgrav	# num-threads: 1
43b7579f77SDag-Erling Smørgrav
44b7579f77SDag-Erling Smørgrav	# specify the interfaces to answer queries from by ip-address.
45b7579f77SDag-Erling Smørgrav	# The default is to listen to localhost (127.0.0.1 and ::1).
46b7579f77SDag-Erling Smørgrav	# specify 0.0.0.0 and ::0 to bind to all available interfaces.
47b7579f77SDag-Erling Smørgrav	# specify every interface[@port] on a new 'interface:' labelled line.
48b7579f77SDag-Erling Smørgrav	# The listen interfaces are not changed on reload, only on restart.
49b7579f77SDag-Erling Smørgrav	# interface: 192.0.2.153
50b7579f77SDag-Erling Smørgrav	# interface: 192.0.2.154
51b7579f77SDag-Erling Smørgrav	# interface: 192.0.2.154@5003
52b7579f77SDag-Erling Smørgrav	# interface: 2001:DB8::5
53*865f46b2SCy Schubert	# interface: eth0@5003
54b7579f77SDag-Erling Smørgrav
55b7579f77SDag-Erling Smørgrav	# enable this feature to copy the source address of queries to reply.
56b7579f77SDag-Erling Smørgrav	# Socket options are not supported on all platforms. experimental.
57b7579f77SDag-Erling Smørgrav	# interface-automatic: no
58b7579f77SDag-Erling Smørgrav
59a39a5a69SCy Schubert	# instead of the default port, open additional ports separated by
60a39a5a69SCy Schubert	# spaces when interface-automatic is enabled, by listing them here.
61a39a5a69SCy Schubert	# interface-automatic-ports: ""
62a39a5a69SCy Schubert
63b7579f77SDag-Erling Smørgrav	# port to answer queries from
64b7579f77SDag-Erling Smørgrav	# port: 53
65b7579f77SDag-Erling Smørgrav
66b7579f77SDag-Erling Smørgrav	# specify the interfaces to send outgoing queries to authoritative
67b7579f77SDag-Erling Smørgrav	# server from by ip-address. If none, the default (all) interface
68b7579f77SDag-Erling Smørgrav	# is used. Specify every interface on a 'outgoing-interface:' line.
69b7579f77SDag-Erling Smørgrav	# outgoing-interface: 192.0.2.153
70b7579f77SDag-Erling Smørgrav	# outgoing-interface: 2001:DB8::5
71b7579f77SDag-Erling Smørgrav	# outgoing-interface: 2001:DB8::6
72b7579f77SDag-Erling Smørgrav
73b5663de9SDag-Erling Smørgrav	# Specify a netblock to use remainder 64 bits as random bits for
74b5663de9SDag-Erling Smørgrav	# upstream queries.  Uses freebind option (Linux).
75b5663de9SDag-Erling Smørgrav	# outgoing-interface: 2001:DB8::/64
76b5663de9SDag-Erling Smørgrav	# Also (Linux:) ip -6 addr add 2001:db8::/64 dev lo
77b5663de9SDag-Erling Smørgrav	# And: ip -6 route add local 2001:db8::/64 dev lo
78b5663de9SDag-Erling Smørgrav	# And set prefer-ip6: yes to use the ip6 randomness from a netblock.
79b5663de9SDag-Erling Smørgrav	# Set this to yes to prefer ipv6 upstream servers over ipv4.
80b5663de9SDag-Erling Smørgrav	# prefer-ip6: no
81b5663de9SDag-Erling Smørgrav
8225039b37SCy Schubert	# Prefer ipv4 upstream servers, even if ipv6 is available.
8325039b37SCy Schubert	# prefer-ip4: no
8425039b37SCy Schubert
85b7579f77SDag-Erling Smørgrav	# number of ports to allocate per thread, determines the size of the
86b7579f77SDag-Erling Smørgrav	# port range that can be open simultaneously.  About double the
87b7579f77SDag-Erling Smørgrav	# num-queries-per-thread, or, use as many as the OS will allow you.
88b7579f77SDag-Erling Smørgrav	# outgoing-range: 4096
89b7579f77SDag-Erling Smørgrav
909cf5bc93SCy Schubert	# permit Unbound to use this port number or port range for
91b7579f77SDag-Erling Smørgrav	# making outgoing queries, using an outgoing interface.
92b7579f77SDag-Erling Smørgrav	# outgoing-port-permit: 32768
93b7579f77SDag-Erling Smørgrav
949cf5bc93SCy Schubert	# deny Unbound the use this of port number or port range for
95b7579f77SDag-Erling Smørgrav	# making outgoing queries, using an outgoing interface.
969cf5bc93SCy Schubert	# Use this to make sure Unbound does not grab a UDP port that some
97b7579f77SDag-Erling Smørgrav	# other server on this computer needs. The default is to avoid
98b7579f77SDag-Erling Smørgrav	# IANA-assigned port numbers.
998ed2b524SDag-Erling Smørgrav	# If multiple outgoing-port-permit and outgoing-port-avoid options
1008ed2b524SDag-Erling Smørgrav	# are present, they are processed in order.
101b7579f77SDag-Erling Smørgrav	# outgoing-port-avoid: "3200-3208"
102b7579f77SDag-Erling Smørgrav
103b7579f77SDag-Erling Smørgrav	# number of outgoing simultaneous tcp buffers to hold per thread.
104b7579f77SDag-Erling Smørgrav	# outgoing-num-tcp: 10
105b7579f77SDag-Erling Smørgrav
106b7579f77SDag-Erling Smørgrav	# number of incoming simultaneous tcp buffers to hold per thread.
107b7579f77SDag-Erling Smørgrav	# incoming-num-tcp: 10
108b7579f77SDag-Erling Smørgrav
109b7579f77SDag-Erling Smørgrav	# buffer size for UDP port 53 incoming (SO_RCVBUF socket option).
110b7579f77SDag-Erling Smørgrav	# 0 is system default.  Use 4m to catch query spikes for busy servers.
111b7579f77SDag-Erling Smørgrav	# so-rcvbuf: 0
112b7579f77SDag-Erling Smørgrav
113b7579f77SDag-Erling Smørgrav	# buffer size for UDP port 53 outgoing (SO_SNDBUF socket option).
114b7579f77SDag-Erling Smørgrav	# 0 is system default.  Use 4m to handle spikes on very busy servers.
115b7579f77SDag-Erling Smørgrav	# so-sndbuf: 0
116b7579f77SDag-Erling Smørgrav
117ff825849SDag-Erling Smørgrav	# use SO_REUSEPORT to distribute queries over threads.
118e86b9096SDag-Erling Smørgrav	# at extreme load it could be better to turn it off to distribute even.
1194c75e3aaSDag-Erling Smørgrav	# so-reuseport: yes
12017d15b25SDag-Erling Smørgrav
12109a3aaf3SDag-Erling Smørgrav	# use IP_TRANSPARENT so the interface: addresses can be non-local
12209a3aaf3SDag-Erling Smørgrav	# and you can config non-existing IPs that are going to work later on
123f61ef7f6SDag-Erling Smørgrav	# (uses IP_BINDANY on FreeBSD).
12409a3aaf3SDag-Erling Smørgrav	# ip-transparent: no
12509a3aaf3SDag-Erling Smørgrav
126e2d15004SDag-Erling Smørgrav	# use IP_FREEBIND so the interface: addresses can be non-local
127e2d15004SDag-Erling Smørgrav	# and you can bind to nonexisting IPs and interfaces that are down.
128e2d15004SDag-Erling Smørgrav	# Linux only.  On Linux you also have ip-transparent that is similar.
129e2d15004SDag-Erling Smørgrav	# ip-freebind: no
130e2d15004SDag-Erling Smørgrav
13125039b37SCy Schubert	# the value of the Differentiated Services Codepoint (DSCP)
13225039b37SCy Schubert	# in the differentiated services field (DS) of the outgoing
13325039b37SCy Schubert	# IP packets
13425039b37SCy Schubert	# ip-dscp: 0
13525039b37SCy Schubert
136b7579f77SDag-Erling Smørgrav	# EDNS reassembly buffer to advertise to UDP peers (the actual buffer
137c0caa2e2SCy Schubert	# is set with msg-buffer-size).
138c0caa2e2SCy Schubert	# edns-buffer-size: 1232
139b7579f77SDag-Erling Smørgrav
14017d15b25SDag-Erling Smørgrav	# Maximum UDP response size (not applied to TCP response).
14117d15b25SDag-Erling Smørgrav	# Suggested values are 512 to 4096. Default is 4096. 65536 disables it.
14217d15b25SDag-Erling Smørgrav	# max-udp-size: 4096
14317d15b25SDag-Erling Smørgrav
144e86b9096SDag-Erling Smørgrav	# max memory to use for stream(tcp and tls) waiting result buffers.
145e86b9096SDag-Erling Smørgrav	# stream-wait-size: 4m
146e86b9096SDag-Erling Smørgrav
147b7579f77SDag-Erling Smørgrav	# buffer size for handling DNS data. No messages larger than this
148b7579f77SDag-Erling Smørgrav	# size can be sent or received, by UDP or TCP. In bytes.
149b7579f77SDag-Erling Smørgrav	# msg-buffer-size: 65552
150b7579f77SDag-Erling Smørgrav
151b7579f77SDag-Erling Smørgrav	# the amount of memory to use for the message cache.
152b7579f77SDag-Erling Smørgrav	# plain value in bytes or you can append k, m or G. default is "4Mb".
153b7579f77SDag-Erling Smørgrav	# msg-cache-size: 4m
154b7579f77SDag-Erling Smørgrav
155b7579f77SDag-Erling Smørgrav	# the number of slabs to use for the message cache.
156b7579f77SDag-Erling Smørgrav	# the number of slabs must be a power of 2.
157b7579f77SDag-Erling Smørgrav	# more slabs reduce lock contention, but fragment memory usage.
158b7579f77SDag-Erling Smørgrav	# msg-cache-slabs: 4
159b7579f77SDag-Erling Smørgrav
160b7579f77SDag-Erling Smørgrav	# the number of queries that a thread gets to service.
161b7579f77SDag-Erling Smørgrav	# num-queries-per-thread: 1024
162b7579f77SDag-Erling Smørgrav
163b7579f77SDag-Erling Smørgrav	# if very busy, 50% queries run to completion, 50% get timeout in msec
164b7579f77SDag-Erling Smørgrav	# jostle-timeout: 200
165b7579f77SDag-Erling Smørgrav
16617d15b25SDag-Erling Smørgrav	# msec to wait before close of port on timeout UDP. 0 disables.
16717d15b25SDag-Erling Smørgrav	# delay-close: 0
16817d15b25SDag-Erling Smørgrav
169369c6923SCy Schubert	# perform connect for UDP sockets to mitigate ICMP side channel.
170369c6923SCy Schubert	# udp-connect: yes
171369c6923SCy Schubert
172790c6b24SCy Schubert	# The number of retries, per upstream nameserver in a delegation, when
173790c6b24SCy Schubert	# a throwaway response (also timeouts) is received.
17424e36522SCy Schubert	# outbound-msg-retry: 5
17524e36522SCy Schubert
176e86b9096SDag-Erling Smørgrav	# msec for waiting for an unknown server to reply.  Increase if you
177e86b9096SDag-Erling Smørgrav	# are behind a slow satellite link, to eg. 1128.
178e86b9096SDag-Erling Smørgrav	# unknown-server-time-limit: 376
179e86b9096SDag-Erling Smørgrav
180b7579f77SDag-Erling Smørgrav	# the amount of memory to use for the RRset cache.
181b7579f77SDag-Erling Smørgrav	# plain value in bytes or you can append k, m or G. default is "4Mb".
182b7579f77SDag-Erling Smørgrav	# rrset-cache-size: 4m
183b7579f77SDag-Erling Smørgrav
184b7579f77SDag-Erling Smørgrav	# the number of slabs to use for the RRset cache.
185b7579f77SDag-Erling Smørgrav	# the number of slabs must be a power of 2.
186b7579f77SDag-Erling Smørgrav	# more slabs reduce lock contention, but fragment memory usage.
187b7579f77SDag-Erling Smørgrav	# rrset-cache-slabs: 4
188b7579f77SDag-Erling Smørgrav
189b7579f77SDag-Erling Smørgrav	# the time to live (TTL) value lower bound, in seconds. Default 0.
190b7579f77SDag-Erling Smørgrav	# If more than an hour could easily give trouble due to stale data.
191b7579f77SDag-Erling Smørgrav	# cache-min-ttl: 0
192b7579f77SDag-Erling Smørgrav
193b7579f77SDag-Erling Smørgrav	# the time to live (TTL) value cap for RRsets and messages in the
194b7579f77SDag-Erling Smørgrav	# cache. Items are not cached for longer. In seconds.
195b7579f77SDag-Erling Smørgrav	# cache-max-ttl: 86400
196b7579f77SDag-Erling Smørgrav
19709a3aaf3SDag-Erling Smørgrav	# the time to live (TTL) value cap for negative responses in the cache
19809a3aaf3SDag-Erling Smørgrav	# cache-max-negative-ttl: 3600
19909a3aaf3SDag-Erling Smørgrav
200b7579f77SDag-Erling Smørgrav	# the time to live (TTL) value for cached roundtrip times, lameness and
201b7579f77SDag-Erling Smørgrav	# EDNS version information for hosts. In seconds.
202b7579f77SDag-Erling Smørgrav	# infra-host-ttl: 900
203b7579f77SDag-Erling Smørgrav
2046480faa8SDag-Erling Smørgrav	# minimum wait time for responses, increase if uplink is long. In msec.
2056480faa8SDag-Erling Smørgrav	# infra-cache-min-rtt: 50
2066480faa8SDag-Erling Smørgrav
207790c6b24SCy Schubert	# maximum wait time for responses. In msec.
208790c6b24SCy Schubert	# infra-cache-max-rtt: 120000
209790c6b24SCy Schubert
210369c6923SCy Schubert	# enable to make server probe down hosts more frequently.
211369c6923SCy Schubert	# infra-keep-probing: no
212369c6923SCy Schubert
213b7579f77SDag-Erling Smørgrav	# the number of slabs to use for the Infrastructure cache.
214b7579f77SDag-Erling Smørgrav	# the number of slabs must be a power of 2.
215b7579f77SDag-Erling Smørgrav	# more slabs reduce lock contention, but fragment memory usage.
216b7579f77SDag-Erling Smørgrav	# infra-cache-slabs: 4
217b7579f77SDag-Erling Smørgrav
218b7579f77SDag-Erling Smørgrav	# the maximum number of hosts that are cached (roundtrip, EDNS, lame).
219b7579f77SDag-Erling Smørgrav	# infra-cache-numhosts: 10000
220b7579f77SDag-Erling Smørgrav
221*865f46b2SCy Schubert	# define a number of tags here, use with local-zone, access-control,
222*865f46b2SCy Schubert	# interface-*.
223b5663de9SDag-Erling Smørgrav	# repeat the define-tag statement to add additional tags.
224b5663de9SDag-Erling Smørgrav	# define-tag: "tag1 tag2 tag3"
225b5663de9SDag-Erling Smørgrav
226b7579f77SDag-Erling Smørgrav	# Enable IPv4, "yes" or "no".
227b7579f77SDag-Erling Smørgrav	# do-ip4: yes
228b7579f77SDag-Erling Smørgrav
229b7579f77SDag-Erling Smørgrav	# Enable IPv6, "yes" or "no".
230b7579f77SDag-Erling Smørgrav	# do-ip6: yes
231b7579f77SDag-Erling Smørgrav
232b7579f77SDag-Erling Smørgrav	# Enable UDP, "yes" or "no".
233b7579f77SDag-Erling Smørgrav	# do-udp: yes
234b7579f77SDag-Erling Smørgrav
235b7579f77SDag-Erling Smørgrav	# Enable TCP, "yes" or "no".
236b7579f77SDag-Erling Smørgrav	# do-tcp: yes
237b7579f77SDag-Erling Smørgrav
238b7579f77SDag-Erling Smørgrav	# upstream connections use TCP only (and no UDP), "yes" or "no"
239b7579f77SDag-Erling Smørgrav	# useful for tunneling scenarios, default no.
240b7579f77SDag-Erling Smørgrav	# tcp-upstream: no
241b7579f77SDag-Erling Smørgrav
2428a384985SDag-Erling Smørgrav	# upstream connections also use UDP (even if do-udp is no).
2438a384985SDag-Erling Smørgrav	# useful if if you want UDP upstream, but don't provide UDP downstream.
2448a384985SDag-Erling Smørgrav	# udp-upstream-without-downstream: no
2458a384985SDag-Erling Smørgrav
246f61ef7f6SDag-Erling Smørgrav	# Maximum segment size (MSS) of TCP socket on which the server
247f61ef7f6SDag-Erling Smørgrav	# responds to queries. Default is 0, system default MSS.
248f61ef7f6SDag-Erling Smørgrav	# tcp-mss: 0
249f61ef7f6SDag-Erling Smørgrav
250f61ef7f6SDag-Erling Smørgrav	# Maximum segment size (MSS) of TCP socket for outgoing queries.
251f61ef7f6SDag-Erling Smørgrav	# Default is 0, system default MSS.
252f61ef7f6SDag-Erling Smørgrav	# outgoing-tcp-mss: 0
253f61ef7f6SDag-Erling Smørgrav
2544c75e3aaSDag-Erling Smørgrav	# Idle TCP timeout, connection closed in milliseconds
2554c75e3aaSDag-Erling Smørgrav	# tcp-idle-timeout: 30000
2564c75e3aaSDag-Erling Smørgrav
2574c75e3aaSDag-Erling Smørgrav	# Enable EDNS TCP keepalive option.
2584c75e3aaSDag-Erling Smørgrav	# edns-tcp-keepalive: no
2594c75e3aaSDag-Erling Smørgrav
2604c75e3aaSDag-Erling Smørgrav	# Timeout for EDNS TCP keepalive, in msec.
2614c75e3aaSDag-Erling Smørgrav	# edns-tcp-keepalive-timeout: 120000
2624c75e3aaSDag-Erling Smørgrav
2633005e0a3SDag-Erling Smørgrav	# Use systemd socket activation for UDP, TCP, and control sockets.
2643005e0a3SDag-Erling Smørgrav	# use-systemd: no
2653005e0a3SDag-Erling Smørgrav
266b7579f77SDag-Erling Smørgrav	# Detach from the terminal, run in background, "yes" or "no".
2679cf5bc93SCy Schubert	# Set the value to "no" when Unbound runs as systemd service.
268b7579f77SDag-Erling Smørgrav	# do-daemonize: yes
269b7579f77SDag-Erling Smørgrav
270b7579f77SDag-Erling Smørgrav	# control which clients are allowed to make (recursive) queries
271b7579f77SDag-Erling Smørgrav	# to this server. Specify classless netblocks with /size and action.
272b7579f77SDag-Erling Smørgrav	# By default everything is refused, except for localhost.
273b7579f77SDag-Erling Smørgrav	# Choose deny (drop message), refuse (polite error reply),
2743bd4df0aSDag-Erling Smørgrav	# allow (recursive ok), allow_setrd (recursive ok, rd bit is forced on),
2753bd4df0aSDag-Erling Smørgrav	# allow_snoop (recursive and nonrecursive ok)
27617d15b25SDag-Erling Smørgrav	# deny_non_local (drop queries unless can be answered from local-data)
27717d15b25SDag-Erling Smørgrav	# refuse_non_local (like deny_non_local but polite error reply).
278b7579f77SDag-Erling Smørgrav	# access-control: 127.0.0.0/8 allow
279b7579f77SDag-Erling Smørgrav	# access-control: ::1 allow
280b7579f77SDag-Erling Smørgrav	# access-control: ::ffff:127.0.0.1 allow
281b7579f77SDag-Erling Smørgrav
282b5663de9SDag-Erling Smørgrav	# tag access-control with list of tags (in "" with spaces between)
283b5663de9SDag-Erling Smørgrav	# Clients using this access control element use localzones that
284b5663de9SDag-Erling Smørgrav	# are tagged with one of these tags.
285b5663de9SDag-Erling Smørgrav	# access-control-tag: 192.0.2.0/24 "tag2 tag3"
286b5663de9SDag-Erling Smørgrav
287*865f46b2SCy Schubert	# set action for particular tag for given access control element.
288b5663de9SDag-Erling Smørgrav	# if you have multiple tag values, the tag used to lookup the action
289b5663de9SDag-Erling Smørgrav	# is the first tag match between access-control-tag and local-zone-tag
290b5663de9SDag-Erling Smørgrav	# where "first" comes from the order of the define-tag values.
291b5663de9SDag-Erling Smørgrav	# access-control-tag-action: 192.0.2.0/24 tag3 refuse
292b5663de9SDag-Erling Smørgrav
293b5663de9SDag-Erling Smørgrav	# set redirect data for particular tag for access control element
294b5663de9SDag-Erling Smørgrav	# access-control-tag-data: 192.0.2.0/24 tag2 "A 127.0.0.1"
295b5663de9SDag-Erling Smørgrav
296bc892140SDag-Erling Smørgrav	# Set view for access control element
297bc892140SDag-Erling Smørgrav	# access-control-view: 192.0.2.0/24 viewname
298bc892140SDag-Erling Smørgrav
299*865f46b2SCy Schubert	# Similar to 'access-control:' but for interfaces.
300*865f46b2SCy Schubert	# Control which listening interfaces are allowed to accept (recursive)
301*865f46b2SCy Schubert	# queries for this server.
302*865f46b2SCy Schubert	# The specified interfaces should be the same as the ones specified in
303*865f46b2SCy Schubert	# 'interface:' followed by the action.
304*865f46b2SCy Schubert	# The actions are the same as 'access-control:' above.
305*865f46b2SCy Schubert	# By default all the interfaces configured are refused.
306*865f46b2SCy Schubert	# Note: any 'access-control*:' setting overrides all 'interface-*:'
307*865f46b2SCy Schubert	# settings for targeted clients.
308*865f46b2SCy Schubert	# interface-action: 192.0.2.153 allow
309*865f46b2SCy Schubert	# interface-action: 192.0.2.154 allow
310*865f46b2SCy Schubert	# interface-action: 192.0.2.154@5003 allow
311*865f46b2SCy Schubert	# interface-action: 2001:DB8::5 allow
312*865f46b2SCy Schubert	# interface-action: eth0@5003 allow
313*865f46b2SCy Schubert
314*865f46b2SCy Schubert	# Similar to 'access-control-tag:' but for interfaces.
315*865f46b2SCy Schubert	# Tag interfaces with a list of tags (in "" with spaces between).
316*865f46b2SCy Schubert	# Interfaces using these tags use localzones that are tagged with one
317*865f46b2SCy Schubert	# of these tags.
318*865f46b2SCy Schubert	# The specified interfaces should be the same as the ones specified in
319*865f46b2SCy Schubert	# 'interface:' followed by the list of tags.
320*865f46b2SCy Schubert	# Note: any 'access-control*:' setting overrides all 'interface-*:'
321*865f46b2SCy Schubert	# settings for targeted clients.
322*865f46b2SCy Schubert	# interface-tag: eth0@5003 "tag2 tag3"
323*865f46b2SCy Schubert
324*865f46b2SCy Schubert	# Similar to 'access-control-tag-action:' but for interfaces.
325*865f46b2SCy Schubert	# Set action for particular tag for a given interface element.
326*865f46b2SCy Schubert	# If you have multiple tag values, the tag used to lookup the action
327*865f46b2SCy Schubert	# is the first tag match between interface-tag and local-zone-tag
328*865f46b2SCy Schubert	# where "first" comes from the order of the define-tag values.
329*865f46b2SCy Schubert	# The specified interfaces should be the same as the ones specified in
330*865f46b2SCy Schubert	# 'interface:' followed by the tag and action.
331*865f46b2SCy Schubert	# Note: any 'access-control*:' setting overrides all 'interface-*:'
332*865f46b2SCy Schubert	# settings for targeted clients.
333*865f46b2SCy Schubert	# interface-tag-action: eth0@5003 tag3 refuse
334*865f46b2SCy Schubert
335*865f46b2SCy Schubert	# Similar to 'access-control-tag-data:' but for interfaces.
336*865f46b2SCy Schubert	# Set redirect data for a particular tag for an interface element.
337*865f46b2SCy Schubert	# The specified interfaces should be the same as the ones specified in
338*865f46b2SCy Schubert	# 'interface:' followed by the tag and the redirect data.
339*865f46b2SCy Schubert	# Note: any 'access-control*:' setting overrides all 'interface-*:'
340*865f46b2SCy Schubert	# settings for targeted clients.
341*865f46b2SCy Schubert	# interface-tag-data: eth0@5003 tag2 "A 127.0.0.1"
342*865f46b2SCy Schubert
343*865f46b2SCy Schubert	# Similar to 'access-control-view:' but for interfaces.
344*865f46b2SCy Schubert	# Set view for an interface element.
345*865f46b2SCy Schubert	# The specified interfaces should be the same as the ones specified in
346*865f46b2SCy Schubert	# 'interface:' followed by the view name.
347*865f46b2SCy Schubert	# Note: any 'access-control*:' setting overrides all 'interface-*:'
348*865f46b2SCy Schubert	# settings for targeted clients.
349*865f46b2SCy Schubert	# interface-view: eth0@5003 viewname
350*865f46b2SCy Schubert
351b7579f77SDag-Erling Smørgrav	# if given, a chroot(2) is done to the given directory.
352b7579f77SDag-Erling Smørgrav	# i.e. you can chroot to the working directory, for example,
353b7579f77SDag-Erling Smørgrav	# for extra security, but make sure all files are in that directory.
354b7579f77SDag-Erling Smørgrav	#
355b7579f77SDag-Erling Smørgrav	# If chroot is enabled, you should pass the configfile (from the
356b7579f77SDag-Erling Smørgrav	# commandline) as a full path from the original root. After the
357b7579f77SDag-Erling Smørgrav	# chroot has been performed the now defunct portion of the config
358b7579f77SDag-Erling Smørgrav	# file path is removed to be able to reread the config after a reload.
359b7579f77SDag-Erling Smørgrav	#
360b7579f77SDag-Erling Smørgrav	# All other file paths (working dir, logfile, roothints, and
361b7579f77SDag-Erling Smørgrav	# key files) can be specified in several ways:
362b7579f77SDag-Erling Smørgrav	# 	o as an absolute path relative to the new root.
363b7579f77SDag-Erling Smørgrav	# 	o as a relative path to the working directory.
364b7579f77SDag-Erling Smørgrav	# 	o as an absolute path relative to the original root.
365b7579f77SDag-Erling Smørgrav	# In the last case the path is adjusted to remove the unused portion.
366b7579f77SDag-Erling Smørgrav	#
367b7579f77SDag-Erling Smørgrav	# The pid file can be absolute and outside of the chroot, it is
368b7579f77SDag-Erling Smørgrav	# written just prior to performing the chroot and dropping permissions.
369b7579f77SDag-Erling Smørgrav	#
3709cf5bc93SCy Schubert	# Additionally, Unbound may need to access /dev/urandom (for entropy).
371b7579f77SDag-Erling Smørgrav	# How to do this is specific to your OS.
372b7579f77SDag-Erling Smørgrav	#
373b7579f77SDag-Erling Smørgrav	# If you give "" no chroot is performed. The path must not end in a /.
374b7579f77SDag-Erling Smørgrav	# chroot: "@UNBOUND_CHROOT_DIR@"
375b7579f77SDag-Erling Smørgrav
376b7579f77SDag-Erling Smørgrav	# if given, user privileges are dropped (after binding port),
377b7579f77SDag-Erling Smørgrav	# and the given username is assumed. Default is user "unbound".
378b7579f77SDag-Erling Smørgrav	# If you give "" no privileges are dropped.
379b7579f77SDag-Erling Smørgrav	# username: "@UNBOUND_USERNAME@"
380b7579f77SDag-Erling Smørgrav
381b7579f77SDag-Erling Smørgrav	# the working directory. The relative files in this config are
382b7579f77SDag-Erling Smørgrav	# relative to this directory. If you give "" the working directory
383b7579f77SDag-Erling Smørgrav	# is not changed.
384b5663de9SDag-Erling Smørgrav	# If you give a server: directory: dir before include: file statements
385b5663de9SDag-Erling Smørgrav	# then those includes can be relative to the working directory.
386b7579f77SDag-Erling Smørgrav	# directory: "@UNBOUND_RUN_DIR@"
387b7579f77SDag-Erling Smørgrav
388b7579f77SDag-Erling Smørgrav	# the log file, "" means log to stderr.
389b7579f77SDag-Erling Smørgrav	# Use of this option sets use-syslog to "no".
390b7579f77SDag-Erling Smørgrav	# logfile: ""
391b7579f77SDag-Erling Smørgrav
392b7579f77SDag-Erling Smørgrav	# Log to syslog(3) if yes. The log facility LOG_DAEMON is used to
393bc892140SDag-Erling Smørgrav	# log to. If yes, it overrides the logfile.
394b7579f77SDag-Erling Smørgrav	# use-syslog: yes
395b7579f77SDag-Erling Smørgrav
396bc892140SDag-Erling Smørgrav	# Log identity to report. if empty, defaults to the name of argv[0]
397bc892140SDag-Erling Smørgrav	# (usually "unbound").
398bc892140SDag-Erling Smørgrav	# log-identity: ""
399bc892140SDag-Erling Smørgrav
400b7579f77SDag-Erling Smørgrav	# print UTC timestamp in ascii to logfile, default is epoch in seconds.
401b7579f77SDag-Erling Smørgrav	# log-time-ascii: no
402b7579f77SDag-Erling Smørgrav
403b7579f77SDag-Erling Smørgrav	# print one line with time, IP, name, type, class for every query.
404b7579f77SDag-Erling Smørgrav	# log-queries: no
405b7579f77SDag-Erling Smørgrav
4063005e0a3SDag-Erling Smørgrav	# print one line per reply, with time, IP, name, type, class, rcode,
4073005e0a3SDag-Erling Smørgrav	# timetoresolve, fromcache and responsesize.
4083005e0a3SDag-Erling Smørgrav	# log-replies: no
4093005e0a3SDag-Erling Smørgrav
410e86b9096SDag-Erling Smørgrav	# log with tag 'query' and 'reply' instead of 'info' for
411e86b9096SDag-Erling Smørgrav	# filtering log-queries and log-replies from the log.
412e86b9096SDag-Erling Smørgrav	# log-tag-queryreply: no
413e86b9096SDag-Erling Smørgrav
4144c75e3aaSDag-Erling Smørgrav	# log the local-zone actions, like local-zone type inform is enabled
4154c75e3aaSDag-Erling Smørgrav	# also for the other local zone types.
4164c75e3aaSDag-Erling Smørgrav	# log-local-actions: no
4174c75e3aaSDag-Erling Smørgrav
4184c75e3aaSDag-Erling Smørgrav	# print log lines that say why queries return SERVFAIL to clients.
4194c75e3aaSDag-Erling Smørgrav	# log-servfail: no
4204c75e3aaSDag-Erling Smørgrav
421b7579f77SDag-Erling Smørgrav	# the pid file. Can be an absolute path outside of chroot/work dir.
422b7579f77SDag-Erling Smørgrav	# pidfile: "@UNBOUND_PIDFILE@"
423b7579f77SDag-Erling Smørgrav
424b7579f77SDag-Erling Smørgrav	# file to read root hints from.
42505ab2901SDag-Erling Smørgrav	# get one from https://www.internic.net/domain/named.cache
426b7579f77SDag-Erling Smørgrav	# root-hints: ""
427b7579f77SDag-Erling Smørgrav
428b7579f77SDag-Erling Smørgrav	# enable to not answer id.server and hostname.bind queries.
429b7579f77SDag-Erling Smørgrav	# hide-identity: no
430b7579f77SDag-Erling Smørgrav
431b7579f77SDag-Erling Smørgrav	# enable to not answer version.server and version.bind queries.
432b7579f77SDag-Erling Smørgrav	# hide-version: no
433b7579f77SDag-Erling Smørgrav
43465b390aaSDag-Erling Smørgrav	# enable to not answer trustanchor.unbound queries.
43565b390aaSDag-Erling Smørgrav	# hide-trustanchor: no
43665b390aaSDag-Erling Smørgrav
4375469a995SCy Schubert	# enable to not set the User-Agent HTTP header.
4385469a995SCy Schubert	# hide-http-user-agent: no
4395469a995SCy Schubert
440b7579f77SDag-Erling Smørgrav	# the identity to report. Leave "" or default to return hostname.
441b7579f77SDag-Erling Smørgrav	# identity: ""
442b7579f77SDag-Erling Smørgrav
443b7579f77SDag-Erling Smørgrav	# the version to report. Leave "" or default to return package version.
444b7579f77SDag-Erling Smørgrav	# version: ""
445b7579f77SDag-Erling Smørgrav
446f44e67d1SCy Schubert	# NSID identity (hex string, or "ascii_somestring"). default disabled.
447f44e67d1SCy Schubert	# nsid: "aabbccdd"
448f44e67d1SCy Schubert
4495469a995SCy Schubert	# User-Agent HTTP header to use. Leave "" or default to use package name
4505469a995SCy Schubert	# and version.
4515469a995SCy Schubert	# http-user-agent: ""
4525469a995SCy Schubert
453b7579f77SDag-Erling Smørgrav	# the target fetch policy.
454b7579f77SDag-Erling Smørgrav	# series of integers describing the policy per dependency depth.
455b7579f77SDag-Erling Smørgrav	# The number of values in the list determines the maximum dependency
456b7579f77SDag-Erling Smørgrav	# depth the recursor will pursue before giving up. Each integer means:
457b7579f77SDag-Erling Smørgrav	# 	-1 : fetch all targets opportunistically,
458b7579f77SDag-Erling Smørgrav	# 	0: fetch on demand,
459b7579f77SDag-Erling Smørgrav	#	positive value: fetch that many targets opportunistically.
460b7579f77SDag-Erling Smørgrav	# Enclose the list of numbers between quotes ("").
461b7579f77SDag-Erling Smørgrav	# target-fetch-policy: "3 2 1 0 0"
462b7579f77SDag-Erling Smørgrav
463b7579f77SDag-Erling Smørgrav	# Harden against very small EDNS buffer sizes.
464f44e67d1SCy Schubert	# harden-short-bufsize: yes
465b7579f77SDag-Erling Smørgrav
466b7579f77SDag-Erling Smørgrav	# Harden against unseemly large queries.
467b7579f77SDag-Erling Smørgrav	# harden-large-queries: no
468b7579f77SDag-Erling Smørgrav
469b7579f77SDag-Erling Smørgrav	# Harden against out of zone rrsets, to avoid spoofing attempts.
470b7579f77SDag-Erling Smørgrav	# harden-glue: yes
471b7579f77SDag-Erling Smørgrav
472b7579f77SDag-Erling Smørgrav	# Harden against receiving dnssec-stripped data. If you turn it
473b7579f77SDag-Erling Smørgrav	# off, failing to validate dnskey data for a trustanchor will
474b7579f77SDag-Erling Smørgrav	# trigger insecure mode for that zone (like without a trustanchor).
475b7579f77SDag-Erling Smørgrav	# Default on, which insists on dnssec data for trust-anchored zones.
476b7579f77SDag-Erling Smørgrav	# harden-dnssec-stripped: yes
477b7579f77SDag-Erling Smørgrav
478b7579f77SDag-Erling Smørgrav	# Harden against queries that fall under dnssec-signed nxdomain names.
4794c75e3aaSDag-Erling Smørgrav	# harden-below-nxdomain: yes
480b7579f77SDag-Erling Smørgrav
481b7579f77SDag-Erling Smørgrav	# Harden the referral path by performing additional queries for
482b7579f77SDag-Erling Smørgrav	# infrastructure data.  Validates the replies (if possible).
483b7579f77SDag-Erling Smørgrav	# Default off, because the lookups burden the server.  Experimental
484b7579f77SDag-Erling Smørgrav	# implementation of draft-wijngaards-dnsext-resolver-side-mitigation.
485b7579f77SDag-Erling Smørgrav	# harden-referral-path: no
486b7579f77SDag-Erling Smørgrav
48709a3aaf3SDag-Erling Smørgrav	# Harden against algorithm downgrade when multiple algorithms are
48809a3aaf3SDag-Erling Smørgrav	# advertised in the DS record.  If no, allows the weakest algorithm
48909a3aaf3SDag-Erling Smørgrav	# to validate the zone.
490b75612f8SDag-Erling Smørgrav	# harden-algo-downgrade: no
49109a3aaf3SDag-Erling Smørgrav
49205ab2901SDag-Erling Smørgrav	# Sent minimum amount of information to upstream servers to enhance
49305ab2901SDag-Erling Smørgrav	# privacy. Only sent minimum required labels of the QNAME and set QTYPE
49457bddd21SDag-Erling Smørgrav	# to A when possible.
4953bd4df0aSDag-Erling Smørgrav	# qname-minimisation: yes
49605ab2901SDag-Erling Smørgrav
497bc892140SDag-Erling Smørgrav	# QNAME minimisation in strict mode. Do not fall-back to sending full
498bc892140SDag-Erling Smørgrav	# QNAME to potentially broken nameservers. A lot of domains will not be
499bc892140SDag-Erling Smørgrav	# resolvable when this option in enabled.
500bc892140SDag-Erling Smørgrav	# This option only has effect when qname-minimisation is enabled.
501bc892140SDag-Erling Smørgrav	# qname-minimisation-strict: no
502bc892140SDag-Erling Smørgrav
50357bddd21SDag-Erling Smørgrav	# Aggressive NSEC uses the DNSSEC NSEC chain to synthesize NXDOMAIN
50457bddd21SDag-Erling Smørgrav	# and other denials, using information from previous NXDOMAINs answers.
5059cf5bc93SCy Schubert	# aggressive-nsec: yes
50657bddd21SDag-Erling Smørgrav
507b7579f77SDag-Erling Smørgrav	# Use 0x20-encoded random bits in the query to foil spoof attempts.
508b7579f77SDag-Erling Smørgrav	# This feature is an experimental implementation of draft dns-0x20.
509b7579f77SDag-Erling Smørgrav	# use-caps-for-id: no
510b7579f77SDag-Erling Smørgrav
51109a3aaf3SDag-Erling Smørgrav	# Domains (and domains in them) without support for dns-0x20 and
51209a3aaf3SDag-Erling Smørgrav	# the fallback fails because they keep sending different answers.
513c0caa2e2SCy Schubert	# caps-exempt: "licdn.com"
514c0caa2e2SCy Schubert	# caps-exempt: "senderbase.org"
51509a3aaf3SDag-Erling Smørgrav
516b7579f77SDag-Erling Smørgrav	# Enforce privacy of these addresses. Strips them away from answers.
517b7579f77SDag-Erling Smørgrav	# It may cause DNSSEC validation to additionally mark it as bogus.
518b7579f77SDag-Erling Smørgrav	# Protects against 'DNS Rebinding' (uses browser as network proxy).
519b7579f77SDag-Erling Smørgrav	# Only 'private-domain' and 'local-data' names are allowed to have
520b7579f77SDag-Erling Smørgrav	# these private addresses. No default.
521b7579f77SDag-Erling Smørgrav	# private-address: 10.0.0.0/8
522b7579f77SDag-Erling Smørgrav	# private-address: 172.16.0.0/12
523b7579f77SDag-Erling Smørgrav	# private-address: 192.168.0.0/16
524b7579f77SDag-Erling Smørgrav	# private-address: 169.254.0.0/16
525b7579f77SDag-Erling Smørgrav	# private-address: fd00::/8
526b7579f77SDag-Erling Smørgrav	# private-address: fe80::/10
52705ab2901SDag-Erling Smørgrav	# private-address: ::ffff:0:0/96
528b7579f77SDag-Erling Smørgrav
529b7579f77SDag-Erling Smørgrav	# Allow the domain (and its subdomains) to contain private addresses.
530b7579f77SDag-Erling Smørgrav	# local-data statements are allowed to contain private addresses too.
531b7579f77SDag-Erling Smørgrav	# private-domain: "example.com"
532b7579f77SDag-Erling Smørgrav
533b7579f77SDag-Erling Smørgrav	# If nonzero, unwanted replies are not only reported in statistics,
534b7579f77SDag-Erling Smørgrav	# but also a running total is kept per thread. If it reaches the
535b7579f77SDag-Erling Smørgrav	# threshold, a warning is printed and a defensive action is taken,
536b7579f77SDag-Erling Smørgrav	# the cache is cleared to flush potential poison out of it.
537b7579f77SDag-Erling Smørgrav	# A suggested value is 10000000, the default is 0 (turned off).
538b7579f77SDag-Erling Smørgrav	# unwanted-reply-threshold: 0
539b7579f77SDag-Erling Smørgrav
540b7579f77SDag-Erling Smørgrav	# Do not query the following addresses. No DNS queries are sent there.
541b7579f77SDag-Erling Smørgrav	# List one address per entry. List classless netblocks with /size,
542b7579f77SDag-Erling Smørgrav	# do-not-query-address: 127.0.0.1/8
543b7579f77SDag-Erling Smørgrav	# do-not-query-address: ::1
544b7579f77SDag-Erling Smørgrav
545b7579f77SDag-Erling Smørgrav	# if yes, the above default do-not-query-address entries are present.
546b7579f77SDag-Erling Smørgrav	# if no, localhost can be queried (for testing and debugging).
547b7579f77SDag-Erling Smørgrav	# do-not-query-localhost: yes
548b7579f77SDag-Erling Smørgrav
549b7579f77SDag-Erling Smørgrav	# if yes, perform prefetching of almost expired message cache entries.
550b7579f77SDag-Erling Smørgrav	# prefetch: no
551b7579f77SDag-Erling Smørgrav
552b7579f77SDag-Erling Smørgrav	# if yes, perform key lookups adjacent to normal lookups.
553b7579f77SDag-Erling Smørgrav	# prefetch-key: no
554b7579f77SDag-Erling Smørgrav
555e86b9096SDag-Erling Smørgrav	# deny queries of type ANY with an empty response.
556e86b9096SDag-Erling Smørgrav	# deny-any: no
557e86b9096SDag-Erling Smørgrav
558b7579f77SDag-Erling Smørgrav	# if yes, Unbound rotates RRSet order in response.
55925039b37SCy Schubert	# rrset-roundrobin: yes
560b7579f77SDag-Erling Smørgrav
561b7579f77SDag-Erling Smørgrav	# if yes, Unbound doesn't insert authority/additional sections
562b7579f77SDag-Erling Smørgrav	# into response messages when those sections are not required.
5634c75e3aaSDag-Erling Smørgrav	# minimal-responses: yes
564b7579f77SDag-Erling Smørgrav
565e2d15004SDag-Erling Smørgrav	# true to disable DNSSEC lameness check in iterator.
566e2d15004SDag-Erling Smørgrav	# disable-dnssec-lame-check: no
567e2d15004SDag-Erling Smørgrav
568b7579f77SDag-Erling Smørgrav	# module configuration of the server. A string with identifiers
569ff825849SDag-Erling Smørgrav	# separated by spaces. Syntax: "[dns64] [validator] iterator"
570e86b9096SDag-Erling Smørgrav	# most modules have to be listed at the beginning of the line,
571e86b9096SDag-Erling Smørgrav	# except cachedb(just before iterator), and python (at the beginning,
572e86b9096SDag-Erling Smørgrav	# or, just before the iterator).
573b7579f77SDag-Erling Smørgrav	# module-config: "validator iterator"
574b7579f77SDag-Erling Smørgrav
575b7579f77SDag-Erling Smørgrav	# File with trusted keys, kept uptodate using RFC5011 probes,
576b7579f77SDag-Erling Smørgrav	# initial file like trust-anchor-file, then it stores metadata.
577b7579f77SDag-Erling Smørgrav	# Use several entries, one per domain name, to track multiple zones.
578b7579f77SDag-Erling Smørgrav	#
579b7579f77SDag-Erling Smørgrav	# If you want to perform DNSSEC validation, run unbound-anchor before
5809cf5bc93SCy Schubert	# you start Unbound (i.e. in the system boot scripts).
5815469a995SCy Schubert	# And then enable the auto-trust-anchor-file config item.
582b7579f77SDag-Erling Smørgrav	# Please note usage of unbound-anchor root anchor is at your own risk
583b7579f77SDag-Erling Smørgrav	# and under the terms of our LICENSE (see that file in the source).
584b7579f77SDag-Erling Smørgrav	# auto-trust-anchor-file: "@UNBOUND_ROOTKEY_FILE@"
585b7579f77SDag-Erling Smørgrav
586c7f4d7adSDag-Erling Smørgrav	# trust anchor signaling sends a RFC8145 key tag query after priming.
5878a384985SDag-Erling Smørgrav	# trust-anchor-signaling: yes
588c7f4d7adSDag-Erling Smørgrav
5890fb34990SDag-Erling Smørgrav	# Root key trust anchor sentinel (draft-ietf-dnsop-kskroll-sentinel)
5900fb34990SDag-Erling Smørgrav	# root-key-sentinel: yes
5910fb34990SDag-Erling Smørgrav
592b7579f77SDag-Erling Smørgrav	# File with trusted keys for validation. Specify more than one file
593b7579f77SDag-Erling Smørgrav	# with several entries, one file per entry.
594b7579f77SDag-Erling Smørgrav	# Zone file format, with DS and DNSKEY entries.
595b7579f77SDag-Erling Smørgrav	# Note this gets out of date, use auto-trust-anchor-file please.
596b7579f77SDag-Erling Smørgrav	# trust-anchor-file: ""
597b7579f77SDag-Erling Smørgrav
598b7579f77SDag-Erling Smørgrav	# Trusted key for validation. DS or DNSKEY. specify the RR on a
599b7579f77SDag-Erling Smørgrav	# single line, surrounded by "". TTL is ignored. class is IN default.
600b7579f77SDag-Erling Smørgrav	# Note this gets out of date, use auto-trust-anchor-file please.
601b7579f77SDag-Erling Smørgrav	# (These examples are from August 2007 and may not be valid anymore).
602b7579f77SDag-Erling Smørgrav	# trust-anchor: "nlnetlabs.nl. DNSKEY 257 3 5 AQPzzTWMz8qSWIQlfRnPckx2BiVmkVN6LPupO3mbz7FhLSnm26n6iG9N Lby97Ji453aWZY3M5/xJBSOS2vWtco2t8C0+xeO1bc/d6ZTy32DHchpW 6rDH1vp86Ll+ha0tmwyy9QP7y2bVw5zSbFCrefk8qCUBgfHm9bHzMG1U BYtEIQ=="
603b7579f77SDag-Erling Smørgrav	# trust-anchor: "jelte.nlnetlabs.nl. DS 42860 5 1 14D739EB566D2B1A5E216A0BA4D17FA9B038BE4A"
604b7579f77SDag-Erling Smørgrav
605b7579f77SDag-Erling Smørgrav	# File with trusted keys for validation. Specify more than one file
606b7579f77SDag-Erling Smørgrav	# with several entries, one file per entry. Like trust-anchor-file
607b7579f77SDag-Erling Smørgrav	# but has a different file format. Format is BIND-9 style format,
608b7579f77SDag-Erling Smørgrav	# the trusted-keys { name flag proto algo "key"; }; clauses are read.
609b7579f77SDag-Erling Smørgrav	# you need external update procedures to track changes in keys.
610b7579f77SDag-Erling Smørgrav	# trusted-keys-file: ""
611b7579f77SDag-Erling Smørgrav
612b7579f77SDag-Erling Smørgrav	# Ignore chain of trust. Domain is treated as insecure.
613b7579f77SDag-Erling Smørgrav	# domain-insecure: "example.com"
614b7579f77SDag-Erling Smørgrav
615b7579f77SDag-Erling Smørgrav	# Override the date for validation with a specific fixed date.
616b7579f77SDag-Erling Smørgrav	# Do not set this unless you are debugging signature inception
617b7579f77SDag-Erling Smørgrav	# and expiration. "" or "0" turns the feature off. -1 ignores date.
618b7579f77SDag-Erling Smørgrav	# val-override-date: ""
619b7579f77SDag-Erling Smørgrav
620b7579f77SDag-Erling Smørgrav	# The time to live for bogus data, rrsets and messages. This avoids
621b7579f77SDag-Erling Smørgrav	# some of the revalidation, until the time interval expires. in secs.
622b7579f77SDag-Erling Smørgrav	# val-bogus-ttl: 60
623b7579f77SDag-Erling Smørgrav
624b7579f77SDag-Erling Smørgrav	# The signature inception and expiration dates are allowed to be off
625b7579f77SDag-Erling Smørgrav	# by 10% of the signature lifetime (expir-incep) from our local clock.
626b7579f77SDag-Erling Smørgrav	# This leeway is capped with a minimum and a maximum.  In seconds.
627b7579f77SDag-Erling Smørgrav	# val-sig-skew-min: 3600
628b7579f77SDag-Erling Smørgrav	# val-sig-skew-max: 86400
629b7579f77SDag-Erling Smørgrav
6305469a995SCy Schubert	# The maximum number the validator should restart validation with
6315469a995SCy Schubert	# another authority in case of failed validation.
6325469a995SCy Schubert	# val-max-restart: 5
6335469a995SCy Schubert
634b7579f77SDag-Erling Smørgrav	# Should additional section of secure message also be kept clean of
635b7579f77SDag-Erling Smørgrav	# unsecure data. Useful to shield the users of this validator from
636b7579f77SDag-Erling Smørgrav	# potential bogus data in the additional section. All unsigned data
637b7579f77SDag-Erling Smørgrav	# in the additional section is removed from secure messages.
638b7579f77SDag-Erling Smørgrav	# val-clean-additional: yes
639b7579f77SDag-Erling Smørgrav
640b7579f77SDag-Erling Smørgrav	# Turn permissive mode on to permit bogus messages. Thus, messages
641b7579f77SDag-Erling Smørgrav	# for which security checks failed will be returned to clients,
642b7579f77SDag-Erling Smørgrav	# instead of SERVFAIL. It still performs the security checks, which
643b7579f77SDag-Erling Smørgrav	# result in interesting log files and possibly the AD bit in
644b7579f77SDag-Erling Smørgrav	# replies if the message is found secure. The default is off.
645b7579f77SDag-Erling Smørgrav	# val-permissive-mode: no
646b7579f77SDag-Erling Smørgrav
647b7579f77SDag-Erling Smørgrav	# Ignore the CD flag in incoming queries and refuse them bogus data.
6489cf5bc93SCy Schubert	# Enable it if the only clients of Unbound are legacy servers (w2008)
649b7579f77SDag-Erling Smørgrav	# that set CD but cannot validate themselves.
650b7579f77SDag-Erling Smørgrav	# ignore-cd-flag: no
651b7579f77SDag-Erling Smørgrav
652091e9e46SCy Schubert	# Serve expired responses from cache, with serve-expired-reply-ttl in
653091e9e46SCy Schubert	# the response, and then attempt to fetch the data afresh.
654bc892140SDag-Erling Smørgrav	# serve-expired: no
6554c75e3aaSDag-Erling Smørgrav	#
6564c75e3aaSDag-Erling Smørgrav	# Limit serving of expired responses to configured seconds after
6574c75e3aaSDag-Erling Smørgrav	# expiration. 0 disables the limit.
6584c75e3aaSDag-Erling Smørgrav	# serve-expired-ttl: 0
6594c75e3aaSDag-Erling Smørgrav	#
6604c75e3aaSDag-Erling Smørgrav	# Set the TTL of expired records to the serve-expired-ttl value after a
6614c75e3aaSDag-Erling Smørgrav	# failed attempt to retrieve the record from upstream. This makes sure
6624c75e3aaSDag-Erling Smørgrav	# that the expired records will be served as long as there are queries
6634c75e3aaSDag-Erling Smørgrav	# for it.
6644c75e3aaSDag-Erling Smørgrav	# serve-expired-ttl-reset: no
665091e9e46SCy Schubert	#
666091e9e46SCy Schubert	# TTL value to use when replying with expired data.
667091e9e46SCy Schubert	# serve-expired-reply-ttl: 30
668091e9e46SCy Schubert	#
669091e9e46SCy Schubert	# Time in milliseconds before replying to the client with expired data.
670091e9e46SCy Schubert	# This essentially enables the serve-stale behavior as specified in
671c0caa2e2SCy Schubert	# RFC 8767 that first tries to resolve before
672091e9e46SCy Schubert	# immediately responding with expired data.  0 disables this behavior.
673091e9e46SCy Schubert	# A recommended value is 1800.
674091e9e46SCy Schubert	# serve-expired-client-timeout: 0
675bc892140SDag-Erling Smørgrav
676f44e67d1SCy Schubert	# Return the original TTL as received from the upstream name server rather
677f44e67d1SCy Schubert	# than the decrementing TTL as stored in the cache.  Enabling this feature
6789cf5bc93SCy Schubert	# does not impact cache expiry, it only changes the TTL Unbound embeds in
679f44e67d1SCy Schubert	# responses to queries. Note that enabling this feature implicitly disables
680f44e67d1SCy Schubert	# enforcement of the configured minimum and maximum TTL.
681f44e67d1SCy Schubert	# serve-original-ttl: no
682f44e67d1SCy Schubert
683b7579f77SDag-Erling Smørgrav	# Have the validator log failed validations for your diagnosis.
684b7579f77SDag-Erling Smørgrav	# 0: off. 1: A line per failed user query. 2: With reason and bad IP.
685b7579f77SDag-Erling Smørgrav	# val-log-level: 0
686b7579f77SDag-Erling Smørgrav
687b7579f77SDag-Erling Smørgrav	# It is possible to configure NSEC3 maximum iteration counts per
688b7579f77SDag-Erling Smørgrav	# keysize. Keep this table very short, as linear search is done.
689b7579f77SDag-Erling Smørgrav	# A message with an NSEC3 with larger count is marked insecure.
690b7579f77SDag-Erling Smørgrav	# List in ascending order the keysize and count values.
6915469a995SCy Schubert	# val-nsec3-keysize-iterations: "1024 150 2048 150 4096 150"
6925469a995SCy Schubert
6935469a995SCy Schubert	# if enabled, ZONEMD verification failures do not block the zone.
6945469a995SCy Schubert	# zonemd-permissive-mode: no
695b7579f77SDag-Erling Smørgrav
696b7579f77SDag-Erling Smørgrav	# instruct the auto-trust-anchor-file probing to add anchors after ttl.
697b7579f77SDag-Erling Smørgrav	# add-holddown: 2592000 # 30 days
698b7579f77SDag-Erling Smørgrav
699b7579f77SDag-Erling Smørgrav	# instruct the auto-trust-anchor-file probing to del anchors after ttl.
700b7579f77SDag-Erling Smørgrav	# del-holddown: 2592000 # 30 days
701b7579f77SDag-Erling Smørgrav
702b7579f77SDag-Erling Smørgrav	# auto-trust-anchor-file probing removes missing anchors after ttl.
703b7579f77SDag-Erling Smørgrav	# If the value 0 is given, missing anchors are not removed.
704b7579f77SDag-Erling Smørgrav	# keep-missing: 31622400 # 366 days
705b7579f77SDag-Erling Smørgrav
706e2d15004SDag-Erling Smørgrav	# debug option that allows very small holddown times for key rollover,
707e2d15004SDag-Erling Smørgrav	# otherwise the RFC mandates probe intervals must be at least 1 hour.
708b75612f8SDag-Erling Smørgrav	# permit-small-holddown: no
709b75612f8SDag-Erling Smørgrav
710b7579f77SDag-Erling Smørgrav	# the amount of memory to use for the key cache.
711b7579f77SDag-Erling Smørgrav	# plain value in bytes or you can append k, m or G. default is "4Mb".
712b7579f77SDag-Erling Smørgrav	# key-cache-size: 4m
713b7579f77SDag-Erling Smørgrav
714b7579f77SDag-Erling Smørgrav	# the number of slabs to use for the key cache.
715b7579f77SDag-Erling Smørgrav	# the number of slabs must be a power of 2.
716b7579f77SDag-Erling Smørgrav	# more slabs reduce lock contention, but fragment memory usage.
717b7579f77SDag-Erling Smørgrav	# key-cache-slabs: 4
718b7579f77SDag-Erling Smørgrav
719c0caa2e2SCy Schubert	# the amount of memory to use for the negative cache.
720b7579f77SDag-Erling Smørgrav	# plain value in bytes or you can append k, m or G. default is "1Mb".
721b7579f77SDag-Erling Smørgrav	# neg-cache-size: 1m
722b7579f77SDag-Erling Smørgrav
72317d15b25SDag-Erling Smørgrav	# By default, for a number of zones a small default 'nothing here'
72417d15b25SDag-Erling Smørgrav	# reply is built-in.  Query traffic is thus blocked.  If you
72517d15b25SDag-Erling Smørgrav	# wish to serve such zone you can unblock them by uncommenting one
72617d15b25SDag-Erling Smørgrav	# of the nodefault statements below.
72717d15b25SDag-Erling Smørgrav	# You may also have to use domain-insecure: zone to make DNSSEC work,
72817d15b25SDag-Erling Smørgrav	# unless you have your own trust anchors for this zone.
72917d15b25SDag-Erling Smørgrav	# local-zone: "localhost." nodefault
73017d15b25SDag-Erling Smørgrav	# local-zone: "127.in-addr.arpa." nodefault
73117d15b25SDag-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
73224e36522SCy Schubert	# local-zone: "home.arpa." nodefault
733f61ef7f6SDag-Erling Smørgrav	# local-zone: "onion." nodefault
734971980c3SDag-Erling Smørgrav	# local-zone: "test." nodefault
735971980c3SDag-Erling Smørgrav	# local-zone: "invalid." nodefault
73617d15b25SDag-Erling Smørgrav	# local-zone: "10.in-addr.arpa." nodefault
73717d15b25SDag-Erling Smørgrav	# local-zone: "16.172.in-addr.arpa." nodefault
73817d15b25SDag-Erling Smørgrav	# local-zone: "17.172.in-addr.arpa." nodefault
73917d15b25SDag-Erling Smørgrav	# local-zone: "18.172.in-addr.arpa." nodefault
74017d15b25SDag-Erling Smørgrav	# local-zone: "19.172.in-addr.arpa." nodefault
74117d15b25SDag-Erling Smørgrav	# local-zone: "20.172.in-addr.arpa." nodefault
74217d15b25SDag-Erling Smørgrav	# local-zone: "21.172.in-addr.arpa." nodefault
74317d15b25SDag-Erling Smørgrav	# local-zone: "22.172.in-addr.arpa." nodefault
74417d15b25SDag-Erling Smørgrav	# local-zone: "23.172.in-addr.arpa." nodefault
74517d15b25SDag-Erling Smørgrav	# local-zone: "24.172.in-addr.arpa." nodefault
74617d15b25SDag-Erling Smørgrav	# local-zone: "25.172.in-addr.arpa." nodefault
74717d15b25SDag-Erling Smørgrav	# local-zone: "26.172.in-addr.arpa." nodefault
74817d15b25SDag-Erling Smørgrav	# local-zone: "27.172.in-addr.arpa." nodefault
74917d15b25SDag-Erling Smørgrav	# local-zone: "28.172.in-addr.arpa." nodefault
75017d15b25SDag-Erling Smørgrav	# local-zone: "29.172.in-addr.arpa." nodefault
75117d15b25SDag-Erling Smørgrav	# local-zone: "30.172.in-addr.arpa." nodefault
75217d15b25SDag-Erling Smørgrav	# local-zone: "31.172.in-addr.arpa." nodefault
75317d15b25SDag-Erling Smørgrav	# local-zone: "168.192.in-addr.arpa." nodefault
75417d15b25SDag-Erling Smørgrav	# local-zone: "0.in-addr.arpa." nodefault
75517d15b25SDag-Erling Smørgrav	# local-zone: "254.169.in-addr.arpa." nodefault
75617d15b25SDag-Erling Smørgrav	# local-zone: "2.0.192.in-addr.arpa." nodefault
75717d15b25SDag-Erling Smørgrav	# local-zone: "100.51.198.in-addr.arpa." nodefault
75817d15b25SDag-Erling Smørgrav	# local-zone: "113.0.203.in-addr.arpa." nodefault
75917d15b25SDag-Erling Smørgrav	# local-zone: "255.255.255.255.in-addr.arpa." nodefault
76017d15b25SDag-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
76117d15b25SDag-Erling Smørgrav	# local-zone: "d.f.ip6.arpa." nodefault
76217d15b25SDag-Erling Smørgrav	# local-zone: "8.e.f.ip6.arpa." nodefault
76317d15b25SDag-Erling Smørgrav	# local-zone: "9.e.f.ip6.arpa." nodefault
76417d15b25SDag-Erling Smørgrav	# local-zone: "a.e.f.ip6.arpa." nodefault
76517d15b25SDag-Erling Smørgrav	# local-zone: "b.e.f.ip6.arpa." nodefault
76617d15b25SDag-Erling Smørgrav	# local-zone: "8.b.d.0.1.0.0.2.ip6.arpa." nodefault
767ff825849SDag-Erling Smørgrav	# And for 64.100.in-addr.arpa. to 127.100.in-addr.arpa.
768ff825849SDag-Erling Smørgrav
7690eefd307SCy Schubert	# Add example.com into ipset
7700eefd307SCy Schubert	# local-zone: "example.com" ipset
7710eefd307SCy Schubert
7729cf5bc93SCy Schubert	# If Unbound is running service for the local host then it is useful
773ff825849SDag-Erling Smørgrav	# to perform lan-wide lookups to the upstream, and unblock the
7749cf5bc93SCy Schubert	# long list of local-zones above.  If this Unbound is a dns server
775ff825849SDag-Erling Smørgrav	# for a network of computers, disabled is better and stops information
776ff825849SDag-Erling Smørgrav	# leakage of local lan information.
777ff825849SDag-Erling Smørgrav	# unblock-lan-zones: no
77817d15b25SDag-Erling Smørgrav
7790de4f1bfSDag-Erling Smørgrav	# The insecure-lan-zones option disables validation for
7800de4f1bfSDag-Erling Smørgrav	# these zones, as if they were all listed as domain-insecure.
7810de4f1bfSDag-Erling Smørgrav	# insecure-lan-zones: no
7820de4f1bfSDag-Erling Smørgrav
783b7579f77SDag-Erling Smørgrav	# a number of locally served zones can be configured.
784b7579f77SDag-Erling Smørgrav	# 	local-zone: <zone> <type>
785b7579f77SDag-Erling Smørgrav	# 	local-data: "<resource record string>"
786b7579f77SDag-Erling Smørgrav	# o deny serves local data (if any), else, drops queries.
787b7579f77SDag-Erling Smørgrav	# o refuse serves local data (if any), else, replies with error.
788b7579f77SDag-Erling Smørgrav	# o static serves local data, else, nxdomain or nodata answer.
789b7579f77SDag-Erling Smørgrav	# o transparent gives local data, but resolves normally for other names
790b7579f77SDag-Erling Smørgrav	# o redirect serves the zone data for any subdomain in the zone.
791b7579f77SDag-Erling Smørgrav	# o nodefault can be used to normally resolve AS112 zones.
792b7579f77SDag-Erling Smørgrav	# o typetransparent resolves normally for other types and other names
793bc892140SDag-Erling Smørgrav	# o inform acts like transparent, but logs client IP address
79409a3aaf3SDag-Erling Smørgrav	# o inform_deny drops queries and logs client IP address
795e86b9096SDag-Erling Smørgrav	# o inform_redirect redirects queries and logs client IP address
796f44e67d1SCy Schubert	# o always_transparent, always_refuse, always_nxdomain, always_nodata,
797f44e67d1SCy Schubert	#   always_deny resolve in that way but ignore local data for
798f44e67d1SCy Schubert	#   that name
799f44e67d1SCy Schubert	# o always_null returns 0.0.0.0 or ::0 for any name in the zone.
80057bddd21SDag-Erling Smørgrav	# o noview breaks out of that view towards global local-zones.
801b7579f77SDag-Erling Smørgrav	#
802b7579f77SDag-Erling Smørgrav	# defaults are localhost address, reverse for 127.0.0.1 and ::1
803b7579f77SDag-Erling Smørgrav	# and nxdomain for AS112 zones. If you configure one of these zones
804b7579f77SDag-Erling Smørgrav	# the default content is omitted, or you can omit it with 'nodefault'.
805b7579f77SDag-Erling Smørgrav	#
806b7579f77SDag-Erling Smørgrav	# If you configure local-data without specifying local-zone, by
807b7579f77SDag-Erling Smørgrav	# default a transparent local-zone is created for the data.
808b7579f77SDag-Erling Smørgrav	#
809b7579f77SDag-Erling Smørgrav	# You can add locally served data with
810b7579f77SDag-Erling Smørgrav	# local-zone: "local." static
811b7579f77SDag-Erling Smørgrav	# local-data: "mycomputer.local. IN A 192.0.2.51"
812b7579f77SDag-Erling Smørgrav	# local-data: 'mytext.local TXT "content of text record"'
813b7579f77SDag-Erling Smørgrav	#
814b7579f77SDag-Erling Smørgrav	# You can override certain queries with
815b7579f77SDag-Erling Smørgrav	# local-data: "adserver.example.com A 127.0.0.1"
816b7579f77SDag-Erling Smørgrav	#
817b7579f77SDag-Erling Smørgrav	# You can redirect a domain to a fixed address with
818b7579f77SDag-Erling Smørgrav	# (this makes example.com, www.example.com, etc, all go to 192.0.2.3)
819b7579f77SDag-Erling Smørgrav	# local-zone: "example.com" redirect
820b7579f77SDag-Erling Smørgrav	# local-data: "example.com A 192.0.2.3"
821b7579f77SDag-Erling Smørgrav	#
822b7579f77SDag-Erling Smørgrav	# Shorthand to make PTR records, "IPv4 name" or "IPv6 name".
823b7579f77SDag-Erling Smørgrav	# You can also add PTR records using local-data directly, but then
824b7579f77SDag-Erling Smørgrav	# you need to do the reverse notation yourself.
825b7579f77SDag-Erling Smørgrav	# local-data-ptr: "192.0.2.3 www.example.com"
826b7579f77SDag-Erling Smørgrav
827b5663de9SDag-Erling Smørgrav	# tag a localzone with a list of tag names (in "" with spaces between)
828b5663de9SDag-Erling Smørgrav	# local-zone-tag: "example.com" "tag2 tag3"
829b5663de9SDag-Erling Smørgrav
830b5663de9SDag-Erling Smørgrav	# add a netblock specific override to a localzone, with zone type
831b5663de9SDag-Erling Smørgrav	# local-zone-override: "example.com" 192.0.2.0/24 refuse
832b5663de9SDag-Erling Smørgrav
833c0caa2e2SCy Schubert	# service clients over TLS (on the TCP sockets) with plain DNS inside
834c0caa2e2SCy Schubert	# the TLS stream, and over HTTPS using HTTP/2 as specified in RFC8484.
835c0caa2e2SCy Schubert	# Give the certificate to use and private key.
836b7579f77SDag-Erling Smørgrav	# default is "" (disabled).  requires restart to take effect.
83757bddd21SDag-Erling Smørgrav	# tls-service-key: "path/to/privatekeyfile.key"
83857bddd21SDag-Erling Smørgrav	# tls-service-pem: "path/to/publiccertfile.pem"
83957bddd21SDag-Erling Smørgrav	# tls-port: 853
840c0caa2e2SCy Schubert	# https-port: 443
841b7579f77SDag-Erling Smørgrav
842e86b9096SDag-Erling Smørgrav	# cipher setting for TLSv1.2
843e86b9096SDag-Erling Smørgrav	# tls-ciphers: "DHE-RSA-AES256-GCM-SHA384:DHE-RSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-GCM-SHA256:DHE-RSA-AES256-SHA256:DHE-RSA-AES128-SHA256:ECDHE-RSA-AES256-SHA384:ECDHE-RSA-AES128-SHA256"
844e86b9096SDag-Erling Smørgrav	# cipher setting for TLSv1.3
845e86b9096SDag-Erling Smørgrav	# tls-ciphersuites: "TLS_AES_128_GCM_SHA256:TLS_AES_128_CCM_8_SHA256:TLS_AES_128_CCM_SHA256:TLS_AES_256_GCM_SHA384:TLS_CHACHA20_POLY1305_SHA256"
846e86b9096SDag-Erling Smørgrav
847f44e67d1SCy Schubert	# Pad responses to padded queries received over TLS
848f44e67d1SCy Schubert	# pad-responses: yes
849f44e67d1SCy Schubert
850f44e67d1SCy Schubert	# Padded responses will be padded to the closest multiple of this size.
851f44e67d1SCy Schubert	# pad-responses-block-size: 468
852f44e67d1SCy Schubert
85325039b37SCy Schubert	# Use the SNI extension for TLS connections.  Default is yes.
85425039b37SCy Schubert	# Changing the value requires a reload.
85525039b37SCy Schubert	# tls-use-sni: yes
85625039b37SCy Schubert
857e86b9096SDag-Erling Smørgrav	# Add the secret file for TLS Session Ticket.
858e86b9096SDag-Erling Smørgrav	# Secret file must be 80 bytes of random data.
859e86b9096SDag-Erling Smørgrav	# First key use to encrypt and decrypt TLS session tickets.
860e86b9096SDag-Erling Smørgrav	# Other keys use to decrypt only.
861e86b9096SDag-Erling Smørgrav	# requires restart to take effect.
862e86b9096SDag-Erling Smørgrav	# tls-session-ticket-keys: "path/to/secret_file1"
863e86b9096SDag-Erling Smørgrav	# tls-session-ticket-keys: "path/to/secret_file2"
864e86b9096SDag-Erling Smørgrav
8650fb34990SDag-Erling Smørgrav	# request upstream over TLS (with plain DNS inside the TLS stream).
866b7579f77SDag-Erling Smørgrav	# Default is no.  Can be turned on and off with unbound-control.
86757bddd21SDag-Erling Smørgrav	# tls-upstream: no
86857bddd21SDag-Erling Smørgrav
86957bddd21SDag-Erling Smørgrav	# Certificates used to authenticate connections made upstream.
87057bddd21SDag-Erling Smørgrav	# tls-cert-bundle: ""
871b7579f77SDag-Erling Smørgrav
8723bd4df0aSDag-Erling Smørgrav	# Add system certs to the cert bundle, from the Windows Cert Store
8733bd4df0aSDag-Erling Smørgrav	# tls-win-cert: no
874a39a5a69SCy Schubert	# and on other systems, the default openssl certificates
875a39a5a69SCy Schubert	# tls-system-cert: no
8763bd4df0aSDag-Erling Smørgrav
877f44e67d1SCy Schubert	# Pad queries over TLS upstreams
878f44e67d1SCy Schubert	# pad-queries: yes
879f44e67d1SCy Schubert
880f44e67d1SCy Schubert	# Padded queries will be padded to the closest multiple of this size.
881f44e67d1SCy Schubert	# pad-queries-block-size: 128
882f44e67d1SCy Schubert
8830fb34990SDag-Erling Smørgrav	# Also serve tls on these port numbers (eg. 443, ...), by listing
8847da0adf7SDag-Erling Smørgrav	# tls-additional-port: portno for each of the port numbers.
8850fb34990SDag-Erling Smørgrav
886c0caa2e2SCy Schubert	# HTTP endpoint to provide DNS-over-HTTPS service on.
887c0caa2e2SCy Schubert	# http-endpoint: "/dns-query"
888c0caa2e2SCy Schubert
889c0caa2e2SCy Schubert	# HTTP/2 SETTINGS_MAX_CONCURRENT_STREAMS value to use.
890c0caa2e2SCy Schubert	# http-max-streams: 100
891c0caa2e2SCy Schubert
892c0caa2e2SCy Schubert	# Maximum number of bytes used for all HTTP/2 query buffers.
893c0caa2e2SCy Schubert	# http-query-buffer-size: 4m
894c0caa2e2SCy Schubert
895c0caa2e2SCy Schubert	# Maximum number of bytes used for all HTTP/2 response buffers.
896c0caa2e2SCy Schubert	# http-response-buffer-size: 4m
897c0caa2e2SCy Schubert
898c0caa2e2SCy Schubert	# Set TCP_NODELAY socket option on sockets used for DNS-over-HTTPS
899c0caa2e2SCy Schubert	# service.
900c0caa2e2SCy Schubert	# http-nodelay: yes
901c0caa2e2SCy Schubert
902369c6923SCy Schubert	# Disable TLS for DNS-over-HTTP downstream service.
903369c6923SCy Schubert	# http-notls-downstream: no
904369c6923SCy Schubert
905*865f46b2SCy Schubert	# The interfaces that use these listed port numbers will support and
906*865f46b2SCy Schubert	# expect PROXYv2. For UDP and TCP/TLS interfaces.
907*865f46b2SCy Schubert	# proxy-protocol-port: portno for each of the port numbers.
908*865f46b2SCy Schubert
909ff825849SDag-Erling Smørgrav	# DNS64 prefix. Must be specified when DNS64 is use.
910ff825849SDag-Erling Smørgrav	# Enable dns64 in module-config.  Used to synthesize IPv6 from IPv4.
911ff825849SDag-Erling Smørgrav	# dns64-prefix: 64:ff9b::0/96
912ff825849SDag-Erling Smørgrav
9134c75e3aaSDag-Erling Smørgrav	# DNS64 ignore AAAA records for these domains and use A instead.
9144c75e3aaSDag-Erling Smørgrav	# dns64-ignore-aaaa: "example.com"
9154c75e3aaSDag-Erling Smørgrav
91609a3aaf3SDag-Erling Smørgrav	# ratelimit for uncached, new queries, this limits recursion effort.
91709a3aaf3SDag-Erling Smørgrav	# ratelimiting is experimental, and may help against randomqueryflood.
91809a3aaf3SDag-Erling Smørgrav	# if 0(default) it is disabled, otherwise state qps allowed per zone.
91909a3aaf3SDag-Erling Smørgrav	# ratelimit: 0
92009a3aaf3SDag-Erling Smørgrav
92109a3aaf3SDag-Erling Smørgrav	# ratelimits are tracked in a cache, size in bytes of cache (or k,m).
92209a3aaf3SDag-Erling Smørgrav	# ratelimit-size: 4m
92309a3aaf3SDag-Erling Smørgrav	# ratelimit cache slabs, reduces lock contention if equal to cpucount.
92409a3aaf3SDag-Erling Smørgrav	# ratelimit-slabs: 4
92509a3aaf3SDag-Erling Smørgrav
92609a3aaf3SDag-Erling Smørgrav	# 0 blocks when ratelimited, otherwise let 1/xth traffic through
92709a3aaf3SDag-Erling Smørgrav	# ratelimit-factor: 10
92809a3aaf3SDag-Erling Smørgrav
9299cf5bc93SCy Schubert	# Aggressive rate limit when the limit is reached and until demand has
9309cf5bc93SCy Schubert	# decreased in a 2 second rate window.
9319cf5bc93SCy Schubert	# ratelimit-backoff: no
9329cf5bc93SCy Schubert
93309a3aaf3SDag-Erling Smørgrav	# override the ratelimit for a specific domain name.
93409a3aaf3SDag-Erling Smørgrav	# give this setting multiple times to have multiple overrides.
93509a3aaf3SDag-Erling Smørgrav	# ratelimit-for-domain: example.com 1000
93609a3aaf3SDag-Erling Smørgrav	# override the ratelimits for all domains below a domain name
93709a3aaf3SDag-Erling Smørgrav	# can give this multiple times, the name closest to the zone is used.
938b5663de9SDag-Erling Smørgrav	# ratelimit-below-domain: com 1000
93909a3aaf3SDag-Erling Smørgrav
9403005e0a3SDag-Erling Smørgrav	# global query ratelimit for all ip addresses.
9413005e0a3SDag-Erling Smørgrav	# feature is experimental.
9423005e0a3SDag-Erling Smørgrav	# if 0(default) it is disabled, otherwise states qps allowed per ip address
9433005e0a3SDag-Erling Smørgrav	# ip-ratelimit: 0
9443005e0a3SDag-Erling Smørgrav
9453005e0a3SDag-Erling Smørgrav	# ip ratelimits are tracked in a cache, size in bytes of cache (or k,m).
9463005e0a3SDag-Erling Smørgrav	# ip-ratelimit-size: 4m
9473005e0a3SDag-Erling Smørgrav	# ip ratelimit cache slabs, reduces lock contention if equal to cpucount.
9483005e0a3SDag-Erling Smørgrav	# ip-ratelimit-slabs: 4
9493005e0a3SDag-Erling Smørgrav
9503005e0a3SDag-Erling Smørgrav	# 0 blocks when ip is ratelimited, otherwise let 1/xth traffic through
9513005e0a3SDag-Erling Smørgrav	# ip-ratelimit-factor: 10
9523005e0a3SDag-Erling Smørgrav
9539cf5bc93SCy Schubert	# Aggressive rate limit when the limit is reached and until demand has
9549cf5bc93SCy Schubert	# decreased in a 2 second rate window.
9559cf5bc93SCy Schubert	# ip-ratelimit-backoff: no
9569cf5bc93SCy Schubert
9574c75e3aaSDag-Erling Smørgrav	# Limit the number of connections simultaneous from a netblock
9584c75e3aaSDag-Erling Smørgrav	# tcp-connection-limit: 192.0.2.0/24 12
9594c75e3aaSDag-Erling Smørgrav
960e86b9096SDag-Erling Smørgrav	# select from the fastest servers this many times out of 1000. 0 means
961e86b9096SDag-Erling Smørgrav	# the fast server select is disabled. prefetches are not sped up.
962e86b9096SDag-Erling Smørgrav	# fast-server-permil: 0
963e86b9096SDag-Erling Smørgrav	# the number of servers that will be used in the fast server selection.
964e86b9096SDag-Erling Smørgrav	# fast-server-num: 3
9650fb34990SDag-Erling Smørgrav
966a39a5a69SCy Schubert	# Enable to attach Extended DNS Error codes (RFC8914) to responses.
967a39a5a69SCy Schubert	# ede: no
968a39a5a69SCy Schubert
969a39a5a69SCy Schubert	# Enable to attach an Extended DNS Error (RFC8914) Code 3 - Stale
970a39a5a69SCy Schubert	# Answer as EDNS0 option to expired responses.
971a39a5a69SCy Schubert	# Note that the ede option above needs to be enabled for this to work.
972a39a5a69SCy Schubert	# ede-serve-expired: no
973a39a5a69SCy Schubert
9749cf5bc93SCy Schubert	# Specific options for ipsecmod. Unbound needs to be configured with
975c7f4d7adSDag-Erling Smørgrav	# --enable-ipsecmod for these to take effect.
976c7f4d7adSDag-Erling Smørgrav	#
977c7f4d7adSDag-Erling Smørgrav	# Enable or disable ipsecmod (it still needs to be defined in
978c7f4d7adSDag-Erling Smørgrav	# module-config above). Can be used when ipsecmod needs to be
979c7f4d7adSDag-Erling Smørgrav	# enabled/disabled via remote-control(below).
980c7f4d7adSDag-Erling Smørgrav	# ipsecmod-enabled: yes
981c7f4d7adSDag-Erling Smørgrav	#
982c7f4d7adSDag-Erling Smørgrav	# Path to executable external hook. It must be defined when ipsecmod is
983c7f4d7adSDag-Erling Smørgrav	# listed in module-config (above).
984c7f4d7adSDag-Erling Smørgrav	# ipsecmod-hook: "./my_executable"
985c7f4d7adSDag-Erling Smørgrav	#
9869cf5bc93SCy Schubert	# When enabled Unbound will reply with SERVFAIL if the return value of
987c7f4d7adSDag-Erling Smørgrav	# the ipsecmod-hook is not 0.
988c7f4d7adSDag-Erling Smørgrav	# ipsecmod-strict: no
989c7f4d7adSDag-Erling Smørgrav	#
990c7f4d7adSDag-Erling Smørgrav	# Maximum time to live (TTL) for cached A/AAAA records with IPSECKEY.
991c7f4d7adSDag-Erling Smørgrav	# ipsecmod-max-ttl: 3600
992c7f4d7adSDag-Erling Smørgrav	#
993c7f4d7adSDag-Erling Smørgrav	# Reply with A/AAAA even if the relevant IPSECKEY is bogus. Mainly used for
994c7f4d7adSDag-Erling Smørgrav	# testing.
995c7f4d7adSDag-Erling Smørgrav	# ipsecmod-ignore-bogus: no
996c7f4d7adSDag-Erling Smørgrav	#
997c7f4d7adSDag-Erling Smørgrav	# Domains for which ipsecmod will be triggered. If not defined (default)
998c0caa2e2SCy Schubert	# all domains are treated as being allowed.
999c0caa2e2SCy Schubert	# ipsecmod-allow: "example.com"
1000c0caa2e2SCy Schubert	# ipsecmod-allow: "nlnetlabs.nl"
1001c7f4d7adSDag-Erling Smørgrav
10025469a995SCy Schubert	# Timeout for REUSE entries in milliseconds.
10035469a995SCy Schubert	# tcp-reuse-timeout: 60000
10045469a995SCy Schubert	# Max number of queries on a reuse connection.
10055469a995SCy Schubert	# max-reuse-tcp-queries: 200
10065469a995SCy Schubert	# Timeout in milliseconds for TCP queries to auth servers.
10075469a995SCy Schubert	# tcp-auth-query-timeout: 3000
10085469a995SCy Schubert
10093005e0a3SDag-Erling Smørgrav
1010b7579f77SDag-Erling Smørgrav# Python config section. To enable:
1011b7579f77SDag-Erling Smørgrav# o use --with-pythonmodule to configure before compiling.
1012b7579f77SDag-Erling Smørgrav# o list python in the module-config string (above) to enable.
1013e86b9096SDag-Erling Smørgrav#   It can be at the start, it gets validated results, or just before
1014e86b9096SDag-Erling Smørgrav#   the iterator and process before DNSSEC validation.
1015b7579f77SDag-Erling Smørgrav# o and give a python-script to run.
1016b7579f77SDag-Erling Smørgravpython:
1017b7579f77SDag-Erling Smørgrav	# Script file to load
1018b7579f77SDag-Erling Smørgrav	# python-script: "@UNBOUND_SHARE_DIR@/ubmodule-tst.py"
1019b7579f77SDag-Erling Smørgrav
102025039b37SCy Schubert# Dynamic library config section. To enable:
102125039b37SCy Schubert# o use --with-dynlibmodule to configure before compiling.
102225039b37SCy Schubert# o list dynlib in the module-config string (above) to enable.
102325039b37SCy Schubert#   It can be placed anywhere, the dynlib module is only a very thin wrapper
102425039b37SCy Schubert#   to load modules dynamically.
102525039b37SCy Schubert# o and give a dynlib-file to run. If more than one dynlib entry is listed in
102625039b37SCy Schubert#   the module-config then you need one dynlib-file per instance.
102725039b37SCy Schubertdynlib:
102825039b37SCy Schubert	# Script file to load
102925039b37SCy Schubert	# dynlib-file: "@UNBOUND_SHARE_DIR@/dynlib.so"
103025039b37SCy Schubert
1031b7579f77SDag-Erling Smørgrav# Remote control config section.
1032b7579f77SDag-Erling Smørgravremote-control:
1033b7579f77SDag-Erling Smørgrav	# Enable remote control with unbound-control(8) here.
1034b7579f77SDag-Erling Smørgrav	# set up the keys and certificates with unbound-control-setup.
1035b7579f77SDag-Erling Smørgrav	# control-enable: no
1036b7579f77SDag-Erling Smørgrav
1037b7579f77SDag-Erling Smørgrav	# what interfaces are listened to for remote control.
1038b7579f77SDag-Erling Smørgrav	# give 0.0.0.0 and ::0 to listen to all interfaces.
10397da0adf7SDag-Erling Smørgrav	# set to an absolute path to use a unix local name pipe, certificates
10407da0adf7SDag-Erling Smørgrav	# are not used for that, so key and cert files need not be present.
1041b7579f77SDag-Erling Smørgrav	# control-interface: 127.0.0.1
1042b7579f77SDag-Erling Smørgrav	# control-interface: ::1
1043b7579f77SDag-Erling Smørgrav
1044b7579f77SDag-Erling Smørgrav	# port number for remote control operations.
1045b7579f77SDag-Erling Smørgrav	# control-port: 8953
1046b7579f77SDag-Erling Smørgrav
10477da0adf7SDag-Erling Smørgrav	# for localhost, you can disable use of TLS by setting this to "no"
10487da0adf7SDag-Erling Smørgrav	# For local sockets this option is ignored, and TLS is not used.
10497da0adf7SDag-Erling Smørgrav	# control-use-cert: "yes"
10507da0adf7SDag-Erling Smørgrav
10519cf5bc93SCy Schubert	# Unbound server key file.
1052b7579f77SDag-Erling Smørgrav	# server-key-file: "@UNBOUND_RUN_DIR@/unbound_server.key"
1053b7579f77SDag-Erling Smørgrav
10549cf5bc93SCy Schubert	# Unbound server certificate file.
1055b7579f77SDag-Erling Smørgrav	# server-cert-file: "@UNBOUND_RUN_DIR@/unbound_server.pem"
1056b7579f77SDag-Erling Smørgrav
1057b7579f77SDag-Erling Smørgrav	# unbound-control key file.
1058b7579f77SDag-Erling Smørgrav	# control-key-file: "@UNBOUND_RUN_DIR@/unbound_control.key"
1059b7579f77SDag-Erling Smørgrav
1060b7579f77SDag-Erling Smørgrav	# unbound-control certificate file.
1061b7579f77SDag-Erling Smørgrav	# control-cert-file: "@UNBOUND_RUN_DIR@/unbound_control.pem"
1062b7579f77SDag-Erling Smørgrav
1063b7579f77SDag-Erling Smørgrav# Stub zones.
1064b7579f77SDag-Erling Smørgrav# Create entries like below, to make all queries for 'example.com' and
1065b7579f77SDag-Erling Smørgrav# 'example.org' go to the given list of nameservers. list zero or more
1066b7579f77SDag-Erling Smørgrav# nameservers by hostname or by ipaddress. If you set stub-prime to yes,
1067b7579f77SDag-Erling Smørgrav# the list is treated as priming hints (default is no).
1068b7579f77SDag-Erling Smørgrav# With stub-first yes, it attempts without the stub if it fails.
1069b75612f8SDag-Erling Smørgrav# Consider adding domain-insecure: name and local-zone: name nodefault
1070b75612f8SDag-Erling Smørgrav# to the server: section if the stub is a locally served zone.
1071b7579f77SDag-Erling Smørgrav# stub-zone:
1072b7579f77SDag-Erling Smørgrav#	name: "example.com"
1073b7579f77SDag-Erling Smørgrav#	stub-addr: 192.0.2.68
1074b7579f77SDag-Erling Smørgrav#	stub-prime: no
1075b7579f77SDag-Erling Smørgrav#	stub-first: no
107624e36522SCy Schubert#	stub-tcp-upstream: no
107757bddd21SDag-Erling Smørgrav#	stub-tls-upstream: no
10784c75e3aaSDag-Erling Smørgrav#	stub-no-cache: no
1079b7579f77SDag-Erling Smørgrav# stub-zone:
1080b7579f77SDag-Erling Smørgrav#	name: "example.org"
1081b7579f77SDag-Erling Smørgrav#	stub-host: ns.example.com.
1082b7579f77SDag-Erling Smørgrav
1083b7579f77SDag-Erling Smørgrav# Forward zones
1084b7579f77SDag-Erling Smørgrav# Create entries like below, to make all queries for 'example.com' and
1085b7579f77SDag-Erling Smørgrav# 'example.org' go to the given list of servers. These servers have to handle
1086b7579f77SDag-Erling Smørgrav# recursion to other nameservers. List zero or more nameservers by hostname
1087b7579f77SDag-Erling Smørgrav# or by ipaddress. Use an entry with name "." to forward all queries.
1088b7579f77SDag-Erling Smørgrav# If you enable forward-first, it attempts without the forward if it fails.
1089b7579f77SDag-Erling Smørgrav# forward-zone:
1090b7579f77SDag-Erling Smørgrav# 	name: "example.com"
1091b7579f77SDag-Erling Smørgrav# 	forward-addr: 192.0.2.68
1092b7579f77SDag-Erling Smørgrav# 	forward-addr: 192.0.2.73@5355  # forward to port 5355.
1093b7579f77SDag-Erling Smørgrav# 	forward-first: no
109424e36522SCy Schubert# 	forward-tcp-upstream: no
109557bddd21SDag-Erling Smørgrav# 	forward-tls-upstream: no
10964c75e3aaSDag-Erling Smørgrav#	forward-no-cache: no
1097b7579f77SDag-Erling Smørgrav# forward-zone:
1098b7579f77SDag-Erling Smørgrav# 	name: "example.org"
1099b7579f77SDag-Erling Smørgrav# 	forward-host: fwd.example.com
1100bc892140SDag-Erling Smørgrav
110157bddd21SDag-Erling Smørgrav# Authority zones
110257bddd21SDag-Erling Smørgrav# The data for these zones is kept locally, from a file or downloaded.
110357bddd21SDag-Erling Smørgrav# The data can be served to downstream clients, or used instead of the
110457bddd21SDag-Erling Smørgrav# upstream (which saves a lookup to the upstream).  The first example
110557bddd21SDag-Erling Smørgrav# has a copy of the root for local usage.  The second serves example.org
110657bddd21SDag-Erling Smørgrav# authoritatively.  zonefile: reads from file (and writes to it if you also
1107c0caa2e2SCy Schubert# download it), primary: fetches with AXFR and IXFR, or url to zonefile.
11080a92a9fcSCy Schubert# With allow-notify: you can give additional (apart from primaries and urls)
11090a92a9fcSCy Schubert# sources of notifies.
111057bddd21SDag-Erling Smørgrav# auth-zone:
111157bddd21SDag-Erling Smørgrav#	name: "."
1112c0caa2e2SCy Schubert#	primary: 199.9.14.201         # b.root-servers.net
1113c0caa2e2SCy Schubert#	primary: 192.33.4.12          # c.root-servers.net
1114c0caa2e2SCy Schubert#	primary: 199.7.91.13          # d.root-servers.net
1115c0caa2e2SCy Schubert#	primary: 192.5.5.241          # f.root-servers.net
1116c0caa2e2SCy Schubert#	primary: 192.112.36.4         # g.root-servers.net
1117c0caa2e2SCy Schubert#	primary: 193.0.14.129         # k.root-servers.net
1118c0caa2e2SCy Schubert#	primary: 192.0.47.132         # xfr.cjr.dns.icann.org
1119c0caa2e2SCy Schubert#	primary: 192.0.32.132         # xfr.lax.dns.icann.org
1120c0caa2e2SCy Schubert#	primary: 2001:500:200::b      # b.root-servers.net
1121c0caa2e2SCy Schubert#	primary: 2001:500:2::c        # c.root-servers.net
1122c0caa2e2SCy Schubert#	primary: 2001:500:2d::d       # d.root-servers.net
1123c0caa2e2SCy Schubert#	primary: 2001:500:2f::f       # f.root-servers.net
1124c0caa2e2SCy Schubert#	primary: 2001:500:12::d0d     # g.root-servers.net
1125c0caa2e2SCy Schubert#	primary: 2001:7fd::1          # k.root-servers.net
1126c0caa2e2SCy Schubert#	primary: 2620:0:2830:202::132 # xfr.cjr.dns.icann.org
1127c0caa2e2SCy Schubert#	primary: 2620:0:2d0:202::132  # xfr.lax.dns.icann.org
1128e86b9096SDag-Erling Smørgrav#	fallback-enabled: yes
112957bddd21SDag-Erling Smørgrav#	for-downstream: no
113057bddd21SDag-Erling Smørgrav#	for-upstream: yes
113157bddd21SDag-Erling Smørgrav# auth-zone:
113257bddd21SDag-Erling Smørgrav#	name: "example.org"
113357bddd21SDag-Erling Smørgrav#	for-downstream: yes
113457bddd21SDag-Erling Smørgrav#	for-upstream: yes
11355469a995SCy Schubert#	zonemd-check: no
11365469a995SCy Schubert#	zonemd-reject-absence: no
113757bddd21SDag-Erling Smørgrav#	zonefile: "example.org.zone"
113857bddd21SDag-Erling Smørgrav
1139bc892140SDag-Erling Smørgrav# Views
1140bc892140SDag-Erling Smørgrav# Create named views. Name must be unique. Map views to requests using
1141bc892140SDag-Erling Smørgrav# the access-control-view option. Views can contain zero or more local-zone
1142bc892140SDag-Erling Smørgrav# and local-data options. Options from matching views will override global
1143bc892140SDag-Erling Smørgrav# options. Global options will be used if no matching view is found.
1144bc892140SDag-Erling Smørgrav# With view-first yes, it will try to answer using the global local-zone and
1145bc892140SDag-Erling Smørgrav# local-data elements if there is no view specific match.
1146bc892140SDag-Erling Smørgrav# view:
1147bc892140SDag-Erling Smørgrav#	name: "viewname"
1148bc892140SDag-Erling Smørgrav#	local-zone: "example.com" redirect
1149bc892140SDag-Erling Smørgrav#	local-data: "example.com A 192.0.2.3"
115065b390aaSDag-Erling Smørgrav#	local-data-ptr: "192.0.2.3 www.example.com"
1151bc892140SDag-Erling Smørgrav#	view-first: no
1152bc892140SDag-Erling Smørgrav# view:
1153bc892140SDag-Erling Smørgrav#	name: "anotherview"
1154bc892140SDag-Erling Smørgrav#	local-zone: "example.com" refuse
115565b390aaSDag-Erling Smørgrav
115665b390aaSDag-Erling Smørgrav# DNSCrypt
11579cf5bc93SCy Schubert# To enable, use --enable-dnscrypt to configure before compiling.
115865b390aaSDag-Erling Smørgrav# Caveats:
11599cf5bc93SCy Schubert# 1. the keys/certs cannot be produced by Unbound. You can use dnscrypt-wrapper
116065b390aaSDag-Erling Smørgrav#   for this: https://github.com/cofyc/dnscrypt-wrapper/blob/master/README.md#usage
116165b390aaSDag-Erling Smørgrav# 2. dnscrypt channel attaches to an interface. you MUST set interfaces to
116265b390aaSDag-Erling Smørgrav#   listen on `dnscrypt-port` with the follo0wing snippet:
116365b390aaSDag-Erling Smørgrav# server:
116465b390aaSDag-Erling Smørgrav#     interface: 0.0.0.0@443
116565b390aaSDag-Erling Smørgrav#     interface: ::0@443
116665b390aaSDag-Erling Smørgrav#
116765b390aaSDag-Erling Smørgrav# Finally, `dnscrypt` config has its own section.
116865b390aaSDag-Erling Smørgrav# dnscrypt:
116965b390aaSDag-Erling Smørgrav#     dnscrypt-enable: yes
117065b390aaSDag-Erling Smørgrav#     dnscrypt-port: 443
117165b390aaSDag-Erling Smørgrav#     dnscrypt-provider: 2.dnscrypt-cert.example.com.
117265b390aaSDag-Erling Smørgrav#     dnscrypt-secret-key: /path/unbound-conf/keys1/1.key
117365b390aaSDag-Erling Smørgrav#     dnscrypt-secret-key: /path/unbound-conf/keys2/1.key
117465b390aaSDag-Erling Smørgrav#     dnscrypt-provider-cert: /path/unbound-conf/keys1/1.cert
117565b390aaSDag-Erling Smørgrav#     dnscrypt-provider-cert: /path/unbound-conf/keys2/1.cert
1176971980c3SDag-Erling Smørgrav
1177971980c3SDag-Erling Smørgrav# CacheDB
11789cf5bc93SCy Schubert# External backend DB as auxiliary cache.
11799cf5bc93SCy Schubert# To enable, use --enable-cachedb to configure before compiling.
11809cf5bc93SCy Schubert# Specify the backend name
1181971980c3SDag-Erling Smørgrav# (default is "testframe", which has no use other than for debugging and
1182971980c3SDag-Erling Smørgrav# testing) and backend-specific options.  The 'cachedb' module must be
1183e86b9096SDag-Erling Smørgrav# included in module-config, just before the iterator module.
1184971980c3SDag-Erling Smørgrav# cachedb:
1185971980c3SDag-Erling Smørgrav#     backend: "testframe"
1186971980c3SDag-Erling Smørgrav#     # secret seed string to calculate hashed keys
1187971980c3SDag-Erling Smørgrav#     secret-seed: "default"
11880fb34990SDag-Erling Smørgrav#
11890fb34990SDag-Erling Smørgrav#     # For "redis" backend:
11909cf5bc93SCy Schubert#     # (to enable, use --with-libhiredis to configure before compiling)
11910fb34990SDag-Erling Smørgrav#     # redis server's IP address or host name
11920fb34990SDag-Erling Smørgrav#     redis-server-host: 127.0.0.1
11930fb34990SDag-Erling Smørgrav#     # redis server's TCP port
11940fb34990SDag-Erling Smørgrav#     redis-server-port: 6379
11950fb34990SDag-Erling Smørgrav#     # timeout (in ms) for communication with the redis server
11960fb34990SDag-Erling Smørgrav#     redis-timeout: 100
119725039b37SCy Schubert#     # set timeout on redis records based on DNS response TTL
119825039b37SCy Schubert#     redis-expire-records: no
11990eefd307SCy Schubert
12000eefd307SCy Schubert# IPSet
12010eefd307SCy Schubert# Add specify domain into set via ipset.
12029cf5bc93SCy Schubert# To enable:
12039cf5bc93SCy Schubert# o use --enable-ipset to configure before compiling;
12049cf5bc93SCy Schubert# o Unbound then needs to run as root user.
12050eefd307SCy Schubert# ipset:
12060eefd307SCy Schubert#     # set name for ip v4 addresses
12070eefd307SCy Schubert#     name-v4: "list-v4"
12080eefd307SCy Schubert#     # set name for ip v6 addresses
12090eefd307SCy Schubert#     name-v6: "list-v6"
12100eefd307SCy Schubert#
12110eefd307SCy Schubert
12129cf5bc93SCy Schubert# Dnstap logging support, if compiled in by using --enable-dnstap to configure.
12139cf5bc93SCy Schubert# To enable, set the dnstap-enable to yes and also some of
12149cf5bc93SCy Schubert# dnstap-log-..-messages to yes.  And select an upstream log destination, by
12159cf5bc93SCy Schubert# socket path, TCP or TLS destination.
121625039b37SCy Schubert# dnstap:
121725039b37SCy Schubert# 	dnstap-enable: no
121825039b37SCy Schubert# 	# if set to yes frame streams will be used in bidirectional mode
121925039b37SCy Schubert# 	dnstap-bidirectional: yes
122025039b37SCy Schubert# 	dnstap-socket-path: "@DNSTAP_SOCKET_PATH@"
122125039b37SCy Schubert# 	# if "" use the unix socket in dnstap-socket-path, otherwise,
122225039b37SCy Schubert# 	# set it to "IPaddress[@port]" of the destination.
122325039b37SCy Schubert# 	dnstap-ip: ""
122425039b37SCy Schubert# 	# if set to yes if you want to use TLS to dnstap-ip, no for TCP.
122525039b37SCy Schubert# 	dnstap-tls: yes
122625039b37SCy Schubert# 	# name for authenticating the upstream server. or "" disabled.
122725039b37SCy Schubert# 	dnstap-tls-server-name: ""
12289cf5bc93SCy Schubert# 	# if "", it uses the cert bundle from the main Unbound config.
122925039b37SCy Schubert# 	dnstap-tls-cert-bundle: ""
123025039b37SCy Schubert# 	# key file for client authentication, or "" disabled.
123125039b37SCy Schubert# 	dnstap-tls-client-key-file: ""
123225039b37SCy Schubert# 	# cert file for client authentication, or "" disabled.
123325039b37SCy Schubert# 	dnstap-tls-client-cert-file: ""
123425039b37SCy Schubert# 	dnstap-send-identity: no
123525039b37SCy Schubert# 	dnstap-send-version: no
123625039b37SCy Schubert# 	# if "" it uses the hostname.
123725039b37SCy Schubert# 	dnstap-identity: ""
123825039b37SCy Schubert# 	# if "" it uses the package version.
123925039b37SCy Schubert# 	dnstap-version: ""
124025039b37SCy Schubert# 	dnstap-log-resolver-query-messages: no
124125039b37SCy Schubert# 	dnstap-log-resolver-response-messages: no
124225039b37SCy Schubert# 	dnstap-log-client-query-messages: no
124325039b37SCy Schubert# 	dnstap-log-client-response-messages: no
124425039b37SCy Schubert# 	dnstap-log-forwarder-query-messages: no
124525039b37SCy Schubert# 	dnstap-log-forwarder-response-messages: no
124625039b37SCy Schubert
1247091e9e46SCy Schubert# Response Policy Zones
124824e36522SCy Schubert# RPZ policies. Applied in order of configuration. QNAME, Response IP
124924e36522SCy Schubert# Address, nsdname, nsip and clientip triggers are supported. Supported
125024e36522SCy Schubert# actions are: NXDOMAIN, NODATA, PASSTHRU, DROP, Local Data, tcp-only
125124e36522SCy Schubert# and drop.  Policies can be loaded from a file, or using zone
125224e36522SCy Schubert# transfer, or using HTTP. The respip module needs to be added
1253091e9e46SCy Schubert# to the module-config, e.g.: module-config: "respip validator iterator".
1254091e9e46SCy Schubert# rpz:
1255091e9e46SCy Schubert#     name: "rpz.example.com"
1256091e9e46SCy Schubert#     zonefile: "rpz.example.com"
1257c0caa2e2SCy Schubert#     primary: 192.0.2.0
1258091e9e46SCy Schubert#     allow-notify: 192.0.2.0/32
1259091e9e46SCy Schubert#     url: http://www.example.com/rpz.example.org.zone
1260091e9e46SCy Schubert#     rpz-action-override: cname
1261091e9e46SCy Schubert#     rpz-cname-override: www.example.org
1262091e9e46SCy Schubert#     rpz-log: yes
1263091e9e46SCy Schubert#     rpz-log-name: "example policy"
12649cf5bc93SCy Schubert#     rpz-signal-nxdomain-ra: no
12659cf5bc93SCy Schubert#     for-downstream: no
1266091e9e46SCy Schubert#     tags: "example"
1267