Public Repository

Last pushed: 5 months ago
Short Description
Box - The Advanced Docker Builder
Full Description

Box: A Next-Generation Builder for Docker Images

Box is a builder for docker that gives you the power of mruby, a limited,
embeddable ruby. It allows for notions of conditionals, loops, and data
structures for use within your builder plan. If you've written a Dockerfile
before, writing a box build plan is easy.

  • Unique general features:
    • mruby syntax
    • filtering of keywords to secure builds
    • REPL (shell) for interactive building (see video below)
    • Multiple builds at once: build whole projects worth of images
  • In the build plan itself:

    • Tagging
    • Flattening
    • Debug mode (drop to a shell in the middle of a plan run and inspect your container)
    • Ruby block methods for user (with_user) and workdir (inside) allow
      you to scope copy and run operations for a more obvious build plan.
  • Extended Documentation for Syntax and Usage


Using the Homebrew Tap

brew tap box-builder/box && brew install box-builder/box/box


This will fetch the golang image, update APT, and then install the packages set
in the packages variable. It then creates a user and copies the dir to its
homedir. If an environment value is provided, it will be used. Then it will tag
the whole image as mypackages.

Save it to plan.rb and run it with box plan.rb. Box only copies what it
needs to; your whole directory won't be uploaded to docker.

from "golang"

packages = "build-essential g++ git wget curl ruby bison flex"

run "apt-get update"
run "apt-get install -y #{packages}"

run %q[useradd -m -d /home/erikh -s /bin/bash erikh]

inside "/home/erikh" do
  copy((getenv("MYDIR") || "."), ".")

tag "mypackages"


Here's a video of the shell in action (click for more):

Available in v0.3 and up

Advanced Use

The documentation is the best resource for
learning the different verbs and functions. However, check out
our own build plan for box
for an example of how to use different predicates, functions, and verbs to
get everything you need out of it.

Development Instructions

  • Requires: compiler, bison, flex, and libgpgme, libdevmapper, btrfs headers.
  • go get -d && cd $GOPATH/src/
  • To build on the host (create a dev environment):
    • make
  • To build a docker image for your dev environment (needed for test and release builds):
    • make build
  • If you have a dev environment:
    • make test
  • To do a release build:
    • VERSION=<version> make release
Docker Pull Command