1.\" Copyright (c) 2009-2016 Roy Marples 2.\" All rights reserved 3.\" 4.\" Redistribution and use in source and binary forms, with or without 5.\" modification, are permitted provided that the following conditions 6.\" are met: 7.\" 1. Redistributions of source code must retain the above copyright 8.\" notice, this list of conditions and the following disclaimer. 9.\" 2. Redistributions in binary form must reproduce the above copyright 10.\" notice, this list of conditions and the following disclaimer in the 11.\" documentation and/or other materials provided with the distribution. 12.\" 13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 16.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 23.\" SUCH DAMAGE. 24.\" 25.Dd February 21, 2016 26.Dt RESOLVCONF.CONF 5 27.Os 28.Sh NAME 29.Nm resolvconf.conf 30.Nd resolvconf configuration file 31.Sh DESCRIPTION 32.Nm 33is the configuration file for 34.Xr resolvconf 8 . 35The 36.Nm 37file is a shell script that is sourced by 38.Xr resolvconf 8 , 39meaning that 40.Nm 41must contain valid shell commands. 42Listed below are the standard 43.Nm 44variables that may be set. 45If the values contain whitespace, wildcards or other special shell characters, 46ensure they are quoted and escaped correctly. 47See the 48.Sy replace 49variable for an example on quoting. 50.Pp 51After updating this file, you may wish to run 52.Nm resolvconf -u 53to apply the new configuration. 54.Pp 55When a dynamically generated list is appended or prepended to, the whole 56is made unique where left-most wins. 57.Sh RESOLVCONF OPTIONS 58.Bl -tag -width indent 59.It Sy resolvconf 60Set to NO to disable 61.Nm resolvconf 62from running any subscribers. 63Defaults to YES. 64.It Sy interface_order 65These interfaces will always be processed first. 66If unset, defaults to the following:- 67.D1 lo lo[0-9]* 68.It Sy dynamic_order 69These interfaces will be processed next, unless they have a metric. 70If unset, defaults to the following:- 71.D1 tap[0-9]* tun[0-9]* vpn vpn[0-9]* ppp[0-9]* ippp[0-9]* 72.It Sy local_nameservers 73If unset, defaults to the following:- 74.D1 127.* 0.0.0.0 255.255.255.255 ::1 75.It Sy search_domains 76Prepend search domains to the dynamically generated list. 77.It Sy search_domains_append 78Append search domains to the dynamically generated list. 79.It Sy domain_blacklist 80A list of domains to be removed from consideration. 81To remove a domain, you can use foo.* 82To remove a sub domain, you can use *.bar 83.It Sy name_servers 84Prepend name servers to the dynamically generated list. 85You should set this to 127.0.0.1 if you use a local name server other than 86libc. 87.It Sy name_servers_append 88Append name servers to the dynamically generated list. 89.It Sy name_server_blacklist 90A list of name servers to be removed from consideration. 91The default is 0.0.0.0 as some faulty routers send it via DHCP. 92To remove a block, you can use 192.168.* 93.It Sy private_interfaces 94These interfaces name servers will only be queried for the domains listed 95in their resolv.conf. 96Useful for VPN domains. 97Setting 98.Sy private_interfaces Ns ="*" 99will stop the forwarding of the root zone and allows the local resolver to 100recursively query the root servers directly. 101Requires a local nameserver other than libc. 102This is equivalent to the 103.Nm resolvconf -p 104option. 105.It Sy replace 106Is a space separated list of replacement keywords. The syntax is this: 107.Va $keyword Ns / Ns Va $match Ns / Ns Va $replacement 108.Pp 109Example, given this resolv.conf: 110.D1 domain foo.org 111.D1 search foo.org dead.beef 112.D1 nameserver 1.2.3.4 113.D1 nameserver 2.3.4.5 114and this configuaration: 115.D1 replace="search/foo*/bar.com nameserver/1.2.3.4/5.6.7.8 nameserver/2.3.4.5/" 116you would get this resolv.conf instead: 117.D1 domain foo.org 118.D1 search bar.com 119.D1 nameserver 5.6.7.8 120.It Sy replace_sub 121Works the same way as 122.Sy replace 123except it works on each space separated value rather than the whole line, 124so it's useful for the replacing a single domain within the search directive. 125Using the same example resolv.conf and changing 126.Sy replace 127to 128.Sy replace_sub , 129you would get this resolv.conf instead: 130.D1 domain foo.org 131.D1 search bar.com dead.beef 132.D1 nameserver 5.6.7.8 133.It Sy state_dir 134Override the default state directory of 135.Pa @VARDIR@ . 136This should not be changed once 137.Nm resolvconf 138is in use unless the old directory is copied to the new one. 139.El 140.Sh LIBC OPTIONS 141The following variables affect 142.Xr resolv.conf 5 143directly:- 144.Bl -tag -width indent 145.It Sy resolv_conf 146Defaults to 147.Pa /etc/resolv.conf 148if not set. 149.It Sy resolv_conf_options 150A list of libc resolver options, as specified in 151.Xr resolv.conf 5 . 152.It Sy resolv_conf_passthrough 153When set to YES the latest resolv.conf is written to 154.Sy resolv_conf 155without any alteration. 156When set to /dev/null or NULL, 157.Sy resolv_conf_local_only 158is defaulted to NO, 159.Sy local_nameservers 160is unset unless overridden and only the information set in 161.Nm 162is written to 163.Sy resolv_conf . 164.It Sy resolv_conf_sortlist 165A libc resolver sortlist, as specified in 166.Xr resolv.conf 5 . 167.It Sy resolv_conf_local_only 168If a local name server is configured then the default is just to specify that 169and ignore all other entries as they will be configured for the local 170name server. 171Set this to NO to also list non-local nameservers. 172This will give you working DNS even if the local nameserver stops functioning 173at the expense of duplicated server queries. 174.It Sy append_nameservers 175Append name servers to the dynamically generated list. 176.It Sy prepend_nameservers 177Prepend name servers to the dynamically generated list. 178.It Sy append_search 179Append search domains to the dynamically generated list. 180.It Sy prepend_search 181Prepend search domains to the dynamically generated list. 182.El 183.Sh SUBSCRIBER OPTIONS 184openresolv ships with subscribers for the name servers 185.Xr dnsmasq 8 , 186.Xr named 8 , 187.Xr pdnsd 8 188and 189.Xr unbound 8 . 190Each subscriber can create configuration files which should be included in 191in the subscribers main configuration file. 192.Pp 193To disable a subscriber, simply set it's name to NO. 194For example, to disable the libc subscriber you would set: 195.D1 libc=NO 196.Bl -tag -width indent 197.It Sy dnsmasq_conf 198This file tells dnsmasq which name servers to use for specific domains. 199.It Sy dnsmasq_resolv 200This file tells dnsmasq which name servers to use for global lookups. 201.Pp 202Example resolvconf.conf for dnsmasq: 203.D1 name_servers=127.0.0.1 204.D1 dnsmasq_conf=/etc/dnsmasq-conf.conf 205.D1 dnsmasq_resolv=/etc/dnsmasq-resolv.conf 206.Pp 207Example dnsmasq.conf: 208.D1 listen-address=127.0.0.1 209.D1 # If dnsmasq is compiled for DBus then we can take 210.D1 # advantage of not having to restart dnsmasq. 211.D1 enable-dbus 212.D1 conf-file=/etc/dnsmasq-conf.conf 213.D1 resolv-file=/etc/dnsmasq-resolv.conf 214.It Sy named_options 215Include this file in the named options block. 216This file tells named which name servers to use for global lookups. 217.It Sy named_zones 218Include this file in the named global scope, after the options block. 219This file tells named which name servers to use for specific domains. 220.Pp 221Example resolvconf.conf for named: 222.D1 name_servers=127.0.0.1 223.D1 named_options=/etc/named-options.conf 224.D1 named_zones=/etc/named-zones.conf 225.Pp 226Example named.conf: 227.D1 options { 228.D1 listen-on { 127.0.0.1; }; 229.D1 include "/etc/named-options.conf"; 230.D1 }; 231.D1 include "/etc/named-zones.conf"; 232.It Sy pdnsd_conf 233This is the main pdnsd configuration file which we modify to add our 234forward domains to. 235If this variable is not set then we rely on the pdnsd configuration file 236setup to read 237.Pa pdnsd_resolv 238as documented below. 239.It Sy pdnsd_resolv 240This file tells pdnsd about global name servers. 241If this variable is not set then it's written to 242.Pa pdnsd_conf . 243.Pp 244Example resolvconf.conf for pdnsd: 245.D1 name_servers=127.0.0.1 246.D1 pdnsd_conf=/etc/pdnsd.conf 247.D1 # pdnsd_resolv=/etc/pdnsd-resolv.conf 248.Pp 249Example pdnsd.conf: 250.D1 global { 251.D1 server_ip = 127.0.0.1; 252.D1 status_ctl = on; 253.D1 } 254.D1 server { 255.D1 # A server definition is required, even if emtpy. 256.D1 label="empty"; 257.D1 proxy_only=on; 258.D1 # file="/etc/pdnsd-resolv.conf"; 259.D1 } 260.It Sy unbound_conf 261This file tells unbound about specific and global name servers. 262.It Sy unbound_insecure 263When set to YES, unbound marks the domains as insecure, thus ignoring DNSSEC. 264.Pp 265Example resolvconf.conf for unbound: 266.D1 name_servers=127.0.0.1 267.D1 unbound_conf=/etc/unbound-resolvconf.conf 268.Pp 269Example unbound.conf: 270.D1 include: /etc/unbound-resolvconf.conf 271.El 272.Sh SUBSCRIBER INTEGRATION 273Not all distributions store the files the subscribers need in the same 274locations. 275For example, named service scripts have been called named, bind and rc.bind 276and they could be located in a directory called /etc/rc.d, /etc/init.d or 277similar. 278Each subscriber attempts to automatically configure itself, but not every 279distribution has been catered for. 280Also, users could equally want to use a different version from the one 281installed by default, such as bind8 and bind9. 282To accommodate this, the subscribers have these files in configurable 283variables, documented below. 284.Pp 285.Bl -tag -width indent 286.It Sy dnsmasq_service 287Location of the dnsmasq service. 288.It Sy dnsmasq_restart 289Command to restart the dnsmasq service. 290.It Sy dnsmasq_pid 291Location of the dnsmasq pidfile. 292.It Sy libc_service 293Location of the libc service. 294.It Sy libc_restart 295Command to restart the libc service. 296.It Sy named_service 297Location of the named service. 298.It Sy named_restart 299Command to restart the named service. 300.It Sy pdnsd_restart 301Command to restart the pdnsd service. 302.It Sy unbound_service 303Location of the unbound service. 304.It Sy unbound_restart 305Command to restart the unbound service. 306.It Sy unbound_pid 307Location of the unbound pidfile. 308.El 309.Sh SEE ALSO 310.Xr resolv.conf 5 , 311.Xr resolvconf 8 312and 313.Xr sh 1 . 314.Sh AUTHORS 315.An Roy Marples Aq Mt roy@marples.name 316.Sh BUGS 317Each distribution is a special snowflake and likes to name the same thing 318differently, namely the named service script. 319.Pp 320Please report them to 321.Lk http://roy.marples.name/projects/openresolv 322