Servers & Metrics
Purpose
Per-server health, containers, and the metrics token that powers the Dashboard rings. These screens are admin-only: non-admins are sent back to the Dashboard.
Roles
- Dokploy admin/owner - full access to servers, metrics token, and terminal-from-server.
- Other roles - redirected to the Dashboard; the rows stay hidden in Settings.
User Flow
Read server health
Step 1: Open Servers
- Open Settings → Servers. Each card is one Dokploy server: name, Dokploy version, and CPU, Memory, Disk rings - the same rings as the Dashboard, per server.
- Rings fill in once metrics flow: configure the token below and they appear. Green / yellow / red follows the thresholds set in Dokploy. With no servers at all, the page says so and points at Dokploy.
Result:
- You see per-server load at a glance.
Open a shell from a server
Step 2: Tap a server
- Below the rings sits the server's running containers. Tap the server card.
- Pick a container to open a shell (Terminal, Pro).
Result:
- The container picker opens; connecting continues in the terminal.
Manage the metrics token
Step 3: Fetch or regenerate
- Open the token screen from Settings (or the Dashboard setup banner's Set up button).
- The current token shows masked at first - reveal it, then copy to take it.
- Auto-generate Token makes a brand-new token (the old one stops working immediately, so update Grafana and friends), or paste your own and Save Custom Token. Treat tokens like passwords.
Result:
- Dashboard and server rings fill in within a minute or two; external tools keep working on the current token.
Screens Involved
- Servers list (cards, rings, container lists, empty state)
- Container picker sheet → Terminal
- Metrics token screen (masked token, Copy, Regenerate)
Inputs
User Inputs:
- Server tap, container selection
- Fetch, Copy, Generate-new-token confirms
Outputs
- Terminal session (via picker)
- Copied or regenerated metrics token
Error Handling and Edge Cases
| Scenario | System Behavior |
|---|---|
| Screen redirects to Dashboard | Not a Dokploy admin - ask an owner for the role |
| Rings empty after token setup | Allow a minute or two; then check the token was saved |
| Old token in external tools | Regenerating invalidates it - update Grafana and friends |