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