contrib/dockerd-rootless.sh
ec87479b
 #!/bin/sh
 # dockerd-rootless.sh executes dockerd in rootless mode.
 #
 # Usage: dockerd-rootless.sh --experimental [DOCKERD_OPTIONS]
 # Currently, specifying --experimental is mandatory.
f0b405fb
 # Also, to expose ports, you need to specify
 # --userland-proxy-path=/path/to/rootlesskit-docker-proxy
ec87479b
 #
 # External dependencies:
 # * newuidmap and newgidmap needs to be installed.
 # * /etc/subuid and /etc/subgid needs to be configured for the current user.
e8b9a752
 # * Either one of slirp4netns (v0.3+), VPNKit, lxc-user-nic needs to be installed.
 #   slirp4netns is used by default if installed. Otherwise fallsback to VPNKit.
 #   The default value can be overridden with $DOCKERD_ROOTLESS_ROOTLESSKIT_NET=(slirp4netns|vpnkit|lxc-user-nic)
ec87479b
 #
 # See the documentation for the further information.
 
 set -e -x
 if ! [ -w $XDG_RUNTIME_DIR ]; then
 	echo "XDG_RUNTIME_DIR needs to be set and writable"
 	exit 1
 fi
 if ! [ -w $HOME ]; then
 	echo "HOME needs to be set and writable"
 	exit 1
 fi
 
 rootlesskit=""
 for f in docker-rootlesskit rootlesskit; do
 	if which $f >/dev/null 2>&1; then
 		rootlesskit=$f
 		break
 	fi
 done
 if [ -z $rootlesskit ]; then
 	echo "rootlesskit needs to be installed"
 	exit 1
 fi
 
e8b9a752
 : "${DOCKERD_ROOTLESS_ROOTLESSKIT_NET:=}"
 : "${DOCKERD_ROOTLESS_ROOTLESSKIT_MTU:=}"
5bd4233d
 # if slirp4netns v0.4.0+ is installed, slirp4netns is hardened using sandbox (mount namespace) and seccomp
 : "${DOCKERD_ROOTLESS_ROOTLESSKIT_SLIRP4NETNS_SANDBOX:=auto}"
 : "${DOCKERD_ROOTLESS_ROOTLESSKIT_SLIRP4NETNS_SECCOMP:=auto}"
e8b9a752
 net=$DOCKERD_ROOTLESS_ROOTLESSKIT_NET
 mtu=$DOCKERD_ROOTLESS_ROOTLESSKIT_MTU
ec87479b
 if [ -z $net ]; then
e8b9a752
 	if which slirp4netns >/dev/null 2>&1; then
 		if slirp4netns --help | grep -- --disable-host-loopback; then
 			net=slirp4netns
 			if [ -z $mtu ]; then
 				mtu=65520
 			fi
 		else
 			echo "slirp4netns does not support --disable-host-loopback. Falling back to VPNKit."
 		fi
ec87479b
 	fi
e8b9a752
 	if [ -z $net ]; then
 		if which vpnkit >/dev/null 2>&1; then
 			net=vpnkit
 		else
 			echo "Either slirp4netns (v0.3+) or vpnkit needs to be installed"
 			exit 1
 		fi
 	fi
 fi
 if [ -z $mtu ]; then
 	mtu=1500
ec87479b
 fi
 
 if [ -z $_DOCKERD_ROOTLESS_CHILD ]; then
 	_DOCKERD_ROOTLESS_CHILD=1
 	export _DOCKERD_ROOTLESS_CHILD
 	# Re-exec the script via RootlessKit, so as to create unprivileged {user,mount,network} namespaces.
 	#
 	# --copy-up allows removing/creating files in the directories by creating tmpfs and symlinks
 	# * /etc: copy-up is required so as to prevent `/etc/resolv.conf` in the
 	#         namespace from being unexpectedly unmounted when `/etc/resolv.conf` is recreated on the host
 	#         (by either systemd-networkd or NetworkManager)
 	# * /run: copy-up is required so that we can create /run/docker (hardcoded for plugins) in our namespace
853816ae
 	exec $rootlesskit \
e8b9a752
 		--net=$net --mtu=$mtu \
5bd4233d
 		--slirp4netns-sandbox=$DOCKERD_ROOTLESS_ROOTLESSKIT_SLIRP4NETNS_SANDBOX \
 		--slirp4netns-seccomp=$DOCKERD_ROOTLESS_ROOTLESSKIT_SLIRP4NETNS_SECCOMP \
e8b9a752
 		--disable-host-loopback --port-driver=builtin \
ec87479b
 		--copy-up=/etc --copy-up=/run \
 		$DOCKERD_ROOTLESS_ROOTLESSKIT_FLAGS \
 		$0 $@
 else
 	[ $_DOCKERD_ROOTLESS_CHILD = 1 ]
 	# remove the symlinks for the existing files in the parent namespace if any,
 	# so that we can create our own files in our mount namespace.
 	rm -f /run/docker /run/xtables.lock
853816ae
 	exec dockerd $@
ec87479b
 fi