Installation

Compatibility Note

Relay agent runs on Linux, Windows and MacOS distributions. If you require support for a different architecture, please contact support at [email protected].

Web Relay Tools

When using Web Relay, we first recommend registering an account on webhookrelay in order to generate access tokens. This will allow you to easily authenticate CLI or our Docker container.

There are several supported tools, please choose what best suits your needs:

Registration & Authentication

In order to start using the service, you will need to create an account. If you already have an account, skip this section. Head to the registration page https://my.webhookrelay.com/register and register:

CREATE ACCOUNTfree plan available, no credit card required

Relay CLI needs credentials for your account. Once registered, generate a token and use token key and secret as a username and password for CLI authentication:

Create Token

Once you have CLI downloaded, use it:

relay login -k token-key-here -s token-secret-here

Another option is to set environment variables:

export RELAY_KEY=token-key
export RELAY_SECRET=token-secret

Install CLI

Web Relay provides an official command client for quick configuration of webhook forwarding, tunnels and can also provision authentication tokens. It provides batteries-included agent for developing and testing workflows. It takes only a few seconds for it to start running with one-way HTTP request forwarding, bidirectional tunnels, and CLI for managing your resources.

The CLI assumes that it can access https://my.webhookrelay.com and https://api.webhookrelay.com endpoints. If you are behind a proxy - set HTTP_PROXY environment variable.

Linux

curl -sSL https://storage.googleapis.com/webhookrelay/downloads/relay-linux-amd64 > relay && chmod +wx relay && sudo mv relay /usr/local/bin

MacOS

Mac users can install client through homebrew:

brew install webhookrelay/tap/relay

Or:

curl -sSL https://storage.googleapis.com/webhookrelay/downloads/relay-darwin-amd64 > relay && chmod +wx relay && sudo mv relay /usr/local/bin

Windows

  1. You can download the latest release from the link below:
    https://storage.googleapis.com/webhookrelay/downloads/relay-windows-amd64.exe.

    Or if you have curl installed, use this command:

    curl -LO https://storage.googleapis.com/webhookrelay/downloads/relay-windows-amd64.exe
  2. Add the binary in to your PATH.

Binary Executables

You can download binaries from here. These are self contained applications, no dependencies required.


Linux Versionamd 64bit
Windows Versionamd 64bit
MacOS Versionamd 64bit

Using with 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/.

To start a webhookrelayd agent:

docker run -it webhookrelay/webhookrelayd -k [access key] -s [access secret]

Using with Kubernetes

Webhookrelayd agent can be easily deployed as a sidecar.
This way requests can be forwarded to the service through localhost:

---
apiVersion: extensions/v1beta1
kind: Deployment
metadata:
name: wd
namespace: default
labels:
name: "wd"
spec:
replicas: 1
template:
metadata:
name: wd
labels:
app: wd
spec:
containers:
- image: karolisr/webhook-demo:0.0.15
imagePullPolicy: Always
name: wd
command: ["/bin/webhook-demo"]
ports:
- containerPort: 8090
livenessProbe:
httpGet:
path: /healthz
port: 8090
initialDelaySeconds: 30
timeoutSeconds: 10
securityContext:
privileged: true
# [START webhookrelay_container]
- image: webhookrelay/webhookrelayd:latest
name: webhookrelayd
command: ["/webhookrelayd"]
env:
- name: KEY
valueFrom:
secretKeyRef:
name: webhookrelay-credentials
key: key
- name: SECRET
valueFrom:
secretKeyRef:
name: webhookrelay-credentials
key: secret
- name: BUCKET
value: webhook-demo
# [END webhookrelay_container]

If agent is deployed as a separate deployment, the output destination should then be a service name.
Repository can be found here: https://github.com/webhookrelay/webhook-demo.

If you are using Kubernetes, you should also check out ingress controller.

Terms