Quickstart

Discover how to use WebRelay in 5 minutes

Webrelay allows you to connect your apps running anywhere in the world, without having to worry about access, firewalls and NATs. You can use webrelay for a variety of use cases, such as connecting services running on different machines for development or testing or exposing a service running on your local machine to the internet

Getting Started

Get started by downloading the Webrelay Binary for your platform

Open a terminal window and run the following command, append your platform identifier to the end of the URL

curl -LO https://dl.webrelay.dev/mac/x64/webrelay && chmod +x webrelay

or

curl -LO https://dl.webrelay.dev/mac/arm/webrelay && chmod +x webrelay

or

curl -LO https://dl.webrelay.dev/linux/x64/webrelay && chmod +x webrelay

Add the Binary to your PATH

This is an optional step, but it will make it easier to run the webrelay command in the future. if you don't add the binary to your path, you can run the binary from anywhere by using the path to the executable eg: ./webrelay

mv webrelay /usr/local/bin

Login

Webrelay isolates networks based on your email ID

Start by logging in with your preferred email ID

webrelay login <your-email-id>

Head over to Concepts or Examples to see what you can do with Webrelay