vagrant-dns allows you to configure a dns-server managing a development subdomain. It works much like pow, but manages Vagrant machines.
$ vagrant plugin install vagrant-dns
Attention: As of v2.0.0, vagrant-dns requires vagrant >= 1.9.6 (because it ships with a more modern version of ruby)
If you get an error like
rubydns requires Ruby version >= 2.2.6. while installing, you probably need to upgrade vagrant.
Alternatively, you can install an older version of vagrant-dns like this:
vagrant plugin install --plugin-version="<2" vagrant-dns
In addition to your networking config, configure a toplevel domain and a
hostname for your machine. Optionally, configure a set of free matching patterns. Global configuration options can be given through the
Vagrant.configure("2") do |config| #... config.dns.tld = "dev" config.vm.hostname = "machine" config.dns.patterns = [/^.*mysite.dev$/, /^.*myothersite.dev$/] config.vm.network :private_network, ip: "18.104.22.168" end # optional ::. = Logger.new("dns.log")
Then, register the DNS server as a resolver:
$ vagrant dns --install
On OS X, this will create a file
/etc/resolver/dev, which tells OS X to resolve the TLD
.dev by using the nameserver given in this file. You will have to rerun --install every time a tld is added.
You can delete this file by running:
$ vagrant dns --uninstall
To also delete the created config file for this TLD (
~/.vagrant.d/tmp/dns/resolver/dev in our example) run:
$ vagrant dns --purge
Then, run the DNS server:
$ vagrant dns --start
And test it:
$ scutil --dns ... resolver #8 domain : dev nameserver : 127.0.0.1 port : 5300 ... $ dscacheutil -q host -a name test.machine.dev name: test.machine.dev ip_address: 22.214.171.124
You can now reach the server under the given domain.
Note: Mac OS X is quite different from Linux regarding DNS resolution. As a result, do not use
dscacheutil instead. Read this article
for more information.
Finally, stop the server using:
$ vagrant dns --stop
The DNS server will start automatically once the first VM is started.
You can list the currently configured dns patterns using:
$ vagrant dns --list
(Keep in mind, that it's not guaranteed that the running server uses exactly this configuration - for example, when manually editing it.)
The output looks somewhat like this:
/^.*mysite.dev$/ => 126.96.36.199 /^.*myothersite.dev$/ => 188.8.131.52
Where the first part of each line is a regular expression and the second part is the mapped IPv4. (
=> is just a separator)
vm.dns.tld: Set the tld for the given virtual machine. No default.
vm.dns.tlds: Set multiple tlds. Default:
vm.dns.patterns: A list of domain patterns to match. Defaults to
VagrantDNS::Config.listen: an Array of Arrays describing interfaces to bind to. Defaults to
[[:udp, "127.0.0.1", 5300]].
VagrantDNS::Config.auto_run: (re)start and reconfigure the server every time a machine is started. On by default.
Using custom domains from inside the VM (VirtualBox only)
If you need to be able to resolve custom domains managed by this plugin from inside your virtual machine, add the following
setting to your
Vagrant.configure(2) do |config| # ... config.vm.provider "virtualbox" do |vm_config, override| vm_config.customize [ "modifyvm", :id, "--natdnshostresolver1", "on", # some systems also need this: # "--natdnshostresolver2", "on" ] end end
By default, the Virtualbox NAT engine offers the same DNS servers to the guest that are configured on the host. With the above setting, however, the NAT engine will act as a DNS proxy (see Virtualbox docs). That way, queries for your custom domains from inside the guest will also be handled by the DNS server run by the plugin.
- No IPv6 support
- OS X only (please read: Platform Support before ranting about this).
- Not automatically visible inside the box (special configuration of your guest system or provider needed)