alpine-webhook: A Makefile repository from WOAHBase

Alpine-Webhook

Container for Alpine Linux + Webhook Server

This image containerizes the prebuilt static Webhook server by HookDoo, used to serve incoming webhooks with custom actions/scripts.

Auto updated according to the Github stable releases.

Based on Alpine Linux from my alpine-glibc image with the s6 init system overlayed in it.

The image is tagged respectively for the following architectures,

armhf
armv7l
aarch64
x86_64 (retagged as the latest )

non-x86_64 builds have embedded binfmt_misc support and contain the qemu-user-static binary that allows for running it also inside an x86_64 environment that has it.

Get the Image

Pull the image for your architecture it's already available from Docker Hub.

# make pull
docker pull woahbase/alpine-webhook:x86_64

Run

If you want to run images for other architectures, you will need to have binfmt support configured for your machine. multiarch, has made it easy for us containing that into a docker container.

# make regbinfmt
docker run --rm --privileged multiarch/qemu-user-static:register --reset

Without the above, you can still run the image that is made for your architecture, e.g for an x86_64 machine..

This image already has a user alpine configured to drop privileges to the passed PUID/PGID which is ideal if its used to run in non-root mode. That way you only need to specify the values at runtime and pass the -u alpine if need be. (run id in your terminal to see your own PUID/PGID values.)

Before you run..

Default hooks dir is /etc/webhook/.
config is loaded from /etc/webhook/hooks.json, a simple default is provided, edit this file or mount your own. The location of the the file can be customized by setting the variable HOOKSJSON.
To fetch the hooks.json file from a url before start, pass it in the env variable HOOKSURL.
For custom runtime parametes, pass them in the environment variable HOOKPARAMS. (check the defaults in the makefile)
Checkout the docs for more information about writing hooks.
Webhook runs under the user alpine.

Running make starts the service.

# make
docker run --rm -it \
  --name docker_webhook --hostname webhook \
  -e PGID=1000 -e PUID=1000 \
  -p 9000:9000 \
  -e HOOKPARAMS="-verbose -ip 0.0.0.0" \
  -v config/hooks.json:/etc/webhook/hooks.json \
  woahbase/alpine-webhook:x86_64

Stop the container with a timeout, (defaults to 2 seconds)

# make stop
docker stop -t 2 docker_webhook

Removes the container, (always better to stop it first and -f only when needed most)

# make rm
docker rm -f docker_webhook

Restart the container with

# make restart
docker restart docker_webhook

Shell access

Get a shell inside a already running container,

# make debug
docker exec -it docker_webhook /bin/bash

set user or login as root,

# make rdebug
docker exec -u root -it docker_webhook /bin/bash

To check logs of a running container in real time

# make logs
docker logs -f docker_webhook

Development

If you have the repository access, you can clone and build the image yourself for your own system, and can push after.

Setup

Before you clone the repo, you must have Git, GNU make, and Docker setup on the machine.

git clone https://github.com/woahbase/alpine-webhook
cd alpine-webhook

You can always skip installing make but you will have to type the whole docker commands then instead of using the sweet make targets.

Build

You need to have binfmt_misc configured in your system to be able to build images for other architectures.

Otherwise to locally build the image for your system. [ARCH defaults to x86_64, need to be explicit when building for other architectures.]

# make ARCH=x86_64 build
# sets up binfmt if not x86_64
docker build --rm --compress --force-rm \
  --no-cache=true --pull \
  -f ./Dockerfile_x86_64 \
  --build-arg DOCKERSRC=woahbase/alpine-glibc:x86_64 \
  --build-arg PGID=1000 \
  --build-arg PUID=1000 \
  -t woahbase/alpine-webhook:x86_64 \
  .

To check if its working..

# make ARCH=x86_64 test
docker run --rm -it \
  --name docker_webhook --hostname webhook \
  -e PGID=1000 -e PUID=1000 \
  woahbase/alpine-webhook:x86_64 \
  sh -ec 'sleep 5; webhook -version'

And finally, if you have push access,

# make ARCH=x86_64 push
docker push woahbase/alpine-webhook:x86_64

Maintenance

Sources at Github. Built at Travis-CI.org (armhf / x64 builds). Images at Docker hub. Metadata at Microbadger.

Maintained by WOAHBase.