Quick start
Add a tunnel, which is one VPN endpoint for TunnelHQ to check, run a live test, and read the first result. It takes about five minutes, and you don’t need the API or the CLI.
Add your first tunnel
Section titled “Add your first tunnel”-
Open Tunnels and click Add tunnel.
In the dashboard, go to Tunnels in the left sidebar and click Add tunnel in the top right. On mobile, the button is in the header. The dialog opens on its One tunnel tab. The Bulk import tab beside it adds many at once; see Import tunnels.
-
Paste a config, or enter the details by hand.
The fastest way is to paste a config or share link into the box at the top. TunnelHQ detects the protocol and fills in the fields. To type the details instead, click Enter details manually, choose a protocol, and fill in the host, port, and any credentials. VPN protocols lists the fields for each protocol.
-
Choose where to test from (optional).
A tunnel tests from Any location by default, and TunnelHQ picks a checker for you. On Pro and Business, the Test from region field adds one specific location, where the first check runs. The tunnel is saved with Any plus that location. To add more locations, use the tunnel’s Locations panel after saving. See Locations and status.
-
Save.
The tunnel shows Pending until its first check finishes. If the check passes, it shows Healthy, with a latency reading. If it fails, the tunnel shows Unknown while it retries, and Down if the next check fails too.
A new tunnel is checked every 3 minutes, or at your plan’s fastest interval if that’s longer (Free: every 10 minutes). You can change the test interval in the tunnel’s settings.
From then on, TunnelHQ checks the tunnel on your schedule, records every heartbeat, and opens an incident when it starts failing.
Run an on-demand test
Section titled “Run an on-demand test”To check a tunnel without waiting for the schedule, open it and click Run now. On the Dashboard, Run visible tests re-checks every monitor currently in view.
On-demand tests don’t affect scheduled checks. They count separately against your plan’s test quota.