Add support for WSL with HaneWIN NFS server (#97)

Add support for WSL with haneWIN NFS server

Author: DzeryCZ

README.md

@@ -1,14 +1,26 @@
 # Docker Machine NFS
 
+## Requirements
+
+* [Docker Machine](https://docs.docker.com/machine/) 0.5.0+
+
+## Mac OS X 10.9+
+
 Activates [NFS](https://en.wikipedia.org/wiki/Network_File_System) for an
 existing boot2docker box created through
 [Docker Machine](https://docs.docker.com/machine/).
 
-## Requirements
 :warning: There can be an issue with the NFS under Mac OS X High Sierra (see issue [#79](https://github.com/adlogix/docker-machine-nfs/issues/79) for more info) :warning:
 
-* Mac OS X 10.9+
-* [Docker Machine](https://docs.docker.com/machine/) 0.5.0+
+## Windows 10 with WSL
+
+* [Install WSL](https://docs.microsoft.com/en-us/windows/wsl/install-win10)
+* [Install VirtualBox](https://www.virtualbox.org/wiki/Downloads)
+* [Setup Docker-machine for WSL](https://www.paraesthesia.com/archive/2018/09/20/docker-on-wsl-with-virtualbox-and-docker-machine/)
+* [Install haneWIN NFS server](https://hanewin.net/nfs-e.htm)
+* [Install `docker-machine-nfs`](#standalone)
+* Mount drives under root (e.g. `/c`) - [Can be configured in `/etc/wsl.conf` - `automount`](https://devblogs.microsoft.com/commandline/automatically-configuring-wsl/)
+* Tested with these attributes: `docker-machine-nfs MACHINE-NAME --shared-folder=/c/Users/ --mount-opts="rw,vers=3,tcp,nolock,noacl,async"`
 
 ## Install
 
@@ -37,6 +49,9 @@ brew install docker-machine-nfs
 
 ## Usage
 
+* Create `docker-machine` as usual
+* Run `docker-machine-nfs`
+
 ```sh
 
 
@@ -73,7 +88,7 @@ Examples:
 
     > Configure the /var/www folder with NFS and the options '-alldirs -maproot=0'
 
-  $ docker-machine-nfs test --mount-opts="noacl,async,nolock,vers=3,udp,noatime,actimeo=1"
+  $ docker-machine-nfs test --mount-opts="noacl,async,nolock,nfsvers=3,udp,noatime,actimeo=1"
 
     > Configure the /User folder with NFS and specific mount options.
 
@@ -83,7 +98,19 @@ Examples:
 
 ```
 
+## Troubleshooting
+
+- **Failed to mount on WSL**
+```
+Allow following exe's in "Windows Firewall" or any other firewall software used
+   Directory -- c:/Program Files/nfsd
+   -  pmapd.exe
+   -  nfssrv.exe
+   -  nfsd.exe
+```
+
 ## Credits
 
-Heavily inspired by @[mattes](https://github.com/mattes) ruby version
+* Heavily inspired by @[mattes](https://github.com/mattes) ruby version
 [boot2docker-nfs.rb](https://gist.github.com/mattes/4d7f435d759ca2581347).
+* @[DzeryCZ](https://github.com/DzeryCZ) added support for Windows with WSL

docker-machine-nfs.sh

@@ -1,4 +1,4 @@
-#!/bin/sh
+#!/bin/bash
 #
 # The MIT License (MIT)
 # Copyright © 2015 Toni Van de Voorde <[email protected]>
@@ -76,7 +76,7 @@ Examples:
 
     > Configure the /var/www folder with NFS and the options '-alldirs -maproot=0'
 
-  $ docker-machine-nfs test --mount-opts="noacl,async,nolock,vers=3,udp,noatime,actimeo=1"
+  $ docker-machine-nfs test --mount-opts="noacl,async,nolock,nfsvers=3,udp,noatime,actimeo=1"
 
     > Configure the /User folder with NFS and specific mount options.
 
@@ -91,21 +91,21 @@ EOF
 # @args:    error-message
 echoError ()
 {
-  echo "\033[0;31mFAIL\n\n$1 \033[0m"
+  printf "\033[0;31mFAIL\n\n$1 \033[0m\n"
 }
 
 # @info:    Prints warning messages
 # @args:    warning-message
 echoWarn ()
 {
-  echo "\033[0;33m$1 \033[0m"
+  printf "\033[0;33m$1 \033[0m\n"
 }
 
 # @info:    Prints success messages
 # @args:    success-message
 echoSuccess ()
 {
-  echo "\033[0;32m$1 \033[0m"
+  printf "\033[0;32m$1 \033[0m\n"
 }
 
 # @info:    Prints check messages
@@ -119,7 +119,7 @@ echoInfo ()
 # @args:    property-message
 echoProperties ()
 {
-  echo "\t\033[0;35m- $1 \033[0m"
+  printf "\t\033[0;35m- $1 \033[0m\n"
 }
 
 # @info:    Checks if a given property is set
@@ -207,8 +207,14 @@ parseCli()
     esac
   done
 
+  if [ "$(isWsl)" = "true" ]; then
+    local default_shared_foder="/c/Users"
+  else
+    local default_shared_foder="/Users"
+  fi
+
   if [ ${#prop_shared_folders[@]} -eq 0 ]; then
-    prop_shared_folders+=("/Users")
+    prop_shared_folders+=("${default_shared_foder}")
   fi;
 
   echoInfo "Configuration:"
@@ -273,7 +279,7 @@ getMachineDriver ()
 # @info:    Loads mandatory properties from the docker machine
 lookupMandatoryProperties ()
 {
-  echoInfo "Lookup mandatory properties ... "
+  echoInfo "Lookup mandatory properties ... \t\t"
 
   prop_machine_ip=$(docker-machine ip $1)
 
@@ -337,7 +343,7 @@ lookupMandatoryProperties ()
     echoError "Could not find the virtualbox net name!"; exit 1
   fi
 
-  prop_nfshost_ip=$(VBoxManage list hostonlyifs |
+  prop_nfshost_ip=$(VBoxManage list hostonlyifs | tr -d '\r' |
     grep "${prop_network_id}$" -A 3 | grep IPAddress |
     cut -d ':' -f2 | xargs);
   if [ "" = "${prop_nfshost_ip}" ]; then
@@ -348,7 +354,7 @@ lookupMandatoryProperties ()
 }
 
 # @info:    Configures the NFS
-configureNFS()
+configureNFSUnix()
 {
   echoInfo "Configure NFS ... \n"
 
@@ -394,6 +400,32 @@ configureNFS()
   echoSuccess "\t\t\t\t\t\tOK"
 }
 
+configureNFSWsl()
+{
+  echoInfo "Configure NFS ... \n"
+
+  local nfsdPath=$(sc.exe qc nfsserver | grep BINARY_PATH_NAME | awk '{split($0,a," : "); print a[2]}' | awk '{sub("nfsd.exe","",$0);}1' | awk '{sub("\\","/",$0);}1')
+  local wslnfsdPath=$(wslpath -a "$nfsdPath" | tr -d '\r')
+  wslnfsdPath+="exports"
+
+  if [ ! -f "$wslnfsdPath" ]; then
+    echoError "Configuration file was not found in $wslnfsdPath, please check installation of haneWin server"
+    exit 1
+  fi
+
+  for shared_folder in "${prop_shared_folders[@]}"
+  do
+    local wsl_shared_folder=$(wslpath -w $shared_folder)
+    echo "$wsl_shared_folder -alldirs -exec -mapall:1000,1000 #Added by docker-machine-nfs" >> "$wslnfsdPath"
+  done
+
+  echoProperties "$(net.exe stop nfsserver)"
+  echoProperties "$(net.exe start nfsserver)"
+
+  echoInfo "NFS server ... \t\t\t\t"
+  echoSuccess "OK"
+}
+
 # @info:    Configures the VirtualBox Docker Machine to mount nfs
 configureBoot2Docker()
 {
@@ -409,8 +441,15 @@ configureBoot2Docker()
   # render bootlocal.sh and copy bootlocal.sh over to Docker Machine
   # (this will override an existing /var/lib/boot2docker/bootlocal.sh)
 
-  local bootlocalsh='#!/bin/sh
-  sudo umount /Users'
+  local bootlocalsh="#!/bin/sh"
+
+  if [ "$(isWsl)" = "true" ]; then
+    bootlocalsh="${bootlocalsh}
+    sudo umount /c/Users"
+  else
+    bootlocalsh="${bootlocalsh}
+    sudo umount /Users"
+  fi
 
   for shared_folder in "${prop_shared_folders[@]}"
   do
@@ -419,7 +458,7 @@ configureBoot2Docker()
   done
 
   bootlocalsh="${bootlocalsh}
-  sudo /usr/local/etc/init.d/nfs-client start"
+    sudo /usr/local/etc/init.d/nfs-client start"
 
   for shared_folder in "${prop_shared_folders[@]}"
   do
@@ -430,8 +469,8 @@ configureBoot2Docker()
   local file="/var/lib/boot2docker/bootlocal.sh"
 
   docker-machine ssh $prop_machine_name \
-    "echo '$bootlocalsh' | sudo tee $file && sudo chmod +x $file && sync" > /dev/null
-
+    "echo '$bootlocalsh' | sudo tee $file && sudo chmod +x $file && sync" < /dev/null > /dev/null
+  
   sleep 2
 
   echoSuccess "OK"
@@ -456,7 +495,7 @@ isNFSMounted()
 {
   for shared_folder in "${prop_shared_folders[@]}"
   do
-    local nfs_mount=$(docker-machine ssh $prop_machine_name "sudo mount" |
+    local nfs_mount=$(docker-machine ssh $prop_machine_name "sudo mount" < /dev/null | 
       grep "$prop_nfshost_ip:$(resolveHostPath "$shared_folder") on")
     if [ "" = "$nfs_mount" ]; then
       echo "false";
@@ -490,7 +529,7 @@ verifyNFSMount()
 # @info:    Displays the finish message
 showFinish()
 {
-  echo "\033[0;36m"
+  printf "\033[0;36m"
   echo "--------------------------------------------"
   echo
   echo " The docker-machine '$prop_machine_name'"
@@ -499,9 +538,32 @@ showFinish()
   echo " ENJOY high speed mounts :D"
   echo
   echo "--------------------------------------------"
-  echo "\033[0m"
+  printf "\033[0m"
+}
+
+# WSL
+
+# @return:  'true', if platform is WSL; else 'false'
+isWsl()
+{
+  if [ "$(uname -r | grep 'Microsoft')" != "" ]; then
+    echo "true"
+  else
+    echo "false"
+  fi
 }
 
+if [ "$(isWsl)" = "true" ]; then
+  printf "\033[0;32mPlaform WSl detected\033[0m\n"
+
+# @info:    translate docker-machine to .exe
+  function docker-machine()
+  {
+    docker-machine.exe "$@"
+  }
+  export -f docker-machine
+fi
+
 # END _functions
 
 setPropDefaults
@@ -513,7 +575,7 @@ checkMachineRunning $prop_machine_name "$prop_timeout"
 
 lookupMandatoryProperties $prop_machine_name "$prop_timeout"
 
-if [ "$(isNFSMounted)" = "true" ] && [ "$prop_force_configuration_nfs" = false ]; then
+if [ "$(isNFSMounted)" = "true" ] && [ "$prop_force_configuration_nfs" = "false" ]; then
     echoSuccess "\n NFS already mounted." ; showFinish ; exit 0
 fi
 
@@ -525,7 +587,11 @@ echoProperties "NFSHost IP: $prop_nfshost_ip"
 
 echo #EMPTY LINE
 
-configureNFS
+if [ "$(isWsl)" = "true" ]; then
+  configureNFSWsl
+else
+  configureNFSUnix
+fi
 
 configureBoot2Docker
 restartDockerMachine