• DockerHook
  • Get started
  • Environment Variables
    • CONFIG_PATH
  • WebHook
    • Url
    • Query Parameters
      • action
    • version
      • token
  • Config Properties
    • config
      • labelBased
      • defaultAction
    • auth
      • enable
      • tokensFile
      • tokens
      • groups
  • Examples

DockerHook

DockerHook is a way to manage your Docker processes using a Webhook!

Get started

Getting started with DockerHook is very easy, you simply need a Docker container and no additional configuration is required to get started.

services:
  dockerHook:
    image: waxer59/dockerhook
    container_name: dockerHook
    ports:
      - "<desired-port>:8080"
    restart: always
    volumes:
      -  /var/run/docker.sock:/var/run/docker.sock

Environment Variables

DockerHook uses the environment variables to allow you to customize the parameters

CONFIG_PATH

• Type: string
• Default: /etc/dockerhook/dockerhook.yml

Specify the path where your configuration file is located

WebHook

A webhook is an HTTP-based callback function, DockerHook accepts GET and POST requests to perform all actions.

Url

This is the shape that the URL must have.

http://exampleurl.com/<docker-service-name>?<query-parameters>

Query Parameters

action

• Type: 'start' | 'stop' | 'restart' | 'pull'
• Default: 'pull'

Specify the action to be done in the service

version

• Type: string
• Default: latest

Specify the version of the image to be pulled

Note

This parameter works only when the “pull” action is used.

token

• Type: string

Specify the access token to control Webhook execution.

Specifies the access token to control the execution of the Webhook if the enable property of auth is set to true.

Config Properties

Configuration properties allow you to mold DockerHook to your needs!

The DockerHook configuration file must have the extension .yml and it looks like this:

config:
  labelBased: true
  # ...

auth:
  tokens:
    - token1
    - token2
  # ...

config

labelBased

• Type: boolean
• Default: false

By default, DockerHook will have access to all containers, you can prevent this behavior by setting this property to true and adding the dockerhook.enable=true tag in the containers where you want DockerHook to have access.

defaultAction

• Type: 'start' | 'stop' | 'restart' | 'pull'
• Default: 'pull'

Defines the default action to be performed when the Webhook is called without any action in the query parameters

auth

enable

• Type: boolean
• Default false

By default, DockerHook allows access to all, set this option to true if you want to set up a token access system.

tokensFile

• Type: string

Specify the path to the file where you will store your access tokens, these must be separated by line breaks, see example below and the file must be a text file:

token1
token2

Note

In case tokensFile and tokens are filled both tokens will be merged.

tokens

• Type: []string

Specify your access tokens

Note

In case tokensFile and tokens are filled both tokens will be merged.

groups

• Type: []string

Groups allow you to restrict access to the token, such as allowing it to only be able to start your services.

To create a group it must have the following format: <groupName>:<actions-splitted-by-commas>

Look at the following examples of how a group would be created:

auth:
  groups:
    - onlyStart:start
    - startAndPull:start,pull

Now in order to use this group you have created you will have to create the token as follows: <groupName>:<token>

Caution

In case no group name is specified, the access that this token will have will be full.

See the following example to learn how to use groups and tokens together:

auth:
  groups:
    - onlyStart:start
    - startAndPull:start,pull
  tokens:
    - onlyStart:tok3n
    - startAndPull:tekken

Important

The token to be sent to the Webhook must be the token without the group name specification, i.e. this token onlyStart:tok3n should be sent to the Webhook as tok3n.

Examples

Check the following examples:

• Example configuration
• Example docker compose