Skip to content

Cameras & RTSP Ingestion Configuration Reference ​

The cameras and rtsp sections define global ingest defaults and initial camera topology definitions.


1. Initial Cameras Configuration Block ​

yaml
# Global RTSP Ingest Settings
rtsp:
  default_transport: "tcp" # options: tcp, udp
  reconnect_interval_min: "1s"
  reconnect_interval_max: "30s"
  dial_timeout: "5s"
  max_concurrent_dials: 10

# Initial Cameras (Seeded into BadgerDB on first boot)
cameras:
  - id: "cam_entrance"
    name: "Front Entrance"
    url: "rtsp://admin:pass@192.168.1.100:554/live"
    transport: "tcp"
    enabled: true
    recording_enabled: true
    lazy_hls: false
    folder_id: "perimeter"
    tags:
      - "outdoor"
      - "entrance"
      - "ptz"

  - id: "cam_warehouse"
    name: "Main Warehouse Floor"
    url: "rtsp://admin:pass@192.168.1.101:554/live"
    transport: "tcp"
    enabled: true
    recording_enabled: true
    lazy_hls: true # On-demand ingest

2. Camera Configuration Properties Reference ​

PropertyTypeDefaultDescription
idstringRequiredUnique alphanumeric camera identifier (slug)
namestring""User-friendly display title in Web UI
urlstringRequiredFull RTSP URI (e.g. rtsp://user:pass@host:554/path)
transportstring"tcp"RTSP transport mode (tcp or udp)
enabledbooleantrueMaster enable toggle for the camera
recording_enabledbooleanfalseEnable automated fMP4 video archiving
lazy_hlsbooleanfalseIngest stream only when an active viewer is watching
folder_idstring""Identifier of parent folder group
tagslist[string][]Search and classification tags

Released under the MIT License.