Gitiles
Code Review Sign In
gerrit.nordix.org / thekelleys / dnsmasq / 7e22cf28f88f2c86b74158f01dad2292e095b296 / . / doc.html
blob: fb0704dba531088b452432dc60deb264558599c6 [file] [log] [blame]
Simon Kelley9e4abcb2004-01-22 19:47:41 +0000[diff] [blame]1<HTML>
2<HEAD>
Simon Kelley7e22cf22014-04-24 12:05:33 +0100[diff] [blame^]3<TITLE> Dnsmasq - network services for small networks.</TITLE>
Simon Kelley28866e92011-02-14 20:19:14 +0000[diff] [blame]4<link rel="icon"
5 href="http://www.thekelleys.org.uk/dnsmasq/images/favicon.ico">
Simon Kelley9e4abcb2004-01-22 19:47:41 +0000[diff] [blame]6</HEAD>
7<BODY BGCOLOR="WHITE">
Simon Kelley28866e92011-02-14 20:19:14 +0000[diff] [blame]8<table width="100%" border="0" cellpadding="0" cellspacing="0">
9<tr>
10<td align="left" valign="middle"><img border="0" src="http://www.thekelleys.org.uk/dnsmasq/images/icon.png" /></td>
11<td align="middle" valign="middle"><h1>Dnsmasq</h1></td>
12<td align="right" valign="middle"><img border="0" src="http://www.thekelleys.org.uk/dnsmasq/images/icon.png" /></td></tr>
13</table>
Simon Kelley7e22cf22014-04-24 12:05:33 +0100[diff] [blame^]14Dnsmasq provides network infrastructure for small networks: DNS, DHCP, router advertisement and network boot. It is designed to be
15lightweight and have a small footprint, suitable for resource constrained routers and firewalls. It has also been widely used
16for tethering on smartphones and portable hotspots, and to support virtual networking in virtualisation frameworks.
17Supported platforms include Linux (with glibc and uclibc), Android, *BSD, and Mac OS X. Dnsmasq is included in most
18Linux distributions and the ports systems of FreeBSD, OpenBSD and NetBSD. Dnsmasq provides full IPv6 support.
Simon Kelley28866e92011-02-14 20:19:14 +0000[diff] [blame]19
Simon Kelley9e4abcb2004-01-22 19:47:41 +0000[diff] [blame]20<P>
Simon Kelley7e22cf22014-04-24 12:05:33 +0100[diff] [blame^]21The DNS subsystem provides a local DNS server for the network, with forwarding of all query types to upstream recursive DNS servers and
22cacheing of common record types (A, AAAA, CNAME and PTR, also DNSKEY and DS when DNSSEC is enabled).
Simon Kelley9e4abcb2004-01-22 19:47:41 +0000[diff] [blame]23<DIR>
Simon Kelley7e22cf22014-04-24 12:05:33 +0100[diff] [blame^]24<LI>Local DNS names can be defined by reading /etc/hosts, by importing names from the DHCP subsystem, or by configuration of a wide range of useful record types.</LI>
25<LI>Upstream servers can be configured in a variety of convenient ways, including dynamic configuration as these change on moving upstream network.
26<LI>Authoritative DNS mode allows local DNS names may be exported to zone in the global DNS. Dnsmasq acts as authoritative server for this zone, and also provides
27zone transfer to secondaries for the zone, if required.</LI>
28<LI>DNSSEC validation may be performed on DNS replies from upstream nameservers, providing security against spoofing and cache poisoning.</LI>
29<LI>Specified sub-domains can be directed to their own upstream DNS servers, making VPN configuration easy.</LI>
30<LI>Internationalised domain names are supported.
Simon Kelley9e4abcb2004-01-22 19:47:41 +0000[diff] [blame]31</DIR>
Simon Kelley7e22cf22014-04-24 12:05:33 +0100[diff] [blame^]32<P>
33The DHCP subsystem supports DHCPv4, DHCPv6, BOOTP and PXE.
34<DIR>
35<LI> Both static and dynamic DHCP leases are supported, along with stateless mode in DHCPv6.</LI>
36<LI> The PXE system is a full PXE server, supporting netboot menus and multiple architecture support. It
37includes proxy-mode, where the PXE system co-operates with another DHCP server.</LI>
38<LI> There is a built in read-only TFTP server to support netboot.</LI>
39<LI> Machines which are configured by DHCP have their names automatically
40included in the DNS and the names can specified by each machine or
41centrally by associating a name with a MAC address or UID in the dnsmasq
42configuration file.</LI>
43</DIR>
44<P>
45The Router Advertisement subsystem provides basic autoconfiguration for IPv6 hosts. It can be used stand-alone or in conjunction with DHCPv6.
46<DIR>
47<LI> The M and O bits are configurable, to control hosts' use of DHCPv6.</LI>
48<LI> Router advertisements can include the RDNSS option.</LI>
49<LI> There is a mode which uses name information from DHCPv4 configuration to provide DNS entries
50 for autoconfigured IPv6 addresses which would otherwise be anonymous.</LI>
51</DIR>
52<P>
53
54For extra compactness, unused features may be omitted at compile time.
55
Simon Kelley9e4abcb2004-01-22 19:47:41 +0000[diff] [blame]56
Simon Kelley246839d2012-01-06 20:39:54 +0000[diff] [blame]57<H2>Get code.</H2>
Simon Kelley9e4abcb2004-01-22 19:47:41 +0000[diff] [blame]58
Simon Kelley246839d2012-01-06 20:39:54 +0000[diff] [blame]59<A HREF="http://www.thekelleys.org.uk/dnsmasq/">Download</A> dnsmasq here.
Simon Kelley4011c4e2006-10-28 16:26:19 +0100[diff] [blame]60The tarball includes this documentation, source, and manpage.
Simon Kelley832af0b2007-01-21 20:01:28 +0000[diff] [blame]61There is also a <A HREF="CHANGELOG"> CHANGELOG</A> and a <A HREF="FAQ">FAQ</A>.
Simon Kelley9e4abcb2004-01-22 19:47:41 +0000[diff] [blame]62
Simon Kelley246839d2012-01-06 20:39:54 +0000[diff] [blame]63Dnsmasq has a git repository which contains the complete release
64history of version 2 and development history from 2.60. You can
65<A HREF="http://thekelleys.org.uk/gitweb/?p=dnsmasq.git;a=summary">browse</A>
66the repo, or get a copy using git protocol with the command
67
68<PRE><TT>git clone git://thekelleys.org.uk/dnsmasq.git </TT></PRE>
69
Simon Kelley9e4abcb2004-01-22 19:47:41 +0000[diff] [blame]70<H2>License.</H2>
Simon Kelley7e22cf22014-04-24 12:05:33 +0100[diff] [blame^]71Dnsmasq is distributed under the GPL, version 2 or version 3 at your discretion. See the files COPYING and COPYING-v3 in the distribution
Simon Kelley9e4abcb2004-01-22 19:47:41 +0000[diff] [blame]72for details.
73
74<H2>Contact.</H2>
Simon Kelley26128d22004-11-14 16:43:54 +0000[diff] [blame]75There is a dnsmasq mailing list at <A
76HREF="http://lists.thekelleys.org.uk/mailman/listinfo/dnsmasq-discuss">
77http://lists.thekelleys.org.uk/mailman/listinfo/dnsmasq-discuss</A> which should be the
78first location for queries, bugreports, suggestions etc.
Simon Kelley7e22cf22014-04-24 12:05:33 +0100[diff] [blame^]79You can contact me at <A
Simon Kelley26128d22004-11-14 16:43:54 +0000[diff] [blame]80HREF="mailto:simon@thekelleys.org.uk">simon@thekelleys.org.uk</A>.
Simon Kelley97dce082014-04-11 18:56:23 +0100[diff] [blame]81
82<H2>Donations.</H2>
Simon Kelley7e22cf22014-04-24 12:05:33 +0100[diff] [blame^]83Dnsmasq is mainly written and maintained by Simon Kelley. For most of its life, dnsmasq has been a spare-time project.
84These days I'm working on it as my main activity.
Simon Kelley97dce082014-04-11 18:56:23 +0100[diff] [blame]85I don't have an employer or anyone who pays me regularly to work on dnsmasq. If you'd like to make
86a contribution towards my expenses, please use the donation button below.
87<form action="https://www.paypal.com/cgi-bin/webscr" method="post" target="_top">
88<input type="hidden" name="cmd" value="_s-xclick">
89<input type="hidden" name="hosted_button_id" value="V3X9GVW5GX6DA">
90<input type="image" src="https://www.paypalobjects.com/en_US/GB/i/btn/btn_donateCC_LG.gif" border="0" name="submit" alt="PayPal – The safer, easier way to pay online.">
91<img alt="" border="0" src="https://www.paypalobjects.com/en_GB/i/scr/pixel.gif" width="1" height="1">
92</form>
93
94
Simon Kelley9e4abcb2004-01-22 19:47:41 +0000[diff] [blame]95</BODY>
96