Add more blurb.
[openresolv] / README.md
1 # openresolv
2
3 openresolv is a [resolvconf](https://en.wikipedia.org/wiki/Resolvconf)
4 implementation which manages `/etc/resolv.conf`.
5
6 `/etc/resolv.conf` is a file that holds the configuration for the local
7 resolution of domain names.
8 Normally this file is either static or maintained by a local daemon,
9 normally a DHCP daemon. But what happens if more than one thing wants to
10 control the file?
11 Say you have wired and wireless interfaces to different subnets and run a VPN
12 or two on top of that, how do you say which one controls the file?
13 It's also not as easy as just adding and removing the nameservers each client
14 knows about as different clients could add the same nameservers.
15
16 Enter resolvconf, the middleman between the network configuration services and
17 `/etc/resolv.conf`.
18 resolvconf itself is just a script that stores, removes and lists a full
19 `resolv.conf` generated for the interface. It then calls all the helper scripts
20 it knows about so it can configure the real `/etc/resolv.conf` and optionally
21 any local nameservers other than libc.
22
23 ## Reasons for using openresolv
24
25 Why openresolv over the [Debian implementation](http://qref.sourceforge.net/Debian/reference/ch-gateway.en.html#s-dns-resolvconf)? Here's some reasons
26   *  Works with [POSIX shell and userland](http://www.opengroup.org/onlinepubs/009695399)
27   *  Does not need awk, grep or sed which means we can work without `/usr`
28  mounted
29   *  Works with other init systems than Debians' out of the box
30   *  Available as a 2 clause [BSD license](http://www.freebsd.org/copyright/freebsd-license.html)
31   *  Prefer configs via IF_METRIC for dynamic ordering
32   *  Configures zones for local resolvers other than libc
33
34 The last point is quite important, especially when running VPN systems. Take the following resolv.conf files which have been generated by a
35 [DHCP client](../dhcpcd) and sent to resolvconf:
36
37 ```
38 # resolv.conf from bge0
39 search foo.com
40 nameserver 1.2.3.4
41
42 # resolv.conf from tap0
43 domain bar.org
44 nameserver 5.6.7.8
45 ```
46
47 In this instance, queries for foo.com will go to 1.2.3.4 and queries for
48 bar.org will go to 5.6.7.8.
49 This does require the resolvers to be configured to pickup the resolvconf
50 generated configuration for them though.
51 openresolv ships with helpers for:
52   *  [unbound](http://www.unbound.net/).
53   *  [dnsmasq](http://www.thekelleys.org.uk/dnsmasq/doc.html)
54   *  [ISC BIND](http://www.isc.org/software/bind)
55   *  [PowerDNS Recursor](http://wiki.powerdns.com/trac)
56
57 See the
58 [configuration section](https://roy.marples.name/projects/openresolv/config)
59 for more details.