Files
peardata/user-guide/connect.md
T
Raven Scott 3fc0245b32
CI / test (push) Successful in 1m3s
Release rolling / release (push) Has been cancelled
Updates
2026-07-18 23:47:54 -04:00

37 lines
1.4 KiB
Markdown

# Connect
## Ways to connect
| Method | Role | How |
|--------|------|-----|
| **64-hex public key** | Viewer | Paste on **Connect** → Connect |
| **`pd1.` invite** | Granted role (viewer / operator / admin) | Mint with `npm run mint-invite -- <role>` on the agent host |
| **Admin seed** | Admin | Paste `SERVER_SEED` from the agent `.env` (optional field on Connect) |
Optional **alias** (e.g. `homelab-1`) labels the host in Fleet and the titlebar chip.
## First connection checklist
1. Agent is running (`npm run start:server` or systemd).
2. Note the printed **publicKey**.
3. Open the desktop (`npm start`).
4. **Connect** → paste key or invite → Connect.
5. Titlebar shows the active peer; Overview and Charts start filling.
## Switching agents
- **Fleet** → **Set active** on a live card, or **Reconnect** / **Charts** on a saved card.
- Overview fleet strip can also set active when multi-host is listed.
- Only the **active** agent feeds the Charts wall and Overview sparks.
## Offline / reconnect
Saved agents retry dial automatically (see Settings → max reconnect attempts).
Failed peers show in Fleet as **Failed**; use **Reconnect** or **Forget**.
## Security notes
- Viewer dials are read-only (metrics subscribe / query).
- Invites and admin seed are secrets — treat like passwords.
- REST binds to `127.0.0.1:18888` by default; do not expose without a reverse proxy and auth.