Issue vagrant-landrush#16 Documenting Windows DNS configuration

README.md

@@ -1,19 +1,47 @@
 # Landrush: DNS for Vagrant [![Build Status](https://travis-ci.org/phinze/landrush.png)](https://travis-ci.org/phinze/landrush)
 
-Simple DNS that's visible on both the guest and the host.
-
-Spins up a small DNS server and redirects DNS traffic from your VMs to use it,
-automatically registers/deregisters IP addresses of guests as they come up
-and down.
-
+Simple cross-platform DNS that's visible on both the guest and the host.
+
+Landrush spins up a small DNS server and redirects DNS traffic from your
+VMs to use it, automatically registering/unregistering IP addresses of guests
+as they come up and down.
+
+**Note**: Windows support is currently considered experimental. If you having
+problems using Landrush on Windows please let us know.
+
+<!-- MarkdownTOC -->
+
+- [Installation](#installation)
+- [Usage](#usage)
+    - [Get started](#get-started)
+    - [Dynamic entries](#dynamic-entries)
+    - [Static entries](#static-entries)
+    - [Wildcard Subdomains](#wildcard-subdomains)
+    - [Unmatched Queries](#unmatched-queries)
+    - [Visibility on the Guest](#visibility-on-the-guest)
+    - [Visibility on the Host](#visibility-on-the-host)
+        - [OS X](#os-x)
+        - [Linux](#linux)
+        - [Windows](#windows)
+        - [Other Devices \(phone\)](#other-devices-phone)
+    - [Additional CLI commands](#additional-cli-commands)
+- [Development](#development)
+- [RoadMap](#roadmap)
+- [Help Out!](#help-out)
+
+<!-- /MarkdownTOC -->
+
+<a name="installation"></a>
 ## Installation
 
 Install under Vagrant (1.1 or later):
 
     $ vagrant plugin install landrush
 
+<a name="usage"></a>
 ## Usage
 
+<a name="get-started"></a>
 ### Get started
 
 Enable the plugin in your `Vagrantfile`:
@@ -32,6 +60,7 @@ If you shut down your guest, the entries associated with it will be removed.
 
 Landrush assigns your vm's hostname from either the vagrant config (see the `examples/Vagrantfile`) or system's actual hostname by running the `hostname` command. A default of "guest-vm" is assumed if hostname is otherwise not available.
 
+<a name="dynamic-entries"></a>
 ### Dynamic entries
 
 Every time a VM is started, its IP address is automatically detected and a DNS record is created that maps the hostname to its IP.
@@ -42,6 +71,7 @@ If for any reason the auto-detection detects no IP address or the wrong IP addre
 
 If you are using a multi-machine `Vagrantfile`, configure this inside each of your `config.vm.define` sections.
 
+<a name="static-entries"></a>
 ### Static entries
 
 You can add static host entries to the DNS server in your `Vagrantfile` like so:
@@ -50,6 +80,7 @@ You can add static host entries to the DNS server in your `Vagrantfile` like so:
 
 This is great for overriding production services for nodes you might be testing locally. For example, perhaps you might want to override the hostname of your puppetmaster to point to a local vagrant box instead.
 
+<a name="wildcard-subdomains"></a>
 ### Wildcard Subdomains
 
 For your convenience, any subdomain of a DNS entry known to landrush will resolve to the same IP address as the entry. For example: given `myhost.vagrant.test -> 1.2.3.4`, both `foo.myhost.vagrant.test` and `bar.myhost.vagrant.test` will also resolve to `1.2.3.4`.
@@ -60,6 +91,7 @@ If you would like to configure your guests to be accessible from the host as sub
 
 Note that from the __host__, you will only be able to access subdomains of your configured TLD by default- so wildcard subdomains only apply to that space. For the __guest__, wildcard subdomains work for anything.
 
+<a name="unmatched-queries"></a>
 ### Unmatched Queries
 
 Any DNS queries that do not match will be passed through to an upstream DNS server, so this will be able to serve as the one-stop shop for your guests' DNS needs.
@@ -72,6 +104,7 @@ If you would like to configure your own upstream servers, add upstream entries t
     # If your upstream is TCP only for some strange reason
     config.landrush.upstream '10.1.3.10', 1001, :tcp
 
+<a name="visibility-on-the-guest"></a>
 ### Visibility on the Guest
 
 Linux guests should automatically have their DNS traffic redirected via `iptables` rules to the Landrush DNS server. File an issue if this does not work for you.
@@ -83,12 +116,20 @@ To disable this functionality:
 You may want to do this if you are already proxying all your DNS requests through your host (e.g. using VirtualBox's natdnshostresolver1 option) and you
 have DNS servers that you can easily set as upstreams in the daemon (e.g. DNS requests that go through the host's VPN connection).
 
+<a name="visibility-on-the-host"></a>
 ### Visibility on the Host
 
+<a name="os-x"></a>
+#### OS X
+
 If you're on an OS X host, we use a nice trick to unobtrusively add a secondary DNS server only for specific domains.
 Landrush adds a file into `/etc/resolver` that points lookups for hostnames ending in your `config.landrush.tld` domain
 name to its DNS server. (Check out `man 5 resolver` on your Mac OS X host for more information on this file's syntax.)
 
+
+<a name="linux"></a>
+#### Linux
+
 Though it's not automatically set up by landrush, similar behavior can be achieved on Linux hosts with `dnsmasq`. You
 can integrate Landrush with dnsmasq on Ubuntu like so (tested on Ubuntu 13.10):
 
@@ -98,16 +139,118 @@ can integrate Landrush with dnsmasq on Ubuntu like so (tested on Ubuntu 13.10):
 
 If you use a TLD other than the default `vagrant.test`, replace the TLD in the above instructions accordingly. Please be aware that anything ending in '.local' as TLD will not work because the `avahi` daemon reserves this TLD for its own uses.
 
-### Visibility on other Devices (phone)
+<a name="windows"></a>
+#### Windows
+
+**Note**: Windows support is currently considered experimental. If you having
+problems using Landrush on Windows please let us know.
+
+On Windows a secondary DNS server can be configured via the properties of a
+network adapter. This will be illustrated in the following using Windows 10 with
+VirtualBox.
+
+When running VirtualBox on Windows in combination with Landrush the Network
+Connections (`Control Panel\Network and Internet\Network Connections`) looks
+somewhat like this after a successful `vagrant up`:
+
+![Network Connections](doc/img/network-connections.png "Network Connections")
+
+There will be at least one VirtualBox network adapter. There might be multiple
+depending on your configuration (number of networks configured) and how many VMs
+you have running, but you just need to modify one.
+
+In a first step you need to identify the VirtualBox network adapter used for the
+private network of your VM. Landrush requires a private network adapter to work
+and will create one in case you are not explicitly configuring one in your
+`Vagrantfile`.
+
+To quickly view the settings of each network adapter you can run the following
+command in a shell:
+
+    netsh interface ip show config
+
+The output should look something like that:
+
+    Configuration for interface "Ethernet0"
+        DHCP enabled:                         Yes
+        IP Address:                           172.16.74.143
+        Subnet Prefix:                        172.16.74.0/24 (mask 255.255.255.0)
+        Default Gateway:                      172.16.74.2
+        Gateway Metric:                       0
+        InterfaceMetric:                      10
+        DNS servers configured through DHCP:  172.16.74.2
+        Register with which suffix:           Primary only
+        WINS servers configured through DHCP: 172.16.74.2
+
+    Configuration for interface "VirtualBox Host-Only Network"
+        DHCP enabled:                         No
+        IP Address:                           10.1.2.1
+        Subnet Prefix:                        10.1.2.0/24 (mask 255.255.255.0)
+        InterfaceMetric:                      10
+        Statically Configured DNS Servers:    None
+        Register with which suffix:           Primary only
+        Statically Configured WINS Servers:   None
+
+
+In our case we are interested in the `VirtualBox Host-Only Network` which
+has in this example the private network IP 10.1.2.1. If you don't have a static
+private network IP configured and you cannot determine the right adapter via
+the `netsh` output, ssh into the VM (`vagrant ssh`) and run `ifconfig` to view
+the network configuration of the VM.
+
+Once you identified the right network adapter run the following as Administrator
+(using the network adapter name of the adapter with the determined private
+network IP):
+
+     netsh interface ipv4 add dnsserver "VirtualBox Host-Only Network" address=127.0.0.1 index=1
+
+This should be enough for Windows 10. On other Windows versions, you might have to
+also add your TLD to the DNS suffix list on the DNS Advanced TCP/IP Settings tab:
+
+![Advanced TCP/IP Settings](doc/img/advanced-tcp-properties.png "Advanced TCP/IP Settings")
+
+<a name="other-devices-phone"></a>
+#### Other Devices (phone)
 
 You might want to resolve Landrush's DNS-entries on *additional* computing devices, like a mobile phone.
 
 Please refer to [/doc/proxy-mobile](/doc/proxy-mobile) for instructions.
 
+<a name="additional-cli-commands"></a>
 ### Additional CLI commands
 
 Check out `vagrant landrush` for additional commands to monitor the DNS server daemon.
 
+
+<a name="development"></a>
+## Development
+
+Install dependencies:
+
+    bundle install
+
+Get a list of all available build tasks:
+
+    bundle exec rake -T
+
+Run the test suite:
+
+    bundle exec rake test
+
+Build the Landrush gem:
+
+    bundle exec rake install
+
+Clean generated files:
+
+    bundle exec rake clobber
+
+Run the vagrant binary with the Landrush plugin loaded from your local
+source code:
+
+    bundle exec vagrant landrush <command>
+
+<a name="roadmap"></a>
 ## RoadMap
 
 The committers met and have set a basic roadmap as of 3 March 2016:
@@ -136,21 +279,8 @@ code commits available and document the release process.
 
   * PR #62 - Arbitrary record types
 
-## Development
-
-Install dependencies:
-
-    bundle install
-
-Run the test suite:
-
-    bundle exec rake
-
-Run the vagrant binary with the landrush plugin loaded from your local source code:
-
-    bundle exec vagrant landrush <command>
-
-### Help Out!
+<a name="help-out"></a>
+## Help Out!
 
 This project could use your feedback and help! Please don't hesitate to open issues or submit pull requests. NO HESITATION IS ALLOWED. NONE WHATSOEVER.  See [CONTRIBUTING.md](CONTRIBUTING.md) for more details.