Docker

Webhookrelayd agent can either forward requests to destinations or open bidirectional tunnels. It is a single Docker image that requires access key and secrets for authentication. This image can be used either in a single machine or in cluster schedulers such as Kubernetes.

If you don't have Docker installed, we highly recommend checking resources available on https://www.docker.com/.

Create your secret token pair

Visit https://my.webhookrelay.com/tokens and create a new token pair. Copy the section for environment variable setup:

export RELAY_KEY=<token key>
export RELAY_SECRET=<token secret>

Forward webhooks

1. Go to https://my.webhookrelay.com/buckets and create a bucket
2. Configure output destination (another container or IP address where you want to forward)
3. Start a webhookrelayd agent:

docker run --net host \
  --restart always -d \
  webhookrelay/webhookrelayd:latest -k $RELAY_KEY -s $RELAY_SECRET -b mybucketname

Environment variables

You can also specify configuration through environment variables:

RELAY_KEY=<token key>
RELAY_SECRET=<token secret>
BUCKET=<bucket filter>

If you are using self-signed certificates on your internal side, specify INSECURE environment variable to skip validation:

INSECURE=true

Exposing website

1. Go to https://my.webhookrelay.com/tunnels and create a tunnel with your desired destination
2. Start the container that will expose your website:

docker run \
  --net host \
  --restart always \
  -d webhookrelay/webhookrelayd:latest \
  --mode tunnel -t mytunnelname -k $RELAY_KEY -s $RELAY_SECRET

Environment variables

You can also specify these details through environment variables:

RELAY_KEY=<token key>
RELAY_SECRET=<token secret>
TUNNELS=<comma separated list of tunnels>
REGION=<region - eu, au, us-west (defaults to eu)>