trqsh
Getting started3 min read

Dashboard

Use the dashboard to manage your account's resources. The local console/desktop agent runs the actual tunnels; the dashboard shows account-level information reported by the platform.

On this page

Open it through the website's Sign in link so you reach the dashboard configured for that deployment.

Sign in#

Production deployments use the configured OAuth providers. The local stack at http://localhost:3005 also exposes development email sign-in.

After sign-in, make sure you are in the intended account/organization. A hosted account and an account in your local Docker database are independent, even if they use the same email address.

Overview and tunnel history#

The overview shows your effective plan, usage and reported tunnel activity. The Tunnels page lists live tunnels and session history.

Tunnel sessions are reported by the edge. A stale or empty dashboard list is not the same as the local console's /ls: check both the agent and the edge/API connection when investigating missing activity.

The Control API's live tunnel listing is read-only. It does not remotely start your local application or provide a public tunnel-creation endpoint. Start/stop services through the console, desktop or local agent API.

API keys#

Under API keys, create a descriptive key for each computer or pipeline.

  1. Create the key.
  2. Copy the full value while it is shown.
  3. Store it securely on the intended agent.
  4. Verify the agent can authenticate.
  5. Revoke old or unused keys.

Later listings show a prefix, creation/usage metadata and revocation state. They cannot recover the original full key.

Domains#

The Domains page contains two resource types:

  • Reserved subdomains: a stable name under the deployment's base domain.
  • Custom domains: a hostname you own, with DNS ownership verification.

Reserving a name does not start a tunnel. Verifying a domain does not start your app or guarantee certificate readiness. Follow Reserved subdomains or Custom domains to finish the workflow.

Usage and plans#

The Usage page reads account traffic totals and time series. Totals are based on reported usage, so allow for reporting delay before comparing them to a local counter.

An active paid grant can have an expiration date. After expiry, the effective plan falls back to Free even if an older stored plan name existed. Check the effective plan/expiry rather than relying on an old screenshot.

The hosted website's upgrade flow uses its configured contact link. Optional Stripe API endpoints exist for operators who enable them; their presence in the API reference does not mean checkout is enabled on your deployment.

See Pricing for the displayed catalog.

Inspector availability#

The dashboard currently includes a cloud-inspector page, but its capture relay/archive is not implemented. For working HTTP captures and replay, use the local inspector on the agent computer or the desktop app.

A plan's history allowance alone does not upload your agent's captures or make the cloud view live.

Local stack URLs#

For the persistent trqsh-local Docker project:

Interface Address
Website/docs http://localhost:3004
Dashboard http://localhost:3005
Control API http://localhost:8081

A public-origin overlay may serve the dashboard under a path such as /dashboard. Use the links generated by that build; do not manually combine local ports with public base paths.

Common questions#

Can I create a tunnel from the browser alone? An agent must run on a computer that can reach the local service. The dashboard manages cloud resources; the desktop/console/local API manages that agent.

Why does browser login work but the CLI cannot connect? Device approval uses the HTTP Control API. Tunnel transport also needs the edge endpoint and port, normally 4443.

Why is a key valid on the website but invalid locally? The local Docker database issues its own keys. Set the agent's api_base and server to the same deployment.

Continue with Authentication or Troubleshooting.