mermaid

Automatically deploy Docker Images to Heroku from Dockerhub. When new images are pushed to Dockerhub, mermaid is notified and deploys these images on Heroku. One mermaid instance can be configured to receive webhooks from multiple dockerhub repositories, and to deploy to several heroku applications.

Usage

1. Setup Docker Remote API

Install Docker on a machine that the instance of mermaid can access over HTTP. Configure docker to listen on an external port so that the Docker Remote API can be accessed from the mermaid instance. The port 4550 is used as the default in the documentation examples.

Add -H tcp://0.0.0.0:4550 to DOCKER_OPTS.

Ubuntu/Debian

# /lib/systemd/system/docker.service

ExecStart=/usr/bin/dockerd -H fd:// -H tcp://0.0.0.0:4550 $DOCKER_OPTS 

Other distros?

Contributions welcome!

2. Setup Dockerhub Webhook

Once mermaid is deployed, configure a dockerhub webhook to notify it when new images are pushed.

3. Configure mermaid

Deploy Mapping

// config/docker.js
module.exports = {
  // ...
  tags: [
    /**
     * Deploy 'langa/my-image' docker repo as 'langa/my-image-development' when a new image
     * tagged with "latest" is pushed.
     */
    {
      image: 'langa/my-image',
      deployImage: 'langa/my-image-development',
      tag: /^latest$/
    },
    
    /**
     * Deploy 'langa/my-image' docker repo as 'langa/my-image-production' when a new image
     * tagged with a version number (e.g. v1.0.0) is pushed.
     */
    {
      image: 'langa/my-image',
      deployImage: 'langa/my-image-production',
      tag: /^v([0-9.]+)$/
    }
  ]
}

Repository Credentials

Set the following environment variables.

variable	description	required
DOCKER_ENGINE_VERSION	version of docker remote api	no
DOCKER_ENGINE_HOST	host of docker remote api	yes
DOCKER_ENGINE_PORT	port of docker remote api	yes
DOCKER_SOURCE_AUTH_USERNAME	username for source docker registry	yes
DOCKER_SOURCE_AUTH_PASSWORD	password for source docker registry	yes
DOCKER_SOURCE_AUTH_SERVER	source docker registry url	yes
DOCKER_TARGET_AUTH_USERNAME	username for target docker registry	yes
DOCKER_TARGET_AUTH_PASSWORD	password for target docker registry	yes
DOCKER_TARGET_AUTH_SERVER	target/deploy docker registry url	yes

License

MIT

Maintained By