Skip to content

Recording & Retention Configuration Reference ​

The recording block in config.yaml controls automated 24/7 video archiving, disk partitioning, storage quota limits, and lifecycle retention cleanup.


1. Recording Configuration Block ​

yaml
recording:
  # Enable global fMP4 video recording
  enabled: true
  
  # Base directory for archive video files
  storage_path: "/data/recordings"
  
  # Target duration of individual .mp4 files (GOP KeyFrame aligned)
  segment_duration: "1h"
  
  # Default retention policy in days (0 = keep indefinitely until disk quota)
  retention_days: 14
  
  # Emergency disk quota safety thresholds
  min_disk_free_gb: 25
  max_disk_usage_percent: 90
  
  # Frequency of the automated retention cleanup cycle
  cleanup_interval: "10m"
  
  # Disk I/O engine: "linux_direct" (recommended on Linux) or "default"
  io_engine: "linux_direct"

2. Parameter Reference Table ​

ParameterTypeDefaultDescription
recording.enabledbooleantrueMaster switch for the fMP4 archiver engine
recording.storage_pathstring"./data/recordings"Absolute filesystem path where video files are written
recording.segment_durationduration"1h"Hourly file rotation boundary
recording.retention_daysinteger14Days of video to retain before automatic FIFO deletion
recording.min_disk_free_gbinteger20Minimum free disk space before emergency pruning triggers
recording.max_disk_usage_percentinteger90Maximum disk usage percentage ceiling
recording.io_enginestring"linux_direct"Uses sync_file_range and FADV_DONTNEED on Linux

Released under the MIT License.