The 12 Tips of (CommandBox) Christmas 2017- Day 6 - Docker

In today’s The 12 Tips of (CommandBox) Christmas we’re going to discuss Docker. Containers are changing how the world deploys apps and services for development and production. With Docker you don’t need to ask around to find a good ColdFusion hosting company. All you need is a company who supports Docker and you know you can deploy there. Docker requires a shift in thinking though. Smaller, transient servers that you don’t install every time. Portable configuration and flexible deployments based on text configuration files and environment variables. Hey, that sounds right up CommandBox’s alley!

We’ve got an app for that

We provide an official CommandBox-based Docker image, which allows you to leverage its capability to orchestrate live servers in multi-tier deployments. Everything that CommandBox brings to the table, including the ability to start Adobe and Lucee servers, portable configuration via CFConfig, and using environment variables to control your deployment translate directly from your desktop right into the container cloud.

We’ve been talking about server.json and CFConfig so far and you can bring all of that knowledge along into Docker. The probability of CommandBox’s configuration makes it uniquely suited to use with Docker. CommandBox servers are also lightweight and fast, built on JBoss Undertow so they perform great, even in a production environment! Our Docker images are the only professionally supported images supporting Adobe CF right now and the only CF images I know of that don’t involve messy hacks like copying XML files around.


This section assumes you are using the Official Docker Image. By default, the directory /app in the container is mapped as Commandbox home. To deploy a new application, first pull the image:

docker pull ortussolutions/commandbox

Then, from the root of your project, start with

docker run -p 8080:8080 -p 8443:8443 -v "/path/to/your/app:/app" ortussolutions/commandbox

By default the process ports of the container are 8080 (insecure) and 8443 (secure - if enabled in your server.json) so, once the container comes online, you may access your application via browser using the applicable port (which we explicitly exposed for external access in the run command above). You may also specify different port arguments in your run command to assign what is to be used in the container and exposed. This prevents conflicts with other instances in the Docker machine using those ports:

docker pull -expose-list 80 443 -e "PORT=80" -e "SSL_PORT=443" -v "/path/to/your/app:/app" ortussolutions/commandbox

To create your own, customized Docker image, use our Dockerfile repository as the baseline to begin your customizations.

Environment Variables

The CommandBox Docker image support the use of environmental variables for the configuration of your servers. Specifically, the image includes the cfconfig CommandBox module, which allows you to provide custom settings for your engine, including the admin password.

  • $PORT - The port which your server should start on. The default is 8080.
  • $SSL_PORT - If applicable, the ssl port used by your server The default is 8443.
  • $CFENGINE - Using the server.json syntax, allows you to specify the CFML engine for your container
  • $HEALTHCHECK_URI - Specifies the URI endpoint for container health checks. By default, this is set${Setting: PORT not found}/ at 1 minute intervals with 5 retries and a timeout of 30s
  • $cfconfig_[engine setting] - Any environment variable provided which includes the cfconfig_prefix will be determined to be a cfconfig setting and the value after the prefix is presumed to be the setting name. The command cfconfig set ${Setting: settingName not found}=${Setting: value not found} will be run to populate your setting into the $SERVER_HOME_DIRECTORY.
  • $cfconfigfile - A cfconfig-compatible JSON file may be provided with this environment variable. The file will be loaded and applied to your server. If an adminPassword key exists, it will be applied as the Server and Web context passwords for Lucee engines