https://github.com/waxer59/dockerhook
DockerHook is a way to manage your Docker processes using a Webhook!
https://github.com/waxer59/dockerhook
docker golang webhook
Last synced: 3 months ago
JSON representation
DockerHook is a way to manage your Docker processes using a Webhook!
- Host: GitHub
- URL: https://github.com/waxer59/dockerhook
- Owner: Waxer59
- License: mit
- Created: 2024-01-30T03:02:50.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-09-10T02:53:18.000Z (9 months ago)
- Last Synced: 2025-01-16T05:29:40.074Z (5 months ago)
- Topics: docker, golang, webhook
- Language: Go
- Homepage: https://hub.docker.com/r/waxer59/dockerhook
- Size: 139 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
- [DockerHook](#dockerhook)
- [Get started](#get-started)
- [Environment Variables](#environment-variables)
- [`CONFIG_PATH`](#config_path)
- [WebHook](#webhook)
- [Url](#url)
- [Query Parameters](#query-parameters)
- [`action`](#action)
- [`version`](#version)
- [`token`](#token)
- [Config Properties](#config-properties)
- [`config`](#config)
- [`labelBased`](#labelbased)
- [`defaultAction`](#defaultaction)
- [`auth`](#auth)
- [`enable`](#enable)
- [`tokensFile`](#tokensfile)
- [`tokens`](#tokens)
- [`groups`](#groups)
- [Examples](#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.
```yaml
services:
dockerHook:
image: waxer59/dockerhook
container_name: dockerHook
ports:
- ":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/?`
### 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`](#enable) property of [`auth`](#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:
```yaml
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`](#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:
```txt
token1
token2
```
> [!NOTE]
> In case [`tokensFile`](#tokensfile) and [`tokens`](#tokens) are filled both tokens will be merged.
#### `tokens`
* **Type**: `[]string`
Specify your access tokens
> [!NOTE]
> In case [`tokensFile`](#tokensfile) and [`tokens`](#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: `:`
Look at the following examples of how a group would be created:
```yaml
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: `:`
> [!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:
```yaml
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](./docs/examples/exampleConfig.yml)
* [Example docker compose](./docs/examples/docker-compose.yml)