Skip to content

Instantly share code, notes, and snippets.

Embed
What would you like to do?
How To Set Up Docker For Mac (Mojave) with Native NFS
version: '2'
services:
api:
volumes:
- "nfsmount:${CONTAINER_DIR}"
volumes:
nfsmount:
driver: local
driver_opts:
type: nfs
o: addr=host.docker.internal,rw,nolock,hard,nointr,nfsvers=3
device: ":${SOURCE_DIR}"
export CONTAINER_DIR=/myapp
export SOURCE_DIR=/Users/me/myapp
#!/usr/bin/env bash
OS=`uname -s`
if [ $OS != "Darwin" ]; then
echo "This script is OSX-only. Please do not run it on any other Unix."
exit 1
fi
if [[ $EUID -eq 0 ]]; then
echo "This script must NOT be run with sudo/root. Please re-run without sudo." 1>&2
exit 1
fi
echo ""
echo " +-----------------------------+"
echo " | Setup native NFS for Docker |"
echo " +-----------------------------+"
echo ""
echo "WARNING: This script will shut down running containers and prune docker volumes."
echo ""
echo -n "Do you wish to proceed? [y]: "
read decision
if [ "$decision" != "y" ]; then
echo "Exiting. No changes made."
exit 1
fi
echo ""
if ! docker ps > /dev/null 2>&1 ; then
echo "== Waiting for docker to start..."
fi
open -a Docker
while ! docker ps > /dev/null 2>&1 ; do sleep 2; done
echo "== Stopping running docker containers..."
docker-compose down > /dev/null 2>&1
docker volume prune -f > /dev/null
osascript -e 'quit app "Docker"'
echo "== Resetting folder permissions..."
U=`id -u`
G=`id -g`
sudo chown -R "$U":"$G" .
echo "== Setting up nfs..."
LINE="/Users -alldirs -mapall=$U:$G localhost"
FILE=/etc/exports
sudo cp /dev/null $FILE
grep -qF -- "$LINE" "$FILE" || sudo echo "$LINE" | sudo tee -a $FILE > /dev/null
LINE="nfs.server.mount.require_resv_port = 0"
FILE=/etc/nfs.conf
grep -qF -- "$LINE" "$FILE" || sudo echo "$LINE" | sudo tee -a $FILE > /dev/null
echo "== Restarting nfsd..."
sudo nfsd restart
echo "== Restarting docker..."
open -a Docker
while ! docker ps > /dev/null 2>&1 ; do sleep 2; done
echo ""
echo "SUCCESS! Now go run your containers 🐳"
@roberquesada
Copy link

roberquesada commented Oct 12, 2019

Thank you @egobude! You saved me!

@geerlingguy
Copy link

geerlingguy commented Mar 11, 2020

Thanks @egobude :)

@DiegoVallely
Copy link

DiegoVallely commented Mar 19, 2020

thanks @egobude

@theorician
Copy link

theorician commented Apr 24, 2020

Bro are you serious?

https://gist.github.com/seanhandley/7dad300420e5f8f02e7243b7651c6657#file-setup_native_nfs_docker_osx-sh-L43
docker volume prune -f??

Seriously, get rid of that, someone is going to fuck their shit up with that.

@thegodone
Copy link

thegodone commented May 23, 2020

what would be the commands for HighSierra version ?

@seanhandley
Copy link
Author

seanhandley commented May 23, 2020

Bro are you serious?

https://gist.github.com/seanhandley/7dad300420e5f8f02e7243b7651c6657#file-setup_native_nfs_docker_osx-sh-L43
docker volume prune -f??

Seriously, get rid of that, someone is going to fuck their shit up with that.

@theorician I wrote this script to help set up our dev env at work. Works fine for us, but YMMV.

  1. Feel free to fork it.
  2. Configuring Docker is definitely not my area of expertise. If you want to suggest a safer command to recreate volumes, please let me know and I'll update the script.
  3. Please consider refining your approach in future when commenting on code people have shared freely. You can save your "bro" and your "fuck shit up" for arguing with minors in online games - keep your language civil and your feedback constructive and help make the world a more pleasant place in which to collaborate ❤️

@Wharenn
Copy link

Wharenn commented May 27, 2020

Bro are you serious?

seanhandley/7dad300420e5f8f02e7243b7651c6657#file-setup_native_nfs_docker_osx-sh-L43
docker volume prune -f??

Seriously, get rid of that, someone is going to fuck their shit up with that.

Indeed the pruning is not really expected. It can be easily missed when read. I missed it :p. Maybe a prompt to do it or not would prevent people from loosing their data while testing the script. It would be a nice addition to this (awesome) gist.

@seanhandley
Copy link
Author

seanhandley commented May 30, 2020

I've updated the warning to:

WARNING: This script will shut down running containers and prune docker volumes.

I'm open to suggestions for how to handle recreating volumes in a more targeted way 👍

I also encourage D4M users to try this new edge feature - maybe it removes the need to workaround performance issues via NFS as done in this gist https://docs.docker.com/docker-for-mac/mutagen-caching/

@abdennour
Copy link

abdennour commented Jul 1, 2020

What about the embedded kubernetes with docker-for-mac ( or docker-for-desktop). it has already strogeclass "hostpath" as default.
Can we leverage this solution for dynamic PV provisioning with NFS (RWX) mount using Docker for Desktop ?

@darkn3rd
Copy link

darkn3rd commented Sep 29, 2020

How would you do this on Linux, I don't have a host.docker.internal on my network. Is this the docker gateway address?

@gabs77
Copy link

gabs77 commented Feb 20, 2021

I test my NFS configuration ans it's so slow
Composer install test on Magento :
no bind, no NFS, directly docker environment : 1m25
no bind, NFS Volume: 10m45 AND the permissions are not the goods ones
Maybe my config is not optimal but for me now on ma, the best performance is the following methods :

  • mount bind delegated custom code directory
  • not bind log, var, cache, vendor directory (keep only on docker environment)

@peanutlasko
Copy link

peanutlasko commented Apr 2, 2021

I keep trying to follow this guide and no matter how much I try to adjust permissions, it still continues to display an error and state: "Operation Not Supported"

I've allowed full disk access for iterm, console, nfsd.

My root cause it probably because my projects dont live in my home directory. They are on a separate volume, which I have still listed in my /etc/exports folder:

/System/Volumes/Data/Users -alldirs -mapall=501:20 localhost
/Volumes/Data/Docker -alldirs -mapall=501:20 localhost
/Volumes/Media -alldirs -mapall=501:20 localhost

@keywinf
Copy link

keywinf commented Jun 18, 2021

Seems to be broken for docker desktop > 3.2.2

@jamsinclair
Copy link

jamsinclair commented Jul 15, 2021

Firstly thanks for this script @seanhandley, you've helped so many of us! 🙇

Seems to be broken for docker desktop > 3.2.2

Running Docker Desktop (for mac) v3.5.1 and working fine here 🙆.

I'm open to suggestions for how to handle recreating volumes in a more targeted way 👍

If we're talking about only removing volumes for the current docker project, docker down -v may be a nicer solution 😸. Removes only named volumes from the compose file (See docker-compose down documentation)

@dev-danim
Copy link

dev-danim commented Jul 15, 2021

@jamsinclair yeah now it's working with v3.5.1, but thanks to the new docker volumes management (mutagen). No need for NFS volumes anymore (you can also remove your old :cached and :delegated flags)

@jamsinclair
Copy link

jamsinclair commented Jul 15, 2021

@dev-danim appreciate the update! Do you have any links around that? I don't see much mention of volume performance improvements in any of the docker blog and github material I'm browsing.

Edit: From what I can gather Docker went with "gRPC FUSE" instead of mutagen that has improved performance and made :delegated, :cached and :ro flags redundant. Still trying to track down which version this moved from experimental to stable. Seems to have flown under the radar.

tldr; as @dev-danim pointed out just update to the latest Docker Desktop build 😸. You may not need NFS mounts anymore.

Relevant Links:

@MafMihai
Copy link

MafMihai commented Sep 22, 2021

Is there any special requirement for M1 macs? I am struggling to start containers on it.
Stuck here -> data: addr=192.168.65.2,nolock,hard,nointr,nfsvers=3: invalid argument

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment