doc.html - thekelleys/dnsmasq - Gitiles

 <HTML>
 <HEAD>
 <TITLE> Dnsmasq - network services for small networks.</TITLE>
 <link rel="icon" href="http://www.thekelleys.org.uk/dnsmasq/images/favicon.ico">
 </HEAD>
 <BODY BGCOLOR="WHITE">
 <table width="100%" border="0" cellpadding="0" cellspacing="0">
 <tr>
 <td align="left" valign="middle"><img border="0" src="http://www.thekelleys.org.uk/dnsmasq/images/icon.png" /></td>
 <td align="middle" valign="middle"><h1>Dnsmasq</h1></td>
 <td align="right" valign="middle"><img border="0" src="http://www.thekelleys.org.uk/dnsmasq/images/icon.png" /></td></tr>
 </table>
 Dnsmasq provides network infrastructure for small networks: DNS, DHCP, router advertisement and network boot. It is designed to be
 lightweight and have a small footprint, suitable for resource constrained routers and firewalls. It has also been widely used
 for tethering on smartphones and portable hotspots, and to support virtual networking in virtualisation frameworks.
 Supported platforms include Linux (with glibc and uclibc), Android, *BSD, and Mac OS X. Dnsmasq is included in most
 Linux distributions and the ports systems of FreeBSD, OpenBSD and NetBSD. Dnsmasq provides full IPv6 support.

 <P>
 The DNS subsystem provides a local DNS server for the network, with forwarding of all query types to upstream recursive DNS servers and
 caching of common record types (A, AAAA, CNAME and PTR, also DNSKEY and DS when DNSSEC is enabled).
 <DIR>
 <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>
 <LI>Upstream servers can be configured in a variety of convenient ways, including  dynamic configuration as these change on moving upstream network.
 <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
 zone transfer to secondaries for the zone, if required.</LI>
 <LI>DNSSEC validation may be performed on DNS replies from upstream nameservers, providing security against spoofing and cache poisoning.</LI>
 <LI>Specified sub-domains can be directed to their own upstream DNS servers, making VPN configuration easy.</LI>
 <LI>Internationalised domain names are supported.
 </DIR>
 <P>
 The DHCP subsystem supports DHCPv4, DHCPv6, BOOTP and PXE.
 <DIR>
 <LI> Both static and dynamic DHCP leases are supported, along with stateless mode in DHCPv6.</LI>
 <LI> The PXE system is a full PXE server, supporting netboot menus and multiple architecture support. It
 includes proxy-mode, where the PXE system co-operates with another DHCP server.</LI>
 <LI> There is a built in read-only TFTP server to support netboot.</LI>
 <LI> Machines which are configured by DHCP have their names automatically
 included in the DNS and the names can specified by each machine or
 centrally by associating a name with a MAC address or UID in the dnsmasq
 configuration file.</LI>
 </DIR>
 <P>
 The Router Advertisement subsystem provides basic autoconfiguration for IPv6 hosts. It can be used stand-alone or in conjunction with DHCPv6.
 <DIR>
 <LI> The M and O bits are configurable, to control hosts' use of DHCPv6.</LI>
 <LI> Router advertisements can include the RDNSS option.</LI>
 <LI> There is a mode which uses name information from DHCPv4 configuration to provide DNS entries
  for autoconfigured IPv6 addresses which would otherwise be anonymous.</LI>
 </DIR>
 <P>

 For extra compactness, unused features may be omitted at compile time.


 <H2>Get code.</H2>

 <A HREF="http://www.thekelleys.org.uk/dnsmasq/">Download</A> dnsmasq here.
 The tarball includes this documentation, source, and manpage.
 There is also a <A HREF="CHANGELOG"> CHANGELOG</A> and a <A HREF="FAQ">FAQ</A>.

 Dnsmasq has a git repository which contains the complete release
 history of version 2 and development history from 2.60. You can
 <A HREF="http://thekelleys.org.uk/gitweb/?p=dnsmasq.git;a=summary">browse</A>
 the repo, or get a copy using git protocol with the command

 <PRE><TT>git clone git://thekelleys.org.uk/dnsmasq.git </TT></PRE>

 or

 <PRE><TT>git clone http://thekelleys.org.uk/git/dnsmasq.git </TT></PRE>

 <H2>License.</H2>
 Dnsmasq is distributed under the GPL, version 2 or version 3 at your discretion. See the files COPYING and COPYING-v3 in the distribution
 for details.

 <H2>Contact.</H2>
 There is a dnsmasq mailing list at <A
 HREF="http://lists.thekelleys.org.uk/mailman/listinfo/dnsmasq-discuss">
 http://lists.thekelleys.org.uk/mailman/listinfo/dnsmasq-discuss</A> which should be the
 first location for queries, bugreports, suggestions etc. The list is mirrored, with a
 search facility, at <A HREF="https://www.mail-archive.com/dnsmasq-discuss@lists.thekelleys.org.uk/">
 https://www.mail-archive.com/dnsmasq-discuss@lists.thekelleys.org.uk/</A>.
 You can contact me at <A
 HREF="mailto:simon@thekelleys.org.uk">simon@thekelleys.org.uk</A>.

 <H2>Donations.</H2>
 Dnsmasq is mainly written and maintained by Simon Kelley. For most of its life, dnsmasq has been a spare-time project.
 These days I'm working on it as my main activity.
 I don't have an employer or anyone who pays me regularly to work on dnsmasq. If you'd like to make
 a contribution towards my expenses, please use the donation button below.
 <form action="https://www.paypal.com/cgi-bin/webscr" method="post" target="_top">
 <input type="hidden" name="cmd" value="_s-xclick">
 <input type="hidden" name="hosted_button_id" value="V3X9GVW5GX6DA">
 <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.">
 <img alt="" border="0" src="https://www.paypalobjects.com/en_GB/i/scr/pixel.gif" width="1" height="1">
 </form>


 </BODY>
	<HTML>
	<HEAD>
	<TITLE> Dnsmasq - network services for small networks.</TITLE>
	<link rel="icon" href="http://www.thekelleys.org.uk/dnsmasq/images/favicon.ico">
	</HEAD>
	<BODY BGCOLOR="WHITE">
	<table width="100%" border="0" cellpadding="0" cellspacing="0">
	<tr>
	<td align="left" valign="middle"><img border="0" src="http://www.thekelleys.org.uk/dnsmasq/images/icon.png" /></td>
	<td align="middle" valign="middle"><h1>Dnsmasq</h1></td>
	<td align="right" valign="middle"><img border="0" src="http://www.thekelleys.org.uk/dnsmasq/images/icon.png" /></td></tr>
	</table>
	Dnsmasq provides network infrastructure for small networks: DNS, DHCP, router advertisement and network boot. It is designed to be
	lightweight and have a small footprint, suitable for resource constrained routers and firewalls. It has also been widely used
	for tethering on smartphones and portable hotspots, and to support virtual networking in virtualisation frameworks.
	Supported platforms include Linux (with glibc and uclibc), Android, *BSD, and Mac OS X. Dnsmasq is included in most
	Linux distributions and the ports systems of FreeBSD, OpenBSD and NetBSD. Dnsmasq provides full IPv6 support.

	<P>
	The DNS subsystem provides a local DNS server for the network, with forwarding of all query types to upstream recursive DNS servers and
	caching of common record types (A, AAAA, CNAME and PTR, also DNSKEY and DS when DNSSEC is enabled).
	<DIR>
	<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>
	<LI>Upstream servers can be configured in a variety of convenient ways, including dynamic configuration as these change on moving upstream network.
	<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
	zone transfer to secondaries for the zone, if required.</LI>
	<LI>DNSSEC validation may be performed on DNS replies from upstream nameservers, providing security against spoofing and cache poisoning.</LI>
	<LI>Specified sub-domains can be directed to their own upstream DNS servers, making VPN configuration easy.</LI>
	<LI>Internationalised domain names are supported.
	</DIR>
	<P>
	The DHCP subsystem supports DHCPv4, DHCPv6, BOOTP and PXE.
	<DIR>
	<LI> Both static and dynamic DHCP leases are supported, along with stateless mode in DHCPv6.</LI>
	<LI> The PXE system is a full PXE server, supporting netboot menus and multiple architecture support. It
	includes proxy-mode, where the PXE system co-operates with another DHCP server.</LI>
	<LI> There is a built in read-only TFTP server to support netboot.</LI>
	<LI> Machines which are configured by DHCP have their names automatically
	included in the DNS and the names can specified by each machine or
	centrally by associating a name with a MAC address or UID in the dnsmasq
	configuration file.</LI>
	</DIR>
	<P>
	The Router Advertisement subsystem provides basic autoconfiguration for IPv6 hosts. It can be used stand-alone or in conjunction with DHCPv6.
	<DIR>
	<LI> The M and O bits are configurable, to control hosts' use of DHCPv6.</LI>
	<LI> Router advertisements can include the RDNSS option.</LI>
	<LI> There is a mode which uses name information from DHCPv4 configuration to provide DNS entries
	for autoconfigured IPv6 addresses which would otherwise be anonymous.</LI>
	</DIR>
	<P>

	For extra compactness, unused features may be omitted at compile time.


	<H2>Get code.</H2>

	<A HREF="http://www.thekelleys.org.uk/dnsmasq/">Download</A> dnsmasq here.
	The tarball includes this documentation, source, and manpage.
	There is also a <A HREF="CHANGELOG"> CHANGELOG</A> and a <A HREF="FAQ">FAQ</A>.

	Dnsmasq has a git repository which contains the complete release
	history of version 2 and development history from 2.60. You can
	<A HREF="http://thekelleys.org.uk/gitweb/?p=dnsmasq.git;a=summary">browse</A>
	the repo, or get a copy using git protocol with the command

	<PRE><TT>git clone git://thekelleys.org.uk/dnsmasq.git </TT></PRE>

	or

	<PRE><TT>git clone http://thekelleys.org.uk/git/dnsmasq.git </TT></PRE>

	<H2>License.</H2>
	Dnsmasq is distributed under the GPL, version 2 or version 3 at your discretion. See the files COPYING and COPYING-v3 in the distribution
	for details.

	<H2>Contact.</H2>
	There is a dnsmasq mailing list at <A
	HREF="http://lists.thekelleys.org.uk/mailman/listinfo/dnsmasq-discuss">
	http://lists.thekelleys.org.uk/mailman/listinfo/dnsmasq-discuss</A> which should be the
	first location for queries, bugreports, suggestions etc. The list is mirrored, with a
	search facility, at <A HREF="https://www.mail-archive.com/dnsmasq-discuss@lists.thekelleys.org.uk/">
	https://www.mail-archive.com/dnsmasq-discuss@lists.thekelleys.org.uk/</A>.
	You can contact me at <A
	HREF="mailto:simon@thekelleys.org.uk">simon@thekelleys.org.uk</A>.

	<H2>Donations.</H2>
	Dnsmasq is mainly written and maintained by Simon Kelley. For most of its life, dnsmasq has been a spare-time project.
	These days I'm working on it as my main activity.
	I don't have an employer or anyone who pays me regularly to work on dnsmasq. If you'd like to make
	a contribution towards my expenses, please use the donation button below.
	<form action="https://www.paypal.com/cgi-bin/webscr" method="post" target="_top">
	<input type="hidden" name="cmd" value="_s-xclick">
	<input type="hidden" name="hosted_button_id" value="V3X9GVW5GX6DA">
	<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.">
	<img alt="" border="0" src="https://www.paypalobjects.com/en_GB/i/scr/pixel.gif" width="1" height="1">
	</form>


	</BODY>