UnderpassDocs

Getting started

Quickstart

Create an account and connect your first two devices in a few minutes.

View as Markdown

By the end of this page, two of your devices will be in one private network and able to reach each other by name.

1. Create an account

Go to app.getunderpass.com and sign in with Google or with a one-time code sent to your email. Your workspace, your own private network, is created right away. It's free for up to 6 people and 100 devices.

2. Install on your first device

  • Windows: download and run the installer from getunderpass.com/download.

  • macOS or Linux: run

    bash
    curl -fsSL https://coord.getunderpass.com/download/install.sh | sh

A link opens, or is printed in the terminal. Sign in with the same account. See Install for details.

3. Install on a second device

Do the same on another computer, server or Raspberry Pi, and sign in with the same account. For a server you can't open a browser on, use an auth key instead.

4. Check they can see each other

On either device:

bash
underpass status

You'll see the other device listed, with its address, its name and how it's connected:

text
100.64.0.7  laptop.underpass.internal  connected  (https://coord.getunderpass.com)

ADDRESS      NAME     OS       PATH                     LATENCY  HANDSHAKE  ROUTES
100.64.0.21  db-prod  linux    direct 203.0.113.7:41642  11.2 ms  4s ago     -

5. Connect

Use the other device's name anywhere you'd use an address:

bash
ping db-prod
ssh you@db-prod

Or open a web app running on it, like http://db-prod:3000.

Next