Difference between revisions of "Dnsmasq"

From ArchWiki
Jump to: navigation, search
m (new templates, see Help:Style)
m (NetworkManager)
(28 intermediate revisions by 16 users not shown)
Line 1: Line 1:
[[Category:Networking (English)]]
+
[[Category:Domain Name System]]
{{i18n|Dnsmasq}}
+
[[it:Dnsmasq]]
 +
[[ru:Dnsmasq]]
 +
[[zh-CN:Dnsmasq]]
 +
{{Lowercase_title}}
  
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 that 50 computers.
+
'''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.
  
 
== Installing ==
 
== Installing ==
Line 8: Line 11:
 
[[pacman|Install]] {{Pkg|dnsmasq}} from the [[Official Repositories|official repositories]].
 
[[pacman|Install]] {{Pkg|dnsmasq}} from the [[Official Repositories|official repositories]].
  
== DHCP Server Setup ==
+
== DNS Cache Setup ==
  
The Dnsmasq configuration file needs to be configured ({{ic|/etc/dnsmasq.conf}}).  The most likely settings you'll need to configure are:
+
To set up dnsmasq as a DNS caching daemon on a single computer edit {{ic|/etc/dnsmasq.conf}} and uncomment the localhost listening address:
  
{{bc|<nowiki>
+
  listen-address=127.0.0.1
# 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
+
To use this computer to act as a default DNS specify the fixed IP address of the network:
# 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
+
  
# Dynamic range of IPs to make available to LAN pc
+
listen-address=<192.168.1.1>  # Example IP
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
+
=== DNS Addresses File ===
# NIC MAC address:
+
dhcp-host=aa:bb:cc:dd:ee:ff,192.168.111.50
+
</nowiki>}}
+
  
If you choose not to bind the interfaces, the domain port will need to be allowed in {{ic|/etc/hosts.allow}}:
+
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.
  
domain ALL : ALLOW
+
==== dhcpcd ====
  
== DNS Cache Setup ==
+
{{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:
  
If you set up Dnsmasq as a DHCP server, it is already setup to record DNS queries and relay them to an internal network. To set up Dnsmasq as a DNS caching daemon on a single computer edit {{ic|/etc/dnsmasq.conf}} and add the localhost listening address:
+
  echo "nameserver 127.0.0.1" > /etc/resolv.conf.head
  
listen-address=127.0.0.1
+
==== dhclient ====
  
After you have configured Dnsmasq, you will need to tell your DHCP client to prepend the localhost address to the known DNS addresses file ({{ic|/etc/resolv.conf}}).  This sends all queries to Dnsmasq first before trying to resolve them to an external DNS server.  After your DHCP client is configured, you will need to restart the network for changes to take effect.
+
For dhclient, uncomment in {{ic|/etc/dhclient.conf}}:
  
=== dhcpcd ===
+
prepend domain-name-servers 127.0.0.1;
  
{{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:
+
==== NetworkManager ====
  
  echo "nameserver 127.0.0.1" > /etc/resolv.conf.head
+
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 remove {{ic|dnsmasq}} from loading as a daemon:
  
=== dhclient ===
+
{{hc|/etc/NetworkManager/NetworkManager.conf|<nowiki>
 +
[main]
 +
plugins=keyfile
 +
dns=dnsmasq
 +
</nowiki>}}
  
If you use dhclient, you will need to add to (or create) to {{ic|/etc/dhclient.conf}}:
+
For permanent caching add a config directory for {{ic|dnsmasq}} and set the cache number of nameservers (default: 150?):
  
  prepend domain-name-servers 127.0.0.1;
+
  mkdir /etc/NetworkManager/dnsmasq.d
 +
echo "cache-size=1000" | sudo tee /etc/NetworkManager/dnsmasq.d/cache
  
=== NetworkManager ===
+
===== Other methods =====
  
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.  There are three workarounds to fix this:
+
If using the dnsmasq daemon, then it is necessary to add the localhost address to {{ic|resolv.conf}} (which NetworkManager will be overriding).
  
The first would be to use NetworkManager with dhclient which can be found in {{AUR|networkmanager-dhclient}}.
+
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.
  
The second workaround would be to go into NetworkManagers' settings (usually by right-clicking the applet) and entering your settings manually.  Depending on the type of front-end you use for NetworkManager, 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 ddresses are usually entered in such form: {{ic|127.0.0.1, DNS-server-one, ...}}.
+
The first option would be to add a script to the NetworkManager dispatcher to prepend localhost to {{ic|resolv.conf}}:
  
The third workaround is to put a script like this in /etc/Networkmanager/dispatcher.d/ and do not forget to make it executable:
+
{{hc|/etc/NetworkManager/dispatcher.d/localhost-prepend|<nowiki>
 +
#!/bin/bash                                     
 +
# Prepend localhost to resolv.conf for dnsmasq
  
#!/bin/bash
+
if [[ ! $(grep 127.0.0.1 /etc/resolv.conf) ]]; then
#
+
  sed -i '1s|^|nameserver 127.0.0.1\n|' /etc/resolv.conf
# Override /etc/resolv.conf and tell
+
fi</nowiki>}}
# NetworkManagerDispatcher to go pluck itself.
+
#
+
# scripts in the /etc/NetworkManager/dispatcher.d/ directory
+
# are called alphabetically and are passed two parameters:
+
# $1 is the interface name, and $2 is "up" or "down" as the
+
# case may be.
+
#
+
# Here, no matter what interface or state, override the
+
# created resolver config with my config.
+
#
+
cp -f /etc/resolv.conf.myDNSoverride /etc/resolv.conf
+
  
Then create a file with the nameservers (in this case opendns ones), according to what you specified on the script (/etc/resolv.conf.myDNSoverride):
+
and make it executable:
  
  nameserver 208.67.222.222
+
  # chmod +x /etc/NetworkManager/dispatcher.d/localhost-prepend
nameserver 208.67.220.220
+
  
Of course you'll have to start the daemon networkmanager-dispatcher.
+
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, ...}}.
  
Alternatively, if you want to keep your current resolv.conf file, use a script similar to
+
Lastly, NetworkManager with dhclient can be used ({{AUR|networkmanager-dhclient}}).
+
#!/bin/bash
+
#
+
# Creates a copy of resolv.conf with "nameserver 127.0.0.1" as first line. 
+
cat - /etc/resolv.conf <<<"nameserver 127.0.0.1"  > /etc/resolv.conf.new
+
cp -f /etc/resolv.conf.new /etc/resolv.conf
+
  
==Start the Daemon==
+
===== Custom Configuration =====
  
Dnsmasq runs as a daemon. But before we start it, let's do a quick check of what our current speed for resolving is by issuing this command (dig is part of the {{Pkg|dnsutils}} package) :
+
As of NetworkManager 0.9.6, custom configurations can be created for dnsmasq by creating configuration files in {{ic|/etc/NetworkManager/dnsmasq.d/}}
  
$ dig archlinux.org | grep Query
+
== DHCP Server Setup ==
  
Now let's start it :
+
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:
  
  # /etc/rc.d/dnsmasq start
+
{{bc|<nowiki>
 +
# 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
 +
 
 +
# Dynamic range of IPs to make available to LAN pc
 +
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
 +
# NIC MAC address:
 +
dhcp-host=aa:bb:cc:dd:ee:ff,192.168.111.50
 +
</nowiki>}}
 +
 
 +
== Start the Daemon ==
 +
To have dnsmasq to load upon startup:
 +
 
 +
{{bc|# systemctl enable dnsmasq}}
  
To have dnsmasq to load upon startup, add dnsmasq to your daemons array in {{ic|/etc/rc.conf}}:
+
To stand dnsmasq immediately:
  
DAEMONS=(network dnsmasq ...)
+
{{bc|# systemctl start dnsmasq}}
  
To see if dnsmasq started properly, check the log; dnsmasq sends its messages to {{ic|/var/log/messages.log}}.
+
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}}.
You will also need to restart the network so that dhcpd can recreate {{ic|/etc/resolv.conf}}.
+
  
# /etc/rc.d/network restart
+
== Test ==
 +
=== DNS Caching ===
  
Now we will test our DNS lookup and measure the time response :
+
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):
  
 
  $ dig archlinux.org | grep "Query time"
 
  $ dig archlinux.org | grep "Query time"
  
The Query time should have decreased.
+
Running the command again will use the cached DNS IP and result in a faster lookup time if dnsmasq is setup correctly.
Also if you remove the grep, you can see the server used (the line under Query time), and now it should be localhost aka 127.0.0.1.
+
  
== Test DHCP Server ==
+
=== DHCP Server ===
  
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 as you normally would.
+
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.
  
== Tips ==
+
== 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>}}
  
server=/www.google.com/X.X.X.X
+
=== View leases ===
 
+
{{bc|$ cat /var/lib/misc/dnsmasq.leases}}
Replace X.X.X.X with your ISP's DNS server/Router IP.
+

Revision as of 03:18, 18 February 2013

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, 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.

Installing

Install dnsmasq from the official repositories.

DNS Cache Setup

To set up dnsmasq as a DNS caching daemon on a single computer edit /etc/dnsmasq.conf and uncomment the localhost listening address:

listen-address=127.0.0.1

To use this computer to act as a default DNS specify the fixed IP address of the network:

listen-address=<192.168.1.1>  # Example IP

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.

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;

NetworkManager

NetworkManager has the ability to start dnsmasq from its configuration file. Add the option dns=dnsmasq to NetworkManager.conf in the [main] section then remove dnsmasq from loading as a daemon:

/etc/NetworkManager/NetworkManager.conf
[main]
plugins=keyfile
dns=dnsmasq

For permanent caching add a config directory for dnsmasq and set the cache number of nameservers (default: 150?):

mkdir /etc/NetworkManager/dnsmasq.d
echo "cache-size=1000" | sudo tee /etc/NetworkManager/dnsmasq.d/cache
Other methods

If using the dnsmasq daemon, then it is necessary to add the localhost address to resolv.conf (which NetworkManager will be overriding).

Since the upgrade of NetworkManager to 0.7, Arch Linux now calls dhcpcd directly instead of the common default with dhclient. Because of the arguments set with dhcpcd, it no longer sources the /etc/resolv.conf.head, and /etc/resolv.conf.tail settings for insertion of name servers. Several options are available.

The first option would be to add a script to the NetworkManager dispatcher to prepend localhost to resolv.conf:

/etc/NetworkManager/dispatcher.d/localhost-prepend
#!/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

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: 127.0.0.1, DNS-server-one, ....

Lastly, NetworkManager with dhclient can be used (networkmanager-dhclientAUR).

Custom Configuration

As of NetworkManager 0.9.6, custom configurations can be created for dnsmasq by creating configuration files in /etc/NetworkManager/dnsmasq.d/

DHCP Server Setup

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

# Dynamic range of IPs to make available to LAN pc
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
# NIC MAC address:
dhcp-host=aa:bb:cc:dd:ee:ff,192.168.111.50

Start the Daemon

To have dnsmasq to load upon startup:

# systemctl enable dnsmasq

To stand dnsmasq immediately:

# systemctl start dnsmasq

To see if dnsmasq started properly, check the log; dnsmasq sends its messages to /var/log/messages.log. The network will also need to be restarted so the the DHCP client can create a new /etc/resolv.conf.

Test

DNS Caching

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

$ dig 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.

DHCP Server

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.

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>

View leases

$ cat /var/lib/misc/dnsmasq.leases