Relay & sharing

Add your own relay

Register a relay service or configure a device-owned route using the controls appropriate to your connection.

3 min read User guide

Prepare the service first

Obtain a version-compatible endpoint, enrollment details and client credential from the relay operator. Use the installation instructions bundled with that release's official relay kit. Adding an address to LeapTerm does not deploy a relay, enroll an agent or authorize a destination.

The app has two different configuration surfaces. Registering a service in the relay list is not the same as configuring a device-owned, client-to-agent connection.

Register a relay service

Where relay management is enabled, open Proxies & Tunnels → Relays and choose Register Relay Server. Enter Relay Name, Relay URL (host:port) and the client token required by your operator, then choose Register.

The form calls the token optional because not every configuration uses that field. This does not override a service that requires authentication. Never enter an operator-only management credential. The official LeapTerm relay cannot be edited or deleted in this list.

Enroll an installed agent

For a supported Linux or macOS SSH server, first install the correct agent release. Open Omni Agent and choose Enroll Relay when offered. A system installation requires administrator access.

For an agent installed through Homebrew or another package manager, follow that release's enrollment and service instructions; service activation can differ from this native managed workflow.

  1. In API origin, enter the operator's trusted HTTPS service URL without a path.
  2. Enter the Pairing token issued for this server from the intended signed-in account. It is a single-use credential; keep it private.
  3. Enter the Client OpenSSH public key of the device that will connect, then choose Enroll Relay. Copy the public key only; keep its private key on that device.
  4. Check the enrollment result and Check Service, then test the intended relay connection.

Enrollment uses the installed native leap-agent join command and attempts activation of its managed service. If service activation fails after enrollment is stored, use the operator's supported service recovery process and recheck the result. Relay registration, local credential-storage unlock and destination or recipient approval remain separate steps.

Configure a device-owned route

For an eligible native SSH profile with sign-in and relay management enabled, open Network & Proxy and choose Configure device-owned WebRTC / WebSocket relay. This opens Device-owned relay; it is not offered for browser profiles or account-issued managed targets.

  1. Obtain the enrolled agent, owner and target details through the operator's trusted setup process.
  2. Verify the full agent and target SSH fingerprints independently.
  3. Store the relay token and client private key in the credential store first. Enter their secure-store references, not the secret values, in this dialog.
  4. Select Transport for new connections and review the optional customer-owned TURN and public STUN settings.
  5. Choose Apply to profile, save the host, and test a new authenticated connection.

Changes apply to new connections, not an already running session. Remove; use direct network removes this profile's device-owned route; it does not shut down the relay service.

For a supported installed Protected workspace, use its trusted customer-agent and local-device enrollment instead. A relay-list registration or an ordinary Gateway URL does not approve either identity. Follow the protected browser connection steps.

Verify the actual workflow

A reachable endpoint is not proof that an agent is online or that destination authentication works. Test a terminal, then the specific file or forwarding operation you need. A relay kit does not automatically supply a cloud workspace or sharing service.

Keep credentials out of screenshots and shared URLs. Do not disable certificate checks. A restart can interrupt active sessions; a token change does not by itself prove every existing connection has stopped. Use explicit termination controls and confirm the result when urgently removing access.

See transport selection and troubleshooting for distinguishing reachability, authentication and capability failures.

Features vary by release, platform and connection route. Check availability before planning your setup.

Search the guides

Search runs in your browser.

Your search stays here. No account or external search service.