Docker Compose

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.

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

Forward webhooks

  1. Go to https://my.webhookrelay.com/buckets and create a bucket (we will call it “my-bucket“ in this example)

  2. Configure output destination (another container or IP address where you want to forward)

  3. Create a docker-compose.yml file:

    version: '3.2'
    services:
     relay:
       container_name: webhookrelay
       image: webhookrelay/webhookrelayd:latest
       network_mode: host # required if you want to access other services running on localhost (otherwise localhost would be inside this container)
       restart: always
       environment:
         # Authentication
         - RELAY_KEY=${RELAY_KEY}
         - RELAY_SECRET=${RELAY_SECRET}
         # buckets list to subscribe
         - BUCKETS=${BUCKETS}
    
  4. Create .env file:

    
    RELAY_KEY="your-access-token-key"
    RELAY_SECRET="your-access-token-secret"
    BUCKETS=my-bucket
  5. Start Docker Compose:

    docker-compose up -d

Open a tunnel

  1. Go to https://my.webhookrelay.com/tunnels and create a tunnel with your desired destination
  2. Create a docker-compose.yml file:
version: '3.2'

services:
  relay:
    container_name: webhookrelay
    image: webhookrelay/webhookrelayd:latest
    network_mode: host      
    command:
      - --mode 
      - tunnel
    restart: always
    environment:
      # Authentication
      - RELAY_KEY=${RELAY_KEY}
      - RELAY_SECRET=${RELAY_SECRET}
      # One or more tunnels must be set in the .env file
      - TUNNELS=${TUNNELS}        
  1. Create .env file:

RELAY_KEY="your-access-token-key"
RELAY_SECRET="your-access-token-secret"
TUNNELS=your-tunnel
  1. Start Docker Compose:
docker-compose up -d