Skip to main content

Relay

Two tiers: Standalone (default, zero config, local only) and Relay mode (opt-in remote access via SSH gateway).

Setup

Register your node with a relay to enable remote access.

Remote Commands

All commands accept an optional node prefix for remote access.

Direct WebSocket

Connect directly via WebSocket without a relay.

Running a Relay Server

The relay server provides:
  • HTTPS on port 443 — client API connections
  • SSH on port 2222 — SSH into any registered node
  • WebSocket at /node/connect — nodes connect here (outbound from node)
  • KV API at /api/v1/kv/* — shared key-value store

Relay Topology

Nodes establish persistent outbound WebSocket connections to a relay server — no root required, works behind NAT.

Connection Flow

  1. Node registers with relay (invite or token)
  2. Node opens persistent outbound WebSocket to relay
  3. Client SSHs into relay: ssh dev-1@relay:2222
  4. Relay signals node via WebSocket, node dials back
  5. Relay bridges SSH channel to node’s bash PTY

Node & Server Management