Rakkr Documentation
Rakkr Documentation
Rakkr is a centrally managed Linux audio recording platform for reliable room recording. It captures audio on managed Linux nodes, watches the audio while it is being recorded, and gives operators a single console to start, schedule, monitor, and ship every recording — with an audit trail behind every privileged action.
Rakkr is built around one idea: a recording failure should become visible while the session can still be saved, not after the meeting is over.
The system in one picture
flowchart LR room["Room audio"] --> agent["Recorder agent (Rust)"] agent -->|"capture / meters / health"| cache["Local cache"] agent <-->|"encrypted HTTP / WS"| api["Controller API (Hono)"] api <--> db["Postgres + Drizzle"] api --> ui["Operator console (React)"] cache -->|"upload"| storage["SMB / S3"] api --> metrics["/metrics → Prometheus / Grafana"]
Rakkr has four parts:
- a controller API (Hono/Node) for auth, RBAC, audit, inventory, recordings, jobs, schedules, settings, health, uploads, and metrics;
- a React operator console for day-to-day operations;
- a Rust recorder agent that runs on each Linux audio node — it captures audio, samples meters, scores quality, manages local cache, and syncs with the controller;
- Postgres + Drizzle for controller persistence, with JSON/in-memory fallback stores so the controller can run without a database.
An optional Dockerized Ansible runner provisions and updates recorder nodes over SSH.
Where to start
| If you want to… | Read |
|---|---|
| Understand what Rakkr is and why it exists | Introduction |
| Run it locally in a few minutes | Quick start |
| Learn the vocabulary (nodes, jobs, schedules, channel maps…) | Core concepts |
| Understand how the pieces fit together | Architecture overview |
| Operate a specific feature | The Guides |
| Look up an env var, endpoint, or permission | The Reference |
| Deploy or monitor a controller | Operations |
| Contribute code | Contributing |
Documentation map
- Getting started — Introduction · Quick start · Core concepts
- Architecture — Overview · Controller API · Recorder agent · Web console · Data model
- Guides — Authentication & RBAC · Nodes & inventory · Recording · Scheduling · Health watchdog · Storage & uploads · Transport security · Node lifecycle
- Reference — Configuration · Recorder agent CLI · API endpoints · Permissions · Metrics · Tasks
- Operations — Deployment · Observability
- Contributing — Development · Testing · Baselines & verification
Source of truth
The product contract, status ledger, and promotion record live in RAKKR_SOURCE_OF_TRUTH.md. When code, docs, and the ledger disagree, investigate before changing behavior.