Documentation
Platform Overview
These guides cover every tab in the OpenNVR web interface, grouped exactly like the app’s sidebar. Each page walks through what the feature does, the step-by-step to use it, and the exact fields and example values to enter.
Most feature tabs are permission-gated — you’ll see only the ones your role allows. A superuser sees everything; admin-only actions are called out on each page. See Access Control (RBAC) for the full role and permission model.
[!NOTE] New here? Start with First-Time Setup & MFA to bootstrap your admin account, then add your first camera from Cameras & Retention.
NVR & Live Video
- Dashboard — the at-a-glance landing view: camera status, health, and recent activity.
- Live View — low-latency multi-camera streaming and adding cameras (ONVIF discovery or manual RTSP).
- Recordings & Playback — browse recordings, scrub the DVR timeline, and export clips.
- Cameras & Retention — the camera inventory, per-camera settings, and how long footage is kept.
AI & Detections
- AI Engine — motion and object detection, schedules, and event webhooks.
- AI Models (BYOM) — bind your own local models (YOLO, BLIP, InsightFace) or route to cloud inference.
- Detection Results — the searchable feed of what the models detected.
- AI Adapters Monitor — health and performance of every registered adapter.
- App Catalog — installable analytics apps (intrusion, loitering, license-plate, …).
Security & Network
- Network — camera-LAN and uplink configuration.
- Logs & Forensics — search, filter, and export system logs for investigations.
Governance & Compliance
- Audit Logs — the immutable record of who did what, when.
- Compliance & Reports — compliance posture, security flags, and exportable reports.
- Alerts & Incidents — network intrusion alerts (Suricata IDS) and incident triage.
- Access Control (RBAC) — users, roles, permissions, and password policy.
- Customer Keys (BYOK) — bring your own TLS certificate/key for encrypted cloud streaming.
Administration
- Configuration — general, security, WebRTC, recording, and camera-config settings.
- Integrations — connect Slack, Teams, email, webhooks, MQTT, and S3.
- Media Server (MediaMTX) — the streaming/recording backbone configuration.
- Cloud Streaming & Recording — push camera streams (RTMP/SRT) and record to S3.
- Storage Mapping — map recordings to NAS, SAN, or local NVMe volumes.
- System Monitoring — host telemetry, logs, and AI adapter fleet health.
- Firmware & OTA Updates — check for and apply platform updates.
- Support — help resources and diagnostics.