CLI Installation

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.

Download & Install

Linux users

Simply download one of the binaries for your system:

# Linux x86-64 (64-bit)
sudo wget -O /usr/local/bin/relay https://storage.googleapis.com/webhookrelay/downloads/relay-linux-amd64
# Linux x86 (32-bit)
sudo wget -O /usr/local/bin/relay https://storage.googleapis.com/webhookrelay/downloads/relay-linux-386
# Linux aarch (64-bit)
sudo wget -O /usr/local/bin/relay https://storage.googleapis.com/webhookrelay/downloads/relay-linux-aarch64
# Linux arm
sudo wget -O /usr/local/bin/relay https://storage.googleapis.com/webhookrelay/downloads/relay-linux-arm

Give it permissions to execute and update itself:

sudo chmod +wx /usr/local/bin/relay

MacOS users

sudo curl --output /usr/local/bin/relay https://storage.googleapis.com/webhookrelay/downloads/relay-darwin-amd64

Give it permissions to execute and update itself:

sudo chmod +wx /usr/local/bin/relay

Or using brew package manager:

brew install webhookrelay/tap/relay

Windows

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

If you are using a 32-bit OS, use this link: https://storage.cloud.google.com/webhookrelay/downloads/relay-windows-386.exe.

Or if you have curl installed, use this command:

curl -LO https://storage.googleapis.com/webhookrelay/downloads/relay-windows-amd64.exe

Powershell users can do:

Invoke-WebRequest -Uri "https://storage.googleapis.com/webhookrelay/downloads/relay-windows-amd64.exe" -OutFile ".\relay-windows-amd64.exe" -UseBasicParsing

Then, add the binary in to your PATH.

FreeBSD

Download the binary:

# For amd64
sudo fetch -o /usr/local/bin/relay https://storage.cloud.google.com/webhookrelay/downloads/relay-freebsd-amd64
# For i386
sudo fetch -o /usr/local/bin/relay https://storage.cloud.google.com/webhookrelay/downloads/relay-freebsd-386

Give it permissions to execute and update itself:

sudo chmod +wx /usr/local/bin/relay

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

And then 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