Run a docker container with you workspace and user
Project description
dockerinside is a Python (Python3 only) package that shall simplify running docker images as the current user similar to the way Jenkins awesome docker.inside() works. There are two main use-cases:
You want to easily share access between a container and your environment without having to manually modify the user id and group id of the files created by the running container.
You want to run dockerized GUI applications but share your home environment
You don’t have to write a Dockerfile just to adapt to your environment (user id / group id). It is a much more elegant approach to adapt the environment during startup of the container on the fly as Jenkins does it.
Installation
Prerequisits:
Python3 installation (>= 3.6)
python3-venv is recommended to create a virtual environment
Install current stable version (preferably in a virtual environment):
pip install git+https://github.com/boon-code/docker-inside.git
For convenience, dockerinside uses su-exec which is statically compiled using alpine and musl-c library. To build it, you have to run
# use --auto-pull to download alpine image for compilation if it's not available docker-inside-setup --auto-pull
This will create a directory ~/.config/docker_inside/ and put a file named su-exec there. You can also compile su-exec and create the file structure yourself or not use it at all. If this file doesn’t exist, su is used to switch user id which might cause problems with tty handling, so it’s highly recommended to use su-exec.
Big thanks to Natanael Copa (ncopa) for sharing su-exec.
Usage
Basic
Running an ubuntu:16.04 container as current user with the home directory mounted:
docker-inside -H ubuntu:16.04
which is roughly equivalent to running
docker run --rm -ti --user "$(id -u)" -v "${HOME}:${HOME}" ubuntu:16.04
but does already add users and groups so you won’t see I have no name! in your shell prompt.
Fake Home
You can also use a fake home directory
mkdir -p /tmp/fake-home docker-inside --mount-as-home /tmp/fake-home ubuntu:16.04 -- echo "Hello, World" \>~/readme.txt #DockerInside : MainThread : INFO : Starting container: 59133ebeb3a3116999f66b4e302ba675a74f02ac83ae526704f2f4cdbd82ed5d #DockerInside : MainThread : INFO : Container 59133ebeb3a3116999f66b4e302ba675a74f02ac83ae526704f2f4cdbd82ed5d stopped cat /tmp/fake-home/readme.txt #Hello, World
Jenkins Debugging
Sometimes, I just quickly want to debug a problem on a failing Jenkins job which uses docker with lot’s of bind mounts which is as simple as this:
cd <WORKSPACE> docker-inside -v <first-mount>:<some-path> \ -v <second-mount>:<some-other-path> \ -v <WORKSPACE> \ -w <WORKSPACE> \ <IMAGE_TO_USE> \ [optional-command]
Additional Use-Cases
Please let me know I you need support for more options from original docker run command or have any other suggestions how to improve this package. Please also let me know if your Docker image is failing using this package and I will see if I can fix the issue. Adding users and groups is unfortunately quite different among distributions.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.