← Docs

Getting started

From a fresh workspace to your first connection is three steps: create a server, install its agent, then use it. The dashboard shows the same checklist until your first agent is online.

These steps happen inside the Subnomic console at app.subnomic.com.

1 · Add a server

A server is the unit you manage — a host you SSH into, a box that can reach a database, or a cluster. In the console, go to Servers → New server, give it a name, and create it. You land straight on its Agents tab with the install step ready.

2 · Install its agent

The agent is a small binary that makes one outbound connection to Subnomic (agent.subnomic.com) — no inbound ports. Pick the agent type, copy the install command and run it on the host. Within a few seconds the server's status turns online and the "no agent" banner clears.

  • Host — terminal + metrics + the tunnel for databases/apps. The usual choice for a server you also SSH into.
  • Tunnel — the tunnel only, no shell. Least privilege for reaching a database or internal app (including in-cluster).
  • Kubernetes — runs inside a cluster and proxies the API.
  • Docker — manages a Docker engine / Swarm.

See Agents for what each type does and how to install it.

3 · Use it

Everything lives on the server now — open the server and switch tabs:

  • Terminal — open an interactive shell (needs a host agent).
  • Sessions — replay or live-watch past terminal sessions.
  • Metrics — CPU / memory / disk / network.
  • Agents — install or manage the agents on this server.
  • Access — who may connect, and the require-approval gate.

To reach a database or internal app, register it under Databases / Internal apps and pick the host or tunnel agent that can reach it. For a cluster, register it under Kubernetes.