Connect TrueNAS SCALE
Add TrueNAS to Kochab with a username and API key for apps, VMs, pools, and system health.
TrueNAS SCALE is an infrastructure service. Kochab uses the TrueNAS WebSocket API for pools, system health, workloads, and alerts.
What Kochab exposes through TrueNAS
- Storage: ZFS pool capacity, health, and disk temperatures
- System: CPU, RAM, load, and network-oriented stats
- SCALE apps: list, start, stop, restart; redeploy/restart where the installed API supports it; app logs when available
- VMs: start, stop, restart
- Standalone containers: start/stop (Docker workloads outside catalog apps)
- Alerts: TrueNAS alert feed on the infra surface
Not exposed through TrueNAS
- Unraid-style parity array UI or Unraid container autostart/image-update buttons
- Multi-host Docker or Portainer environment switching
- Direct Sonarr/Radarr API access (add those services separately)
- Container detail with live Engine stats (use Docker-direct on that host if you need it, but avoid doubling up unnecessarily)
See Infrastructure vs container integrations.
Before you start
In TrueNAS: Credentials -> API Keys. Create a key. Note the username tied to the key (required on TrueNAS 26+ for SCRAM auth).
Default connection
| Field | Typical value |
|---|---|
| Port | 443 |
| Scheme | https |
| Auth | Username + API key (WebSocket login after connect) |
Add in Kochab
- Open Services -> Add service and choose TrueNAS.
- Enter your TrueNAS hostname or IP.
- Port 443.
- Enter username and API key.
- Tap Test and add.
- Use Infrastructure for pools, apps, VMs, and containers.
TLS
TrueNAS often uses a private CA or self-signed cert. Import your CA or trust TOFU when prompted. See Certificate trust.
Tips
- API keys should be scoped for read/control as you prefer; Kochab needs app and system query methods.
- Standalone Docker containers (outside catalog apps) appear under Containers in the TrueNAS surface.