Dockhero CLI plugin

Companion CLI plugin to work with Dockhero Heroku addon

Installation

heroku plugins:install dockhero

Usage

The plugin provides wrappers around docker and docker-compose commands.

 heroku dh:docker  <command> #  wrapper around docker command
 heroku dh:compose <command> #  wrapper around docker-compose command

Please see official Docker guide to find out the full list of available commands

Docker will be configured to work with Dockhero Swarm cluster. docker-compose will also receive these additional arguments:

  --file dockhero-compose.yml  -  to adjust the name of the stackfile
  --project-name dockhero  -  to make docker-compose project name independent from the current directory

The plugin also provides these helper commands:

  dh:env      #  downloads TSL certificates prints out the environment variables to work with Dockhero Swarm
  dh:sh       #  run local shell with environment configured for Dockhero Swarm
  dh:ssh      #  SSH to the Docker machine
  dh:open     #  opens your Dockhero stack in the browser
  dh:wait     #  waits while the provisioning is in progress
  dh:generate #  installs the pre-defined stack - try "helloworld" as an example

Example usage

Generate example stackfile with heroku dh:install. You can find more stackfile examples here

The commands below require that your Dockhero addon provisioning is done. If it is still in progress, you can wait for it to finish with heroku dh:wait or track provisioning progress in Heroku addon dashboard - heroku addons:open dockhero

First you can test the stack by running it in foreground:

heroku dh:compose up

If everything works fine, stop the stack by pressing Ctrl-C and run it in production:

heroku dh:compose start

To check which processes are currently running, use either of these two commands:

heroku dh:compose ps
heroku dh:docker ps

Variables Substitution

docker-compose supports Envrironment Variables Substitution like this:

web:
  environment:
    - FOO="${FOO}"

Dockhero CLI plugin changes the rules of variable resolution to the following:

1. Your shell ENV has top priority, e.g. env FOO=bar heroku dh:compose up
2. Your Heroku app's variables have the next priority, e.g. heroku config:set FOO=bar; heroku dh:compose up
3. The variables from your .env file have the least priority

Dockhero CLI plugin makes the following enviroment variables available to the app:

<TODO: >