Quick Start
Get Rokks running locally in under 10 minutes.
Rokks Documentation
Welcome to Rokks Docs
Rokks is a full-stack analytical intelligence platform. It connects your data sources, transforms and loads them into a time-series warehouse, and lets you build live dashboards with AI assistance — all running on your own infrastructure.
What is Rokks?
Understand the core concepts: environments, data fabric, dashboards, and the Sidekick agent.
Guides
Step-by-step instructions for dashboards, data sources, transforms, and more.
Reference
Complete API reference, job types, Firestore collections, and configuration keys.
Platform at a glance
| Layer | Technology | What it does |
|---|---|---|
| Data ingestion | File ETL, Web API streams, App Connect | Loads external data into TimescaleDB |
| Storage | TimescaleDB / PostgreSQL | Time-series hypertables + relational data |
| Metadata | Firestore via Doc Gateway | Table schemas, dashboards, user data |
| Dashboards | React + ECharts | Live charts, tables, maps, AI-powered widgets |
| Intelligence | AI Gateway (Gemini / LM Studio) | Transform plans, widget suggestions, Sidekick agent |
| Scheduling | Dispatcher + Sentinel | Cron-based sync, alert evaluation |
All services run in Docker and communicate over a secure internal mesh. The browser communicates exclusively through the Edge proxy — no direct backend access.