heldar_kernel/config.rs
1use std::path::PathBuf;
2
3use crate::env::{parse_bool, parse_or, var, var_or};
4
5/// Runtime configuration, loaded from environment (see `.env.example`).
6#[derive(Clone, Debug)]
7pub struct Config {
8 pub database_url: String,
9 pub data_dir: PathBuf,
10 pub recordings_dir: PathBuf,
11 pub clips_dir: PathBuf,
12 pub snapshots_dir: PathBuf,
13 pub frames_dir: PathBuf,
14 /// Directory where segment-spanning HLS playback sessions are generated (one subdir per session).
15 pub playback_dir: PathBuf,
16 pub ffmpeg_bin: String,
17 pub ffprobe_bin: String,
18 pub mediamtx_api_url: String,
19 pub mediamtx_hls_base: String,
20 pub mediamtx_rtsp_base: String,
21 pub mediamtx_webrtc_base: String,
22 /// Max SQLite pool connections. Tunable per deployment: more absorbs bursts of concurrent
23 /// requests (WAL serves reads concurrently; writes still serialize), at the cost of memory.
24 pub db_max_connections: u32,
25 pub recorder_enabled: bool,
26 /// Optional second recordings root for dual/mirror recording. When set, cameras with
27 /// `mirror_enabled` get a SECOND ffmpeg pipeline writing byte-identical segments here (a redundant
28 /// DVR copy on a separate volume). Empty/unset disables mirror recording entirely.
29 pub mirror_recordings_dir: Option<PathBuf>,
30 /// Master switch for ANR (Automatic Network Replenishment) edge re-fill: re-fetch missed footage
31 /// from a camera's onboard storage to fill recording gaps. Cameras still need `anr_enabled`.
32 pub anr_enabled: bool,
33 /// How often the ANR loop scans for pending gaps to fill (seconds).
34 pub anr_interval_s: u64,
35 /// Ignore gaps older than this many hours (most cameras only retain recent onboard footage).
36 pub anr_max_gap_hours: i64,
37 /// Give up on a gap after this many fill attempts (marked `failed`).
38 pub anr_max_attempts: i64,
39 pub default_segment_seconds: i64,
40 pub default_retention_hours: i64,
41 /// Default per-camera storage quota (bytes) applied when a camera is created without an explicit
42 /// `storage_quota_bytes`. 0 means no default quota (the camera's quota is stored as NULL).
43 pub default_camera_quota_bytes: u64,
44 /// Default audio-recording toggle applied when a camera is created without an explicit
45 /// `record_audio`. When false (default) the recorder drops audio (video only).
46 pub default_record_audio: bool,
47 /// Default pre-roll seconds applied when a camera is created without an explicit
48 /// `pre_roll_seconds` (event / scheduled_event recording). Clamped to 0..300 in handlers.
49 pub default_pre_roll_seconds: i64,
50 /// Default post-roll seconds (the trigger recording window) applied when a camera is created
51 /// without an explicit `post_roll_seconds`. Clamped to 0..3600 in handlers.
52 pub default_post_roll_seconds: i64,
53 pub indexer_interval_s: u64,
54 pub health_interval_s: u64,
55 pub retention_interval_s: u64,
56 pub api_host: String,
57 pub api_port: u16,
58 pub cors_origins: Vec<String>,
59 /// Soft cap on total recording footprint; oldest unlocked segments are pruned above this.
60 pub max_recordings_bytes: u64,
61 /// Hard floor on free disk space; when free space drops below this, oldest unlocked segments
62 /// are pruned regardless of age/size policy (protects the host from a full disk).
63 pub min_free_disk_bytes: u64,
64 /// How often the alert notifier polls for new events to deliver.
65 pub notifier_interval_s: u64,
66 /// Master switch for AI frame sampling (Stage 2). Cameras still need an enabled AI task.
67 pub ai_enabled: bool,
68 /// Global frame-sampling budget (frames/sec summed across all cameras); per-camera fps is
69 /// reduced proportionally above this so adding AI cameras degrades fps instead of overloading.
70 pub ai_max_total_fps: f64,
71 pub default_ai_fps: f64,
72 pub default_ai_width: i64,
73 /// How long detection rows are kept before the retention sweeper prunes them.
74 pub detection_retention_hours: i64,
75 // ---- Scheduled interval snapshots ----
76 /// Master switch for the background snapshot scheduler (interval live-frame captures).
77 pub snapshot_scheduler_enabled: bool,
78 /// How often the scheduler ticks to look for due schedules (seconds).
79 pub snapshot_scheduler_interval_s: u64,
80 /// How long captured snapshots are kept before the retention sweeper prunes them. 0 = no pruning.
81 pub snapshot_retention_hours: i64,
82 // ---- Per-camera recording schedule (time-of-day windows) ----
83 /// How often the schedule watcher ticks to open/close recording windows for `scheduled` /
84 /// `scheduled_event` cameras (seconds). Windows are evaluated against the SERVER's LOCAL timezone.
85 pub schedule_check_interval_s: u64,
86 // ---- Segment-spanning HLS playback sessions (kernel platform feature) ----
87 /// How long a generated playback session (its HLS dir + the segment read-locks it holds) is
88 /// retained before the cleanup sweeper removes the dir and releases its locks. Server time.
89 pub playback_session_ttl_minutes: i64,
90 /// Maximum playback session span (seconds); a longer requested range is rejected (HTTP 400).
91 pub max_playback_seconds: f64,
92 // ---- Auth / RBAC (kernel platform feature) ----
93 /// Master switch for authentication + RBAC. When false, the API is open (dev/single-tenant
94 /// LAN appliance default) and a synthetic admin principal is used. When true, the auth/admin
95 /// surface requires a valid bearer token (session or API key) and enforces roles.
96 pub auth_enabled: bool,
97 /// Lifetime of an issued login session token.
98 pub session_ttl_hours: i64,
99 /// Add `Secure` to the session cookie (require HTTPS). Default false for HTTP LAN/overlay
100 /// appliances; set true when the deployment is served over TLS.
101 pub auth_cookie_secure: bool,
102 /// Optional first-run admin bootstrap (only used when no users exist yet).
103 pub bootstrap_admin_user: Option<String>,
104 pub bootstrap_admin_password: Option<String>,
105 /// How long kernel audit-log + generic-event rows are kept before retention prunes them.
106 pub audit_retention_days: i64,
107 // ---- Remote-access overlay (kernel platform feature; see docs/REMOTE-ACCESS.md) ----
108 /// Whether this deployment is reached through a WireGuard overlay (Tailscale / NetBird /
109 /// wireguard) running as an external daemon on the host. The kernel does not manage the
110 /// overlay; it only reports whether the configured interface is present + up so the dashboard
111 /// can surface remote-access health. When false, the deployment is LAN-only.
112 pub overlay_enabled: bool,
113 /// Label for the overlay in use: `tailscale` | `netbird` | `wireguard` | `none`.
114 pub overlay_kind: String,
115 /// The overlay's network interface to probe (e.g. `tailscale0`, `wt0`, `wg0`).
116 pub overlay_iface: Option<String>,
117 // ---- Backup subsystem (kernel platform feature) ----
118 /// Path to the `rclone` binary used for sftp/ftp/s3 remote backups. Local/NAS-mount backups use
119 /// std fs copy and never need it; remote backups degrade to a clear job error when it is missing.
120 pub rclone_bin: String,
121 /// Master switch for the background backup scheduler (scheduled policy jobs). On-demand archive
122 /// export still works when this is false.
123 pub backup_enabled: bool,
124 /// How often the backup scheduler ticks to look for due policies (seconds).
125 pub backup_scheduler_interval_s: u64,
126 /// Hard timeout for a single backup job's transfer (seconds); a job exceeding it is marked error.
127 pub backup_job_timeout_s: u64,
128 /// Maximum number of backup jobs running concurrently (a tokio Semaphore bounds the scheduler +
129 /// manual triggers).
130 pub backup_max_concurrent_jobs: usize,
131 /// Where on-demand archive (.zip) exports are written; also served at `/media/archives`.
132 pub archive_dir: PathBuf,
133 /// Maximum total source footprint (sum of segment sizes) for a single archive export; a larger
134 /// selection is rejected (HTTP 400).
135 pub archive_max_bytes: u64,
136 /// How long archive exports + finished backup-job rows are kept before retention prunes them.
137 pub archive_retention_hours: i64,
138 // ---- ONVIF (kernel platform feature; Profile S MVP) ----
139 /// How long the WS-Discovery probe listens for ProbeMatch replies (milliseconds).
140 pub onvif_discovery_timeout_ms: u64,
141 /// Per-request timeout for an ONVIF SOAP call (GetDeviceInformation, PTZ, etc.) in milliseconds.
142 pub onvif_request_timeout_ms: u64,
143 /// Per-request timeout for a HikVision ISAPI camera-config call (HTTP Digest) in milliseconds.
144 pub isapi_request_timeout_ms: u64,
145 // ---- Disk / array health (HA ops; see docs/HA.md) ----
146 /// Run periodic SMART self-assessment checks (`smartctl -H`) inside the health loop. Off by
147 /// default; needs `smartmontools` on PATH. Missing binary degrades to a one-time log + skip.
148 pub smart_check_enabled: bool,
149 /// Block devices to query when SMART checks are enabled (e.g. `/dev/sda,/dev/sdb`).
150 pub smart_devices: Vec<String>,
151 /// Watch `/proc/mdstat` (Linux md/RAID) and emit `raid_degraded` when an array shows a down member.
152 pub mdstat_check_enabled: bool,
153 /// Cadence of the disk-health (SMART/RAID) check inside the health loop (seconds).
154 pub smart_check_interval_s: u64,
155 // ---- Readiness HA probe (see docs/HA.md) ----
156 /// When > 0, `/readyz` also requires at least this percent of enabled cameras to be actively
157 /// recording (503 `insufficient_recorders` otherwise). 0 (default) keeps DB-connectivity-only.
158 pub readyz_min_recording_percent: f64,
159 // ---- Live preview transcode (HEVC->H.264) hardware acceleration ----
160 /// Encoder engine for the live preview transcode path: `software` (libx264, default), `vaapi`,
161 /// or `nvenc`. Unknown values warn and fall back to software.
162 pub live_transcode_engine: String,
163 /// VAAPI render node used when `live_transcode_engine = vaapi`.
164 pub vaapi_device: String,
165 // ---- Fleet / multi-site identity ----
166 /// Optional site identifier stamped onto outbox rows and surfaced at `GET /api/v1/site` for the
167 /// edge->cloud fleet uplink. Empty/unset = a single unnamed site.
168 pub site_id: Option<String>,
169 // ---- Plugin registry / store (Phase C) ----
170 /// Master switch for the plugin store's remote-registry fetching. When false, the store shows only
171 /// the bundled open catalog + locally installed plugins (fully offline). The bundled catalog is
172 /// always available regardless.
173 pub registry_enabled: bool,
174 /// Remote signed-catalog URLs to fetch (comma-separated). Default EMPTY — no phone-home; an
175 /// operator (or the proprietary build) sets the official Straits-AI registry here to populate the
176 /// proprietary/community shelves.
177 pub registry_urls: Vec<String>,
178 /// How often the background loop refreshes remote registries (seconds).
179 pub registry_refresh_s: u64,
180 /// Per-fetch timeout for a remote catalog (seconds).
181 pub registry_fetch_timeout_s: u64,
182 /// Operator-pinned extra trust anchors, `key_id:base64pubkey` comma-separated, added to the
183 /// compile-time pinned keys (for private registries).
184 pub registry_trusted_keys: Vec<(String, String)>,
185 /// When true, surface a remote registry's entries even if its signature does not verify (badged
186 /// unverified). Default false — fail closed.
187 pub registry_allow_unverified: bool,
188 /// When true, allow remote registry URLs that resolve to private/link-local addresses (default
189 /// false; SSRF guard for the admin-configured fetch).
190 pub registry_allow_private: bool,
191 // ---- Embedded dashboard (single-binary SPA serving) ----
192 /// Directory holding the built React dashboard (`apps/web/dist`), served as a static SPA
193 /// fallback so the whole product is one binary at one URL. Resolved from `HELDAR_WEB_DIR`; when
194 /// unset it falls back to `apps/web/dist` relative to the binary CWD. `None` when neither path
195 /// exists — the server then runs API-only (no dashboard).
196 pub web_dir: Option<PathBuf>,
197}
198
199impl Config {
200 pub fn from_env() -> Self {
201 let data_dir = PathBuf::from(var_or("HELDAR_DATA_DIR", "./data"));
202 let recordings_dir = var("HELDAR_RECORDINGS_DIR")
203 .map(PathBuf::from)
204 .unwrap_or_else(|| data_dir.join("recordings"));
205 let clips_dir = var("HELDAR_CLIPS_DIR")
206 .map(PathBuf::from)
207 .unwrap_or_else(|| data_dir.join("clips"));
208 let snapshots_dir = var("HELDAR_SNAPSHOTS_DIR")
209 .map(PathBuf::from)
210 .unwrap_or_else(|| data_dir.join("snapshots"));
211 let frames_dir = var("HELDAR_FRAMES_DIR")
212 .map(PathBuf::from)
213 .unwrap_or_else(|| data_dir.join("frames"));
214 let playback_dir = var("HELDAR_PLAYBACK_DIR")
215 .map(PathBuf::from)
216 .unwrap_or_else(|| data_dir.join("playback"));
217 let archive_dir = var("HELDAR_ARCHIVE_DIR")
218 .map(PathBuf::from)
219 .unwrap_or_else(|| data_dir.join("archives"));
220
221 let cors_origins = var_or("HELDAR_CORS_ORIGINS", "http://localhost:5173")
222 .split(',')
223 .map(|s| s.trim().to_string())
224 .filter(|s| !s.is_empty())
225 .collect();
226
227 // Embedded dashboard: explicit HELDAR_WEB_DIR wins; otherwise try `apps/web/dist` relative
228 // to the binary CWD. Only `Some` when the directory actually exists (else API-only).
229 let web_dir = var("HELDAR_WEB_DIR")
230 .map(PathBuf::from)
231 .unwrap_or_else(|| PathBuf::from("apps/web/dist"));
232 let web_dir = if web_dir.is_dir() {
233 Some(web_dir)
234 } else {
235 None
236 };
237
238 let max_recordings_gb: f64 = parse_or("HELDAR_MAX_RECORDINGS_GB", 20.0);
239 let min_free_disk_gb: f64 = parse_or("HELDAR_MIN_FREE_DISK_GB", 5.0);
240 let default_camera_quota_gb: f64 = parse_or("HELDAR_DEFAULT_CAMERA_QUOTA_GB", 0.0);
241
242 Config {
243 database_url: var_or("HELDAR_DATABASE_URL", "sqlite://./data/heldar.db"),
244 data_dir,
245 recordings_dir,
246 clips_dir,
247 snapshots_dir,
248 frames_dir,
249 playback_dir,
250 ffmpeg_bin: var_or("HELDAR_FFMPEG_BIN", "ffmpeg"),
251 ffprobe_bin: var_or("HELDAR_FFPROBE_BIN", "ffprobe"),
252 mediamtx_api_url: var_or("HELDAR_MEDIAMTX_API_URL", "http://127.0.0.1:9997"),
253 mediamtx_hls_base: var_or("HELDAR_MEDIAMTX_HLS_BASE", "http://127.0.0.1:8888"),
254 mediamtx_rtsp_base: var_or("HELDAR_MEDIAMTX_RTSP_BASE", "rtsp://127.0.0.1:8554"),
255 mediamtx_webrtc_base: var_or("HELDAR_MEDIAMTX_WEBRTC_BASE", "http://127.0.0.1:8889"),
256 db_max_connections: parse_or::<u32>("HELDAR_DB_MAX_CONNECTIONS", 16).clamp(2, 256),
257 recorder_enabled: parse_bool("HELDAR_RECORDER_ENABLED", true),
258 mirror_recordings_dir: var("HELDAR_MIRROR_RECORDINGS_DIR").map(PathBuf::from),
259 anr_enabled: parse_bool("HELDAR_ANR_ENABLED", false),
260 anr_interval_s: parse_or("HELDAR_ANR_INTERVAL_S", 300),
261 anr_max_gap_hours: parse_or("HELDAR_ANR_MAX_GAP_HOURS", 24),
262 anr_max_attempts: parse_or("HELDAR_ANR_MAX_ATTEMPTS", 3),
263 default_segment_seconds: parse_or("HELDAR_DEFAULT_SEGMENT_SECONDS", 60),
264 default_retention_hours: parse_or("HELDAR_DEFAULT_RETENTION_HOURS", 24),
265 default_camera_quota_bytes: (default_camera_quota_gb * 1024.0 * 1024.0 * 1024.0) as u64,
266 default_record_audio: parse_bool("HELDAR_DEFAULT_RECORD_AUDIO", false),
267 default_pre_roll_seconds: parse_or("HELDAR_DEFAULT_PRE_ROLL_SECONDS", 10),
268 default_post_roll_seconds: parse_or("HELDAR_DEFAULT_POST_ROLL_SECONDS", 30),
269 indexer_interval_s: parse_or("HELDAR_INDEXER_INTERVAL_S", 10),
270 health_interval_s: parse_or("HELDAR_HEALTH_INTERVAL_S", 15),
271 retention_interval_s: parse_or("HELDAR_RETENTION_INTERVAL_S", 300),
272 api_host: var_or("HELDAR_API_HOST", "0.0.0.0"),
273 api_port: parse_or("HELDAR_API_PORT", 8000),
274 cors_origins,
275 max_recordings_bytes: (max_recordings_gb * 1024.0 * 1024.0 * 1024.0) as u64,
276 min_free_disk_bytes: (min_free_disk_gb * 1024.0 * 1024.0 * 1024.0) as u64,
277 notifier_interval_s: parse_or("HELDAR_NOTIFIER_INTERVAL_S", 15),
278 ai_enabled: parse_bool("HELDAR_AI_ENABLED", true),
279 ai_max_total_fps: parse_or("HELDAR_AI_MAX_TOTAL_FPS", 40.0),
280 default_ai_fps: parse_or("HELDAR_DEFAULT_AI_FPS", 5.0),
281 default_ai_width: parse_or("HELDAR_DEFAULT_AI_WIDTH", 1280),
282 detection_retention_hours: parse_or("HELDAR_DETECTION_RETENTION_HOURS", 168),
283 snapshot_scheduler_enabled: parse_bool("HELDAR_SNAPSHOT_SCHEDULER_ENABLED", true),
284 snapshot_scheduler_interval_s: parse_or("HELDAR_SNAPSHOT_SCHEDULER_INTERVAL_S", 60),
285 snapshot_retention_hours: parse_or("HELDAR_SNAPSHOT_RETENTION_HOURS", 168),
286 schedule_check_interval_s: parse_or("HELDAR_SCHEDULE_CHECK_INTERVAL_S", 30),
287 playback_session_ttl_minutes: parse_or("HELDAR_PLAYBACK_SESSION_TTL_MINUTES", 60),
288 max_playback_seconds: parse_or("HELDAR_MAX_PLAYBACK_SECONDS", 7200.0),
289 auth_enabled: parse_bool("HELDAR_AUTH_ENABLED", false),
290 session_ttl_hours: parse_or("HELDAR_SESSION_TTL_HOURS", 12),
291 auth_cookie_secure: parse_bool("HELDAR_AUTH_COOKIE_SECURE", false),
292 bootstrap_admin_user: var("HELDAR_BOOTSTRAP_ADMIN_USER"),
293 bootstrap_admin_password: var("HELDAR_BOOTSTRAP_ADMIN_PASSWORD"),
294 audit_retention_days: parse_or("HELDAR_AUDIT_RETENTION_DAYS", 365),
295 overlay_enabled: parse_bool("HELDAR_OVERLAY_ENABLED", false),
296 overlay_kind: var_or("HELDAR_OVERLAY_KIND", "none"),
297 overlay_iface: var("HELDAR_OVERLAY_IFACE"),
298 rclone_bin: var_or("HELDAR_RCLONE_BIN", "rclone"),
299 backup_enabled: parse_bool("HELDAR_BACKUP_ENABLED", true),
300 backup_scheduler_interval_s: parse_or("HELDAR_BACKUP_SCHEDULER_INTERVAL_S", 60),
301 backup_job_timeout_s: parse_or("HELDAR_BACKUP_JOB_TIMEOUT_S", 3600),
302 backup_max_concurrent_jobs: parse_or::<usize>("HELDAR_BACKUP_MAX_CONCURRENT_JOBS", 2)
303 .max(1),
304 archive_dir,
305 archive_max_bytes: parse_or("HELDAR_ARCHIVE_MAX_BYTES", 10_737_418_240u64),
306 archive_retention_hours: parse_or("HELDAR_ARCHIVE_RETENTION_HOURS", 48),
307 onvif_discovery_timeout_ms: parse_or("HELDAR_ONVIF_DISCOVERY_TIMEOUT_MS", 2000),
308 onvif_request_timeout_ms: parse_or("HELDAR_ONVIF_REQUEST_TIMEOUT_MS", 5000),
309 isapi_request_timeout_ms: parse_or("HELDAR_ISAPI_REQUEST_TIMEOUT_MS", 8000),
310 smart_check_enabled: parse_bool("HELDAR_SMART_CHECK_ENABLED", false),
311 smart_devices: var("HELDAR_SMART_DEVICES")
312 .map(|v| {
313 v.split(',')
314 .map(|s| s.trim().to_string())
315 .filter(|s| !s.is_empty())
316 .collect()
317 })
318 .unwrap_or_default(),
319 mdstat_check_enabled: parse_bool("HELDAR_MDSTAT_CHECK_ENABLED", false),
320 smart_check_interval_s: parse_or("HELDAR_SMART_CHECK_INTERVAL_S", 300),
321 readyz_min_recording_percent: parse_or("HELDAR_READYZ_MIN_RECORDING_PERCENT", 0.0),
322 live_transcode_engine: var_or("HELDAR_LIVE_TRANSCODE_ENGINE", "software"),
323 vaapi_device: var_or("HELDAR_VAAPI_DEVICE", "/dev/dri/renderD128"),
324 site_id: var("HELDAR_SITE_ID"),
325 registry_enabled: parse_bool("HELDAR_REGISTRY_ENABLED", true),
326 registry_urls: var_or("HELDAR_REGISTRY_URLS", "")
327 .split(',')
328 .map(|s| s.trim().to_string())
329 .filter(|s| !s.is_empty())
330 .collect(),
331 registry_refresh_s: parse_or("HELDAR_REGISTRY_REFRESH_S", 900),
332 registry_fetch_timeout_s: parse_or("HELDAR_REGISTRY_FETCH_TIMEOUT_S", 10),
333 registry_trusted_keys: var_or("HELDAR_REGISTRY_TRUSTED_KEYS", "")
334 .split(',')
335 .filter_map(|s| {
336 let s = s.trim();
337 s.split_once(':')
338 .map(|(id, key)| (id.trim().to_string(), key.trim().to_string()))
339 .filter(|(id, key)| !id.is_empty() && !key.is_empty())
340 })
341 .collect(),
342 registry_allow_unverified: parse_bool("HELDAR_REGISTRY_ALLOW_UNVERIFIED", false),
343 registry_allow_private: parse_bool("HELDAR_REGISTRY_ALLOW_PRIVATE", false),
344 web_dir,
345 }
346 }
347
348 /// Directory where a camera's segments are stored.
349 pub fn camera_recordings_dir(&self, camera_id: &str) -> PathBuf {
350 self.recordings_dir.join(camera_id)
351 }
352
353 /// Directory where a camera's sampled AI frames are written.
354 pub fn camera_frames_dir(&self, camera_id: &str) -> PathBuf {
355 self.frames_dir.join(camera_id)
356 }
357}