dockerbox
is a single executable that runs docker containers based on local and remote run configurations.
By default dockerbox configuration files live in
$HOME/.dockerbox/
and binaries are installed at$HOME/.dockerbox/bin/
. To override these defaults you can set the following environment variablesDOCKERBOX_ROOT_DIR
andDOCKERBOX_INSTALL_DIR
.
go get github.com/sethpollack/dockerbox
Add dockerbox
to your path
export PATH=$PATH:$HOME/.dockerbox/bin/
Add a remote repo to your registry
dockerbox registry add example https://raw.githubusercontent.com/sethpollack/dockerbox/master/example/example.yaml
Add a local repo to your registry
cat <<'EOF' >$HOME/.dockerbox/local.yaml
applets:
kubectl:
name: kubectl
image: sethpollack/kubectl
image_tag: 1.8.4
entrypoint: kubectl
environment:
- KUBECONFIG=/root/.kube/config
volumes:
- $HOME/.kube:/root/.kube
- $PWD:/app
work_dir: /app
EOF
dockerbox registry add local $HOME/.dockerbox/local.yaml
To see the list of available applets run dockerbox list
To update your applet cache ($HOME/.dockerbox/.cache.yaml
) from all the repos in the registry run dockerbox update
.
To install an applet run dockerbox install -i <applet name>
or dockerbox install -a
to install all available applets.
dockerbox
installs applets by creating a symlink from $HOME/.dockerbox/<applet name>
to the dockerbox binary.
Full applet spec:
name
stringwork_dir
stringentrypoint
stringrestart
stringnetwork
stringrm
bool (defaults true)tty
bool (defaults true)interactive
bool (defaults true)privileged
booldetach
boolkill
bool (kills running container with the same name before running)environment
listvolumes
listports
listenv_file
listdependencies
list (list of applets to run first)links
listimage
stringimage_tag
stringcommand
list
Usage:
dockerbox [command]
Available Commands:
help Help about any command
install install docker applet
list list all available applets in the repo
registry
uninstall uninstall docker applet
update update the repo from the registry configs
version
Usage:
dockerbox registry [command]
Available Commands:
add Add or update a repo in the registry.
remove Remove a repo from the registry