[people/ms/dnsmasq.git] / doc.html

<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
cacheing 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>

<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>
Commit	Line	Data
9e4abcb5 SK	1	<HTML>
9e4abcb5 SK	2	<HEAD>
7e22cf28	3	<TITLE> Dnsmasq - network services for small networks.</TITLE>
933878f2	4	<link rel="icon" href="http://www.thekelleys.org.uk/dnsmasq/images/favicon.ico">
9e4abcb5 SK	5	</HEAD>
9e4abcb5 SK	6	<BODY BGCOLOR="WHITE">
28866e95 SK	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>
7e22cf28 SK	13	Dnsmasq provides network infrastructure for small networks: DNS, DHCP, router advertisement and network boot. It is designed to be
	14	lightweight and have a small footprint, suitable for resource constrained routers and firewalls. It has also been widely used
	15	for tethering on smartphones and portable hotspots, and to support virtual networking in virtualisation frameworks.
	16	Supported platforms include Linux (with glibc and uclibc), Android, *BSD, and Mac OS X. Dnsmasq is included in most
	17	Linux distributions and the ports systems of FreeBSD, OpenBSD and NetBSD. Dnsmasq provides full IPv6 support.
28866e95	18
9e4abcb5	19	<P>
7e22cf28 SK	20	The DNS subsystem provides a local DNS server for the network, with forwarding of all query types to upstream recursive DNS servers and
	21	cacheing of common record types (A, AAAA, CNAME and PTR, also DNSKEY and DS when DNSSEC is enabled).
	22	<DIR>
	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
	26	zone 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.
	30	</DIR>
9e4abcb5	31	<P>
7e22cf28	32	The DHCP subsystem supports DHCPv4, DHCPv6, BOOTP and PXE.
9e4abcb5	33	<DIR>
7e22cf28 SK	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
	36	includes 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
26128d27	39	included in the DNS and the names can specified by each machine or
7e22cf28 SK	40	centrally by associating a name with a MAC address or UID in the dnsmasq
7e22cf28 SK	41	configuration file.</LI>
9e4abcb5	42	</DIR>
7e22cf28 SK	43	<P>
	44	The 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
	53	For extra compactness, unused features may be omitted at compile time.
	54
9e4abcb5	55
246839d6	56	<H2>Get code.</H2>
9e4abcb5	57
246839d6	58	<A HREF="http://www.thekelleys.org.uk/dnsmasq/">Download</A> dnsmasq here.
4011c4e0	59	The tarball includes this documentation, source, and manpage.
832af0ba	60	There is also a <A HREF="CHANGELOG"> CHANGELOG</A> and a <A HREF="FAQ">FAQ</A>.
9e4abcb5	61
246839d6 SK	62	Dnsmasq has a git repository which contains the complete release
	63	history 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>
	65	the 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
9e4abcb5	69	<H2>License.</H2>
7e22cf28	70	Dnsmasq is distributed under the GPL, version 2 or version 3 at your discretion. See the files COPYING and COPYING-v3 in the distribution
9e4abcb5 SK	71	for details.
	72
	73	<H2>Contact.</H2>
26128d27 SK	74	There is a dnsmasq mailing list at <A
	75	HREF="http://lists.thekelleys.org.uk/mailman/listinfo/dnsmasq-discuss">
	76	http://lists.thekelleys.org.uk/mailman/listinfo/dnsmasq-discuss</A> which should be the
585840b0 SK	77	first location for queries, bugreports, suggestions etc. The list is mirrored, with a
	78	search facility, at <A HREF="https://www.mail-archive.com/dnsmasq-discuss@lists.thekelleys.org.uk/">
	79	https://www.mail-archive.com/dnsmasq-discuss@lists.thekelleys.org.uk/</A>.
7e22cf28	80	You can contact me at <A
26128d27	81	HREF="mailto:simon@thekelleys.org.uk">simon@thekelleys.org.uk</A>.
97dce08e SK	82
97dce08e SK	83	<H2>Donations.</H2>
7e22cf28 SK	84	Dnsmasq is mainly written and maintained by Simon Kelley. For most of its life, dnsmasq has been a spare-time project.
7e22cf28 SK	85	These days I'm working on it as my main activity.
97dce08e SK	86	I don't have an employer or anyone who pays me regularly to work on dnsmasq. If you'd like to make
	87	a contribution towards my expenses, please use the donation button below.
	88	<form action="https://www.paypal.com/cgi-bin/webscr" method="post" target="_top">
	89	<input type="hidden" name="cmd" value="_s-xclick">
	90	<input type="hidden" name="hosted_button_id" value="V3X9GVW5GX6DA">
	91	<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.">
	92	<img alt="" border="0" src="https://www.paypalobjects.com/en_GB/i/scr/pixel.gif" width="1" height="1">
	93	</form>
	94
	95
9e4abcb5 SK	96	</BODY>
9e4abcb5 SK	97