initaldk / heroku-docker

Build, run and deploy Heroku apps with Docker

Heroku Docker CLI plugin

Heroku Toolbelt plugin to help configure, test and release apps to Heroku using Docker and Docker Compose.

Installation

$ heroku plugins:install heroku-docker

Use

See the Dev Center Documentation for details of use.

$ heroku help docker
Usage: heroku docker

  Use Docker to build and deploy Heroku apps

Additional commands, type "heroku help COMMAND" for more details:

  docker:init     #  create Dockerfile and docker-compose.yml
  docker:release  #  create and release slug to app

For help with a particular command:

$ heroku help docker:init
Usage: heroku docker:init

   -i, --image IMAGE   # the Docker image from which to inherit
   -f, --force         # overwrite existing Dockerfile and docker-compose.yml

  Creates a Dockerfile and docker-compose.yml for the app specified in app.json

Developing and contributing

Checkout the plugin source code and tell the Heroku CLI to use your local version of the plugin (instead of the default one distributed with NPM).

$ git clone https://github.com/heroku/heroku-docker.git
$ cd heroku-docker
$ git checkout compose
$ npm install
$ heroku plugins:link .

Add-ons

The mapping from Heroku add-on specified in app.json to container configured in docker-composer.yml is tracked in lib\app.json. The mapping currently includes a limited subset of add-ons that we have tested. We welcome additions in the form of PRs.