Get started

Create a tunnel and save its key

Choose a tunnel name, save the connection key that is shown only once, and fill in your app’s port.

What you need before you start

#

You need to belong to a workspace. Open its Tunnels page. If you belong to more than one workspace, switch to the right one first.

Create a tunnel

#
  1. On Tunnels, choose Create tunnel.
  2. Enter a Name, for example aspire-quickstart. Wait for Name available: names are unique across the whole Groundhog service, not just your workspace.
  3. Check the Address preview. This is the HTTPS address you will open once your computer is connected.
  4. Choose Create tunnel.
The Create tunnel form with sample data. Your tunnel’s address ends in groundhog.unifinity.com.

Choose the local port

#

The command the dashboard shows uses --port 3000 as an example. Enter the port your app listens on instead: for http://localhost:5173, use --port 5173.

Using Aspire? You don’t need a port. Aspire finds the app’s endpoint itself.

Save the connection key

#

After you create the tunnel, Groundhog shows its Connection key. The key lets a client connect this tunnel. It is not your sign-in password.

  1. Choose Copy key and save the key in your password manager, or paste it straight into Aspire while the page is open.
  2. Note the tunnel’s name and Tunnel address.
  3. Select I saved my connection key, then choose Done.

If you lose the key

#

Open the tunnel and choose More actions → Rotate key. The new key replaces the old one at once, so update every client that used it. See Rotate or revoke a key.

Connect your computer

#

A new tunnel waits for your computer. Creating it does not start forwarding. Continue with one of these:

Guides checked against Groundhog client 0.4.0-preview.7.Groundhog is open source under the MIT licence.