Documentation

Nidus Documentation

Everything you need to deploy, configure, and extend Nidus.

🚀
Deployment
Docker, standalone binary, desktop app, CI/CD, and building from source.
 ⚙
Configuration
YAML config format, widget types, grid system, and import/export.
 🧩
Modules
All 19+ widget types — connection details, features, and configuration.
 📡
API Reference
REST API endpoints with curl examples for authentication, widgets, services, and more.
 🌐
Translating
How to add or improve a translation. 11 languages currently supported.
 💻
Source Code
Browse the source on GitHub, report issues, or contribute.

Quick start

The fastest way to get Nidus running:

docker run -d -p 3777:3777 -v nidus-data:/data ghcr.io/tdebuilt/nidus-dashboard:latest

Open http://localhost:3777 — the setup wizard will guide you through creating your account and connecting your services.

For more options (Docker Compose, standalone binary, desktop app), see the Deployment guide.

Architecture

┌──────────────────────────────────────────────────┐
│                 Nidus Container                   │
│  Go backend + Svelte frontend + SQLite + go2rtc  │
└───────────────────────┬──────────────────────────┘
                        │
     ┌──────────┬───────┼───────────┬──────────┐
     │          │       │           │          │
 Portainer   Proxmox  Services   Reolink    go2rtc
  API         API    (HA, AdGuard, cameras   (RTSP →
 (CE/EE)              Pi-hole,              WebRTC)
                       *arr, Plex,
                       Jellyfin, etc.)