Difference between revisions of "Dnsmasq"

From ArchWiki
Jump to: navigation, search
m (DNS Addresses File: request merging with resolv.conf)
m (Caching DNS server: style)
 
(133 intermediate revisions by 35 users not shown)
Line 1: Line 1:
 +
{{Lowercase title}}
 
[[Category:Domain Name System]]
 
[[Category:Domain Name System]]
 +
[[Category:DHCP]]
 +
[[es:Dnsmasq]]
 
[[it:Dnsmasq]]
 
[[it:Dnsmasq]]
 +
[[ja:Dnsmasq]]
 +
[[pt:Dnsmasq]]
 
[[ru:Dnsmasq]]
 
[[ru:Dnsmasq]]
[[zh-CN:Dnsmasq]]
+
[[zh-hans:Dnsmasq]]
{{Lowercase_title}}
+
{{Related articles start}}
 +
{{Related|BIND}}
 +
{{Related|DNSCrypt}}
 +
{{Related|DNSSEC}}
 +
{{Related|Pdnsd}}
 +
{{Related|unbound}}
 +
{{Related articles end}}
 +
[http://www.thekelleys.org.uk/dnsmasq/doc.html dnsmasq] provides a local [[Wikipedia:Name server|DNS server]], a [[Wikipedia:Dynamic Host Configuration Protocol|DHCP server]] with support for [[Wikipedia:DHCPv6|DHCPv6]] and [[Wikipedia:Preboot Execution Environment|PXE]], and a [[Wikipedia:Trivial File Transfer Protocol|TFTP server]]. It is designed to be lightweight and have a small footprint, suitable for resource constrained routers and firewalls. dnsmasq can also be configured to cache DNS queries for improved DNS lookup speeds to previously visited sites.
  
'''dnsmasq''' provides services as a DNS cacher and a DHCP server.  As a Domain Name Server (DNS), it can cache DNS queries to improve connection speed to previously visited sites.  As a DHCP server, {{Pkg|dnsmasq}} can be used to provide internal IP addresses and routes to computers on a LAN.  Either or both of these services can be implemented.  dnsmasq is considered to be lightweight and easy to configure; it is designed for personal computer use or for use on a network with less than 50 computers. It also comes with a [[PXE]] server.
+
== Installation ==
  
== Installing ==
+
[[Install]] the {{Pkg|dnsmasq}} package.
  
[[pacman|Install]] {{Pkg|dnsmasq}} from the [[Official Repositories|official repositories]].
+
== Start the daemon ==
 +
 
 +
[[Start/enable]] {{ic|dnsmasq.service}}.
 +
 
 +
To see if dnsmasq started properly, check the system's journal:
 +
 
 +
$ journalctl -u dnsmasq.service
 +
 
 +
The network will also need to be restarted so the DHCP client can create a new {{ic|/etc/resolv.conf}}.
 +
 
 +
== Configuration ==
 +
 
 +
To configure dnsmasq, you need to edit {{ic|/etc/dnsmasq.conf}}. The file contains extensive comments explaining its options. For all available options see {{man|8|dnsmasq}}.
 +
 
 +
{{Warning|dnsmasq by default enables its DNS server. If you do not require it, you need to explicitly disable it by setting DNS port to {{ic|0}}:
 +
 
 +
{{hc|/etc/dnsmasq.conf|2=
 +
port=0
 +
}}
 +
 
 +
}}
 +
 
 +
{{Tip|To check configuration file(s) syntax, execute:
 +
 
 +
$ dnsmasq --test
 +
 
 +
}}
 +
 
 +
=== Caching DNS server ===
 +
 
 +
To set up dnsmasq as a DNS caching daemon on a single computer edit {{ic|/etc/dnsmasq.conf}} and uncomment the {{ic|listen-address}} directive, adding in the localhost IP address:
 +
 
 +
listen-address=::1,127.0.0.1
 +
 
 +
To use this computer to listen on its LAN IP address for other computers on the network. It is recommended that you use a static LAN IP in this case. E.g.:
 +
 
 +
listen-address=192.168.1.1
 +
 
 +
Set the number of cached domain names with {{ic|1=cache-size=''size''}} (the default is {{ic|150}}) and optionally disable caching of "no such domain" responses with {{ic|no-negcache}}:
  
== DNS Cache Setup ==
+
cache-size=1000
 +
no-negcache
  
To set up dnsmasq as a DNS caching daemon on a single computer edit {{ic|/etc/dnsmasq.conf}} and uncomment the localhost listening address:
+
To validate [[DNSSEC]] load the DNSSEC trust anchors provided by the {{Pkg|dnsmasq}} package  and set the option {{ic|dnssec}}:
  
  listen-address=127.0.0.1
+
  conf-file=/usr/share/dnsmasq/trust-anchors.conf
 +
dnssec
  
To use this computer to act as a default DNS specify the fixed IP address of the network:
+
See {{man|8|dnsmasq}} for more options you might want to use.
  
listen-address=<192.168.1.1>  # Example IP
+
==== DNS addresses file ====
  
=== DNS Addresses File ===
+
After configuring dnsmasq, the DHCP client will need to prepend the localhost address to the known DNS addresses in {{ic|/etc/resolv.conf}}.  This causes all queries to be sent to dnsmasq before trying to resolve them with an external DNS. After the DHCP client is configured, the network will need to be restarted for changes to take effect.
  
{{Merge|resolv.conf|Same topic. Also note that most of this can be done also natively in {{ic|/etc/resolvconf.conf}} using the {{ic|name_servers}} and {{ic|name_servers_append}} options.}}
+
===== openresolv =====
  
After configuring dnsmasq the DHCP client will need to prepend the localhost address to the known DNS addresses in {{ic|/etc/resolv.conf}}.  This causes all queries to be sent to dnsmasq before trying to resolve them with an external DNS. After the DHCP client is configured the network will need to be restarted for changes to take effect.
+
If your network manager supports [[openresolv]], instead of directly altering {{ic|/etc/resolv.conf}}, you can use ''openresolv'' to generate configuration files for dnsmasq. [https://roy.marples.name/projects/openresolv/config]
  
==== resolv.conf ====
+
Edit {{ic|/etc/resolvconf.conf}} and add the loopback addresses as name servers, and configure openresolv to write out dnsmasq configuration:
  
One option is a pure {{ic|resolv.conf}} configuration. To do this, just make the first nameserver in {{ic|/etc/resolv.conf}} point point to localhost:
+
{{hc|/etc/resolvconf.conf|2=
 +
# Use the local name server
 +
name_servers="::1 127.0.0.1"
 +
 
 +
# Write out dnsmasq extended configuration and resolv files
 +
dnsmasq_conf=/etc/dnsmasq-openresolv.conf
 +
dnsmasq_resolv=/etc/dnsmasq-resolv.conf
 +
}}
 +
 
 +
Run {{ic|resolvconf -u}} so that the configuration files get created. If the files do not exist {{ic|dnsmasq.service}} will fail to start.
 +
 
 +
Edit dnsmasq's configuration file to use openresolv's generated configuration:
 +
 
 +
# Read configuration generated by openresolv
 +
conf-file=/etc/dnsmasq-openresolv.conf
 +
resolv-file=/etc/dnsmasq-resolv.conf
 +
 
 +
{{Merge|resolv.conf|Same topic. Also note that most of this can also be done natively in {{ic|/etc/resolvconf.conf}} using the {{ic|name_servers}} and {{ic|name_servers_append}} options.}}
 +
 
 +
===== resolv.conf =====
 +
 
 +
One option is a pure {{ic|resolv.conf}} configuration. To do this, just make the first nameserver in {{ic|/etc/resolv.conf}} point to localhost:
  
 
{{hc|/etc/resolv.conf|
 
{{hc|/etc/resolv.conf|
Line 41: Line 114:
 
{{hc|/etc/dhcpcd.conf|
 
{{hc|/etc/dhcpcd.conf|
 
...
 
...
nohook resolv.conf}}
+
nohook resolv.conf
 +
}}
 +
 
 +
It is also possible to write protect your resolv.conf:
 +
 
 +
# chattr +i /etc/resolv.conf
  
===== More than three nameservers =====
+
====== More than three nameservers ======
  
A limitation the way Linux handles DNS queries is that there can only be a maximum of three nameservers used in {{ic|resolv.conf}}. As a workaround, you can make localhost the only nameserver in {{ic|resolv.conf}}, and then create a separate {{ic|resolv-file}} for your external nameservers. First, create a new resolv file for dnsmasq:
+
A limitation in the way Linux handles DNS queries is that there can only be a maximum of three nameservers used in {{ic|resolv.conf}}. As a workaround, you can make localhost the only nameserver in {{ic|resolv.conf}}, and then create a separate {{ic|resolv-file}} for your external nameservers. First, create a new resolv file for dnsmasq:
  
 
{{hc|/etc/resolv.dnsmasq.conf|
 
{{hc|/etc/resolv.dnsmasq.conf|
Line 61: Line 139:
 
}}
 
}}
  
==== dhcpcd ====
+
===== dhcpcd =====
  
{{Pkg|dhcpcd}} has the ability to prepend or append nameservers to {{ic|/etc/resolv.conf}} by creating (or editing) the {{ic|/etc/resolv.conf.head}} and {{ic|/etc/resolv.conf.tail}} files respectively:
+
[[dhcpcd]] has the ability to prepend or append nameservers to {{ic|/etc/resolv.conf}} by creating (or editing) the {{ic|/etc/resolv.conf.head}} and {{ic|/etc/resolv.conf.tail}} files respectively:
  
 
  echo "nameserver 127.0.0.1" > /etc/resolv.conf.head
 
  echo "nameserver 127.0.0.1" > /etc/resolv.conf.head
  
==== dhclient ====
+
===== dhclient =====
  
For dhclient, uncomment in {{ic|/etc/dhclient.conf}}:
+
For {{Pkg|dhclient}}, uncomment in {{ic|/etc/dhclient.conf}}:
  
 
  prepend domain-name-servers 127.0.0.1;
 
  prepend domain-name-servers 127.0.0.1;
  
==== NetworkManager ====
+
==== Test ====
  
NetworkManager has the ability to start {{ic|dnsmasq}} from its configuration file.  Add the option {{ic|1=dns=dnsmasq}} to {{ic|NetworkManager.conf}} in the {{ic|[main]}} section then disable {{ic|dnsmasq}} from loading as a daemon:
+
To do a lookup speed test choose a website that has not been visited since dnsmasq has been started (''drill'' is part of the {{Pkg|ldns}} package):
  
{{hc|/etc/NetworkManager/NetworkManager.conf|<nowiki>
+
$ drill archlinux.org | grep "Query time"
[main]
 
plugins=keyfile
 
dns=dnsmasq
 
</nowiki>}}
 
  
For permanent caching add a config directory for {{ic|dnsmasq}} and set the cache number of nameservers (default: 150?):
+
Running the command again will use the cached DNS IP and result in a faster lookup time if dnsmasq is setup correctly:
  
mkdir /etc/NetworkManager/dnsmasq.d
+
{{hc|$ drill archlinux.org {{!}} grep "Query time"|
echo "cache-size=1000" | sudo tee /etc/NetworkManager/dnsmasq.d/cache
+
;; Query time: 18 msec
 +
}}
  
===== Other methods =====
+
{{hc|$ drill archlinux.org {{!}} grep "Query time"|
 +
;; Query time: 2 msec
 +
}}
  
If using the dnsmasq daemon, then it is necessary to add the localhost address to {{ic|resolv.conf}} (which NetworkManager will be overriding).
+
To test if DNSSEC validation is working see [[DNSSEC#Testing]].
  
Since the upgrade of [[NetworkManager]] to 0.7, Arch Linux now calls {{Pkg|dhcpcd}} directly instead of the common default with {{Pkg|dhclient}}.  Because of the arguments set with {{Pkg|dhcpcd}}, it no longer sources the {{ic|/etc/resolv.conf.head}}, and {{ic|/etc/resolv.conf.tail}} settings for insertion of name servers.  Several options are available.
+
=== DHCP server ===
  
The first option would be to add a script to the NetworkManager dispatcher to prepend localhost to {{ic|resolv.conf}}:
+
{{Expansion|Add instructions for IPv6 and router advertisement.}}
 
 
{{hc|/etc/NetworkManager/dispatcher.d/localhost-prepend|<nowiki>
 
#!/bin/bash                                     
 
# Prepend localhost to resolv.conf for dnsmasq
 
 
 
if [[ ! $(grep 127.0.0.1 /etc/resolv.conf) ]]; then
 
  sed -i '1s|^|nameserver 127.0.0.1\n|' /etc/resolv.conf
 
fi</nowiki>}}
 
 
 
and make it executable:
 
 
 
# chmod +x /etc/NetworkManager/dispatcher.d/localhost-prepend
 
 
 
The second option be to go into NetworkManagers' settings (usually by right-clicking the applet) and entering settings manually.  Setting up will depending on the type of front-end used; the process usually involves right-clicking on the applet, editing (or creating) a profile, and then choosing DHCP type as 'Automatic (specify addresses).'  The DNS addresses will need to be entered and are usually in this form: {{ic|127.0.0.1, DNS-server-one, ...}}.
 
 
 
Lastly, NetworkManager with dhclient can be used ({{AUR|networkmanager-dhclient}}).
 
 
 
===== Custom Configuration =====
 
 
 
As of NetworkManager 0.9.6, custom configurations can be created for {{Pkg|dnsmasq}} by creating configuration files in {{ic|/etc/NetworkManager/dnsmasq.d/}}
 
 
 
{{Note|You have to add the following line to your NetworkManager configuration file {{ic|/etc/NetworkManager/NetworkManager.conf}} : {{ic|dns&#61;dnsmasq}} in order to enable custom configuration files.}}
 
 
 
{{Tip|This method can allow you to enable custom DNS settings on particular domains. For instance : {{ic|server&#61;/example1.com/exemple2.com/xx.xxx.xxx.x}} change the first DNS address to {{ic|xx.xxx.xxx.xx}} while browsing only the following websites {{ic|example1.com, example2.com}}. This method is preferred to a global DNS configuration when using particular DNS nameservers which lack of speed, stability, privacy and security.}}
 
 
 
== DHCP Server Setup ==
 
  
 
By default dnsmasq has the DHCP functionality turned off, if you want to use it you must turn it on in ({{ic|/etc/dnsmasq.conf}}).  Here are the important settings:
 
By default dnsmasq has the DHCP functionality turned off, if you want to use it you must turn it on in ({{ic|/etc/dnsmasq.conf}}).  Here are the important settings:
Line 135: Line 186:
 
bind-interfaces
 
bind-interfaces
  
# Dynamic range of IPs to make available to LAN pc
+
# Optionally set a domain name
 +
domain=example.com
 +
 
 +
# Set default gateway
 +
dhcp-option=3,192.168.1.1
 +
 
 +
# Set DNS servers to announce
 +
dhcp-option=6,8.8.8.8,8.8.4.4
 +
 
 +
# Dynamic range of IPs to make available to LAN PC and the lease time.
 +
# Ideally set the lease time to 5m only at first to test everything works okay before you set long-lasting records.
 
dhcp-range=192.168.111.50,192.168.111.100,12h
 
dhcp-range=192.168.111.50,192.168.111.100,12h
  
# If you’d like to have dnsmasq assign static IPs, bind the LAN computer's
+
# If you’d like to have dnsmasq assign static IPs to some clients, bind the LAN computers
# NIC MAC address:
+
# NIC MAC addresses:
 
dhcp-host=aa:bb:cc:dd:ee:ff,192.168.111.50
 
dhcp-host=aa:bb:cc:dd:ee:ff,192.168.111.50
 +
dhcp-host=aa:bb:cc:ff:dd:ee,192.168.111.51
 
</nowiki>}}
 
</nowiki>}}
  
== Start the daemon ==
+
See {{man|8|dnsmasq}} for more options.
To have dnsmasq to load upon startup:
+
 
 +
==== Test ====
 +
 
 +
From a computer that is connected to the one with dnsmasq on it, configure it to use DHCP for automatic IP address assignment, then attempt to log into the network normally.
 +
 
 +
If you inspect the {{ic|/var/lib/misc/dnsmasq.leases}} file on the server, you should be able to see the lease.
 +
 
 +
=== TFTP server ===
 +
 
 +
dnsmasq has built-in [[TFTP]] server.
 +
 
 +
To use it, create a directory for TFTP root (e.g. {{ic|/srv/tftp}}) to put transferable files in.
 +
 
 +
For increased security it is advised to use dnsmasq's TFTP secure mode. In secure mode only files owned by the {{ic|dnsmasq}} user will be served over TFTP. You will need to [[chown]] TFTP root and all files in it to {{ic|dnsmasq}} user to use this feature.
 +
 
 +
Enable TFTP in {{ic|dnsmasq.conf}}:
 +
 
 +
{{hc|/etc/dnsmasq.conf|2=
 +
enable-tftp
 +
tftp-root=/srv/tftp
 +
tftp-secure
 +
}}
 +
 
 +
See {{man|8|dnsmasq}} for more options.
 +
 
 +
=== PXE server ===
 +
 
 +
PXE requires DHCP and TFTP servers, both functions can be provided by dnsmasq.
 +
 
 +
{{Tip|dnsmasq can add PXE booting options to a network with an already running DHCP server:
 +
 
 +
{{hc|/etc/dnsmasq.conf|2=
 +
interface=''enp0s0''
 +
bind-dynamic
 +
dhcp-range=''192.168.0.1'',proxy
 +
}}
 +
 
 +
}}
  
{{bc|# systemctl enable dnsmasq}}
+
# set up [[#TFTP server]] and [[#DHCP server]]
 +
# copy and configure a PXE compatible bootloader (e.g. [[PXELINUX]]) on TFTP root
 +
# enable PXE in {{ic|/etc/dnsmasq.conf}}:
  
To start dnsmasq immediately:
+
{{Note|
 +
*file paths are relative to TFTP root
 +
*if the file has a {{ic|.0}} suffix, you must exclude the suffix in {{ic|pxe-service}} options
 +
}}
  
{{bc|# systemctl start dnsmasq}}
+
To simply send one file:
  
To see if dnsmasq started properly, check the log; dnsmasq sends its messages to {{ic|/var/log/messages.log}}. The network will also need to be restarted so the the DHCP client can create a new {{ic|/etc/resolv.conf}}.
+
dhcp-boot=lpxelinux.0
  
== Test ==
+
To send a file depending on client architecture:
=== DNS Caching ===
 
  
To do a lookup speed test choose a website that has not been visited since dnsmasq has been started ({{ic|dig}} is part of the {{Pkg|dnsutils}} package):
+
pxe-service=x86PC, "PXELINUX (BIOS)", "bios/lpxelinux"
 +
pxe-service=X86-64_EFI, "PXELINUX (EFI)", "efi64/syslinux.efi"
  
$ dig archlinux.org | grep "Query time"
+
{{Note|In case {{ic|pxe-service}} does not work (especially for UEFI-based clients), combination of {{ic|dhcp-match}} and {{ic|dhcp-boot}} can be used. See [https://tools.ietf.org/html/rfc4578#section-2.1 RFC4578] for more {{ic|client-arch}} numbers for use with dhcp boot protocol.}}
  
Running the command again will use the cached DNS IP and result in a faster lookup time if dnsmasq is setup correctly.
+
dhcp-match=set:efi-x86_64,option:client-arch,7
 +
dhcp-match=set:efi-x86_64,option:client-arch,9
 +
dhcp-match=set:efi-x86,option:client-arch,6
 +
dhcp-match=set:bios,option:client-arch,0
 +
dhcp-boot=tag:efi-x86_64,"efi64/syslinux.efi"
 +
dhcp-boot=tag:efi-x86,"efi32/syslinux.efi"
 +
dhcp-boot=tag:bios,"bios/lpxelinux.0"
  
=== DHCP Server ===
+
See {{man|8|dnsmasq}} for more options.
  
From a computer that is connected to the one with dnsmasq on it, configure it to use DHCP for automatic IP address assignment, then attempt to log into the network normally.
+
The rest is up to the [[bootloader]].
  
 
== Tips and tricks ==
 
== Tips and tricks ==
  
=== Prevent OpenDNS Redirecting Google Queries ===
+
=== Prevent OpenDNS redirecting Google queries ===
  
 
To prevent OpenDNS from redirecting all Google queries to their own search server, add to {{ic|/etc/dnsmasq.conf}}:
 
To prevent OpenDNS from redirecting all Google queries to their own search server, add to {{ic|/etc/dnsmasq.conf}}:
 
{{bc|1=server=/www.google.com/<ISP DNS IP>}}
 
{{bc|1=server=/www.google.com/<ISP DNS IP>}}
  
=== View leases ===
+
=== Override addresses ===
{{bc|$ cat /var/lib/misc/dnsmasq.leases}}
+
 
 +
In some cases, such as when operating a captive portal, it can be useful to resolve specific domains names to a hard-coded set of addresses. This is done with the {{ic|address}} config:
 +
 
 +
address=/example.com/1.2.3.4
 +
 
 +
Furthermore, it's possible to return a specific address for all domain names that are not answered from {{ic|/etc/hosts}} or DHCP by using a special wildcard:
 +
 
 +
address=/#/1.2.3.4
 +
 
 +
=== More than one instance ===
 +
 
 +
If we want two or more dnsmasq servers works per interface(s).
 +
 
 +
==== Static ====
 +
 
 +
To do this staticly, server per interface, use {{ic|interface}} and {{ic|bind-interface}} options. This enforce start second dnsmasq.
 +
 
 +
==== Dynamic ====
 +
 
 +
In this case we can exclude per interface and bind any others:
 +
 
 +
except-interface=lo
 +
bind-dynamic
 +
 
 +
{{Note|This is default in libvirt.}}
 +
 
 +
=== Adding a custom domain ===
 +
 
 +
It is possible to add a custom domain to hosts in your (local) network:
 +
 
 +
local=/home.lan/
 +
domain=home.lan
 +
 
 +
In this example it is possible to ping a host/device (e.g. defined in your {{ic|/etc/hosts}} file) as {{ic|''hostname''.home.lan}}.
 +
 
 +
Uncomment {{ic|expand-hosts}} to add the custom domain to hosts entries:
 +
 
 +
expand-hosts
 +
 
 +
Without this setting, you will have to add the domain to entries of {{ic|/etc/hosts}}.
 +
 
 +
== See also ==
 +
 
 +
* [http://www.g-loaded.eu/2010/09/18/caching-nameserver-using-dnsmasq/ Caching Nameserver using dnsmasq, and a few other tips and tricks.]

Latest revision as of 07:48, 21 June 2018

dnsmasq provides a local DNS server, a DHCP server with support for DHCPv6 and PXE, and a TFTP server. It is designed to be lightweight and have a small footprint, suitable for resource constrained routers and firewalls. dnsmasq can also be configured to cache DNS queries for improved DNS lookup speeds to previously visited sites.

Installation

Install the dnsmasq package.

Start the daemon

Start/enable dnsmasq.service.

To see if dnsmasq started properly, check the system's journal:

$ journalctl -u dnsmasq.service

The network will also need to be restarted so the DHCP client can create a new /etc/resolv.conf.

Configuration

To configure dnsmasq, you need to edit /etc/dnsmasq.conf. The file contains extensive comments explaining its options. For all available options see dnsmasq(8).

Warning: dnsmasq by default enables its DNS server. If you do not require it, you need to explicitly disable it by setting DNS port to 0:
/etc/dnsmasq.conf
port=0
Tip: To check configuration file(s) syntax, execute:
$ dnsmasq --test

Caching DNS server

To set up dnsmasq as a DNS caching daemon on a single computer edit /etc/dnsmasq.conf and uncomment the listen-address directive, adding in the localhost IP address:

listen-address=::1,127.0.0.1

To use this computer to listen on its LAN IP address for other computers on the network. It is recommended that you use a static LAN IP in this case. E.g.:

listen-address=192.168.1.1

Set the number of cached domain names with cache-size=size (the default is 150) and optionally disable caching of "no such domain" responses with no-negcache:

cache-size=1000
no-negcache

To validate DNSSEC load the DNSSEC trust anchors provided by the dnsmasq package and set the option dnssec:

conf-file=/usr/share/dnsmasq/trust-anchors.conf
dnssec

See dnsmasq(8) for more options you might want to use.

DNS addresses file

After configuring dnsmasq, the DHCP client will need to prepend the localhost address to the known DNS addresses in /etc/resolv.conf. This causes all queries to be sent to dnsmasq before trying to resolve them with an external DNS. After the DHCP client is configured, the network will need to be restarted for changes to take effect.

openresolv

If your network manager supports openresolv, instead of directly altering /etc/resolv.conf, you can use openresolv to generate configuration files for dnsmasq. [1]

Edit /etc/resolvconf.conf and add the loopback addresses as name servers, and configure openresolv to write out dnsmasq configuration:

/etc/resolvconf.conf
# Use the local name server
name_servers="::1 127.0.0.1"

# Write out dnsmasq extended configuration and resolv files
dnsmasq_conf=/etc/dnsmasq-openresolv.conf
dnsmasq_resolv=/etc/dnsmasq-resolv.conf

Run resolvconf -u so that the configuration files get created. If the files do not exist dnsmasq.service will fail to start.

Edit dnsmasq's configuration file to use openresolv's generated configuration:

# Read configuration generated by openresolv
conf-file=/etc/dnsmasq-openresolv.conf
resolv-file=/etc/dnsmasq-resolv.conf

Merge-arrows-2.pngThis article or section is a candidate for merging with resolv.conf.Merge-arrows-2.png

Notes: Same topic. Also note that most of this can also be done natively in /etc/resolvconf.conf using the name_servers and name_servers_append options. (Discuss in Talk:Dnsmasq#)
resolv.conf

One option is a pure resolv.conf configuration. To do this, just make the first nameserver in /etc/resolv.conf point to localhost:

/etc/resolv.conf
nameserver 127.0.0.1
# External nameservers
...

Now DNS queries will be resolved first with dnsmasq, only checking external servers if dnsmasq cannot resolve the query. dhcpcd, unfortunately, tends to overwrite /etc/resolv.conf by default, so if you use DHCP it is a good idea to protect /etc/resolv.conf. To do this, append nohook resolv.conf to the dhcpcd config file:

/etc/dhcpcd.conf
...
nohook resolv.conf

It is also possible to write protect your resolv.conf:

# chattr +i /etc/resolv.conf
More than three nameservers

A limitation in the way Linux handles DNS queries is that there can only be a maximum of three nameservers used in resolv.conf. As a workaround, you can make localhost the only nameserver in resolv.conf, and then create a separate resolv-file for your external nameservers. First, create a new resolv file for dnsmasq:

/etc/resolv.dnsmasq.conf
# Google's nameservers, for example
nameserver 8.8.8.8
nameserver 8.8.4.4

And then edit /etc/dnsmasq.conf to use your new resolv file:

/etc/dnsmasq.conf
...
resolv-file=/etc/resolv.dnsmasq.conf
...
dhcpcd

dhcpcd has the ability to prepend or append nameservers to /etc/resolv.conf by creating (or editing) the /etc/resolv.conf.head and /etc/resolv.conf.tail files respectively:

echo "nameserver 127.0.0.1" > /etc/resolv.conf.head
dhclient

For dhclient, uncomment in /etc/dhclient.conf:

prepend domain-name-servers 127.0.0.1;

Test

To do a lookup speed test choose a website that has not been visited since dnsmasq has been started (drill is part of the ldns package):

$ drill archlinux.org | grep "Query time"

Running the command again will use the cached DNS IP and result in a faster lookup time if dnsmasq is setup correctly:

$ drill archlinux.org | grep "Query time"
;; Query time: 18 msec
$ drill archlinux.org | grep "Query time"
;; Query time: 2 msec

To test if DNSSEC validation is working see DNSSEC#Testing.

DHCP server

Tango-view-fullscreen.pngThis article or section needs expansion.Tango-view-fullscreen.png

Reason: Add instructions for IPv6 and router advertisement. (Discuss in Talk:Dnsmasq#)

By default dnsmasq has the DHCP functionality turned off, if you want to use it you must turn it on in (/etc/dnsmasq.conf). Here are the important settings:

# Only listen to routers' LAN NIC.  Doing so opens up tcp/udp port 53 to
# localhost and udp port 67 to world:
interface=<LAN-NIC>

# dnsmasq will open tcp/udp port 53 and udp port 67 to world to help with
# dynamic interfaces (assigning dynamic ips). Dnsmasq will discard world
# requests to them, but the paranoid might like to close them and let the 
# kernel handle them:
bind-interfaces

# Optionally set a domain name
domain=example.com

# Set default gateway
dhcp-option=3,192.168.1.1

# Set DNS servers to announce
dhcp-option=6,8.8.8.8,8.8.4.4

# Dynamic range of IPs to make available to LAN PC and the lease time. 
# Ideally set the lease time to 5m only at first to test everything works okay before you set long-lasting records.
dhcp-range=192.168.111.50,192.168.111.100,12h

# If you’d like to have dnsmasq assign static IPs to some clients, bind the LAN computers
# NIC MAC addresses:
dhcp-host=aa:bb:cc:dd:ee:ff,192.168.111.50
dhcp-host=aa:bb:cc:ff:dd:ee,192.168.111.51

See dnsmasq(8) for more options.

Test

From a computer that is connected to the one with dnsmasq on it, configure it to use DHCP for automatic IP address assignment, then attempt to log into the network normally.

If you inspect the /var/lib/misc/dnsmasq.leases file on the server, you should be able to see the lease.

TFTP server

dnsmasq has built-in TFTP server.

To use it, create a directory for TFTP root (e.g. /srv/tftp) to put transferable files in.

For increased security it is advised to use dnsmasq's TFTP secure mode. In secure mode only files owned by the dnsmasq user will be served over TFTP. You will need to chown TFTP root and all files in it to dnsmasq user to use this feature.

Enable TFTP in dnsmasq.conf:

/etc/dnsmasq.conf
enable-tftp
tftp-root=/srv/tftp
tftp-secure

See dnsmasq(8) for more options.

PXE server

PXE requires DHCP and TFTP servers, both functions can be provided by dnsmasq.

Tip: dnsmasq can add PXE booting options to a network with an already running DHCP server:
/etc/dnsmasq.conf
interface=enp0s0
bind-dynamic
dhcp-range=192.168.0.1,proxy
  1. set up #TFTP server and #DHCP server
  2. copy and configure a PXE compatible bootloader (e.g. PXELINUX) on TFTP root
  3. enable PXE in /etc/dnsmasq.conf:
Note:
  • file paths are relative to TFTP root
  • if the file has a .0 suffix, you must exclude the suffix in pxe-service options

To simply send one file:

dhcp-boot=lpxelinux.0

To send a file depending on client architecture:

pxe-service=x86PC, "PXELINUX (BIOS)", "bios/lpxelinux"
pxe-service=X86-64_EFI, "PXELINUX (EFI)", "efi64/syslinux.efi"
Note: In case pxe-service does not work (especially for UEFI-based clients), combination of dhcp-match and dhcp-boot can be used. See RFC4578 for more client-arch numbers for use with dhcp boot protocol.
dhcp-match=set:efi-x86_64,option:client-arch,7
dhcp-match=set:efi-x86_64,option:client-arch,9
dhcp-match=set:efi-x86,option:client-arch,6
dhcp-match=set:bios,option:client-arch,0
dhcp-boot=tag:efi-x86_64,"efi64/syslinux.efi"
dhcp-boot=tag:efi-x86,"efi32/syslinux.efi"
dhcp-boot=tag:bios,"bios/lpxelinux.0"

See dnsmasq(8) for more options.

The rest is up to the bootloader.

Tips and tricks

Prevent OpenDNS redirecting Google queries

To prevent OpenDNS from redirecting all Google queries to their own search server, add to /etc/dnsmasq.conf:

server=/www.google.com/<ISP DNS IP>

Override addresses

In some cases, such as when operating a captive portal, it can be useful to resolve specific domains names to a hard-coded set of addresses. This is done with the address config:

address=/example.com/1.2.3.4

Furthermore, it's possible to return a specific address for all domain names that are not answered from /etc/hosts or DHCP by using a special wildcard:

address=/#/1.2.3.4

More than one instance

If we want two or more dnsmasq servers works per interface(s).

Static

To do this staticly, server per interface, use interface and bind-interface options. This enforce start second dnsmasq.

Dynamic

In this case we can exclude per interface and bind any others:

except-interface=lo
bind-dynamic
Note: This is default in libvirt.

Adding a custom domain

It is possible to add a custom domain to hosts in your (local) network:

local=/home.lan/
domain=home.lan

In this example it is possible to ping a host/device (e.g. defined in your /etc/hosts file) as hostname.home.lan.

Uncomment expand-hosts to add the custom domain to hosts entries:

expand-hosts

Without this setting, you will have to add the domain to entries of /etc/hosts.

See also