docker-webhook
docker-webhook copied to clipboard
TheCatLady
A lightweight, minimal webhook container ⚓
webhook ⚓
A lightweight, minimal webhook container
Usage
Docker images are available from both GitHub Container Registry (GHCR) and Docker Hub.
If you would prefer to pull from GHCR, simply replace thecatlady/webhook with ghcr.io/thecatlady/webhook in the examples below.
Docker Compose (recommended)
Add the following volume and service definitions to a docker-compose.yml file:
services:
webhook:
image: thecatlady/webhook
container_name: webhook
command: -verbose -hooks=hooks.yml -hotreload
environment:
- TZ=America/New_York #optional
volumes:
- /path/to/appdata/config:/config:ro
ports:
- 9000:9000
restart: always
Then, run the following command from the directory containing your docker-compose.yml file:
docker-compose up -d
Docker CLI
Run the following command to create the container:
docker run -d \
--name=webhook \
-e TZ=America/New_York `#optional` \
-v /path/to/appdata/config:/config:ro \
-p 9000:9000 \
--restart always \
thecatlady/webhook \
-verbose -hooks=hooks.yml -hotreload
Updating
The process to update the container when a new image is available is dependent on how you set it up initially.
Docker Compose
Run the following commands from the directory containing your docker-compose.yml file:
docker-compose pull webhook
docker-compose up -d
docker image prune
Docker CLI
Run the commands below, followed by your original docker run command:
docker stop webhook
docker rm webhook
docker pull thecatlady/webhook
docker image prune
Parameters
The container image is configured using the following parameters passed at runtime:
| Parameter | Function |
|---|---|
-e TZ= |
TZ database name of system time zone; e.g., America/New_York |
-v /path/to/appdata/config:/config:ro |
Container data directory (mounted as read-only); your JSON/YAML hook definition file should be placed in this folder (Replace /path/to/appdata/config with the desired path on your host) |
-p 9000:9000 |
Expose port 9000(Necessary unless only accessing webhook via other containers in the same Docker network) |
--restart |
Container restart policy ( always or unless-stopped recommended) |
-verbose -hooks=/config/hooks.yml -hotreload |
webhook parameters; replace hooks.yml with the name of your JSON/YAML hook definition file, and add/modify/remove arguments to suit your needs(Can omit if using this exact configuration; otherwise, all parameters must be specified, not just those modified) |
Configuring Hooks
See adnanh/webhook for documentation on how to define hooks.
How to Contribute
Show your support by starring this project! 🌟 Pull requests, bug reports, and feature requests are also welcome!
You can also support me by becoming a GitHub sponsor or making a one-time donation 💖
TheCatLady