sclaflin/frugal-nvr repository overview

# REQUIRED: Set this to the hosts network name or address that Frugal NVR is
# running on.
hostname: my-host.lan
# REQUIRED: Set this to where you would like Frugal to place temporary files.
# On Linux based hosts, /dev/shm is a good choice as it is using computer 
# memory to save wear and tear on physical drives.
tempPath: /your/temp/path
# OPTIONAL: Default is "ffmpeg". Set this to the ffmpeg binary on your system.
# If ffmpeg is on your system path, the default is sufficient.
ffmpegPath: ffmpeg
# OPTIONAL: Default is "mediainfo". Set this to the mediainfo binary on your
# system. If mediainfo is on your system path, the default is sufficient.
mediainfoPath: mediainfo
# OPTIONAL: Default is "/app/videos". The path that video streams will be
# recorded to. Must be an absolute path.
videoPath: /app/videos
# OPTIONAL: Default is "24". How many hours of recorded camera streams to 
# retain.
retainHours: 24
# OPTIONAL: Default is 10. How many seconds to wait before updating statistics
# on a segment. Resource constrained hosts should pick a larger number as this
# is (relatively) CPU intensive.
segmentUpdateFrequency: 10
# OPTIONAL: Default is "/app/data". The path that the SQLite database will be
# kept.
dbPath: /app/data
# OPTIONAL: Default is 'info'. Set how verbose FrugalNVR is on the console.
# Choices are debug, info, warn, error, and fatal.
logLevel: info
# MQTT based interface for camera
mqtt:
  # OPTIONAL: Default is "false". Enables the MQTT client
  enable: false
  # REQUIRED if enabled: Url to your MQTT instance
  url: mqtt://your-mqtt-host
  # OPTIONAL: Default is 'frugal-nvr'. Sets the base topic that Frugal NVR
  # will publish to.
  baseTopic: frugal-nvr
  # Home Assistant Auto Discovery support.
  hassDiscovery:
    # OPTIONAL: Default is "false". Enables support for Home Assistant auto
    # discovery.
    enable: true
    # OPTIONAL: Default is 'homeassistant'. Sets the base topic of
    # homeassistant.
    discoveryPrefix: homeassistant
  # OPTIONAL: Connection options can be found here
  # https://github.com/mqttjs/MQTT.js#client
  mqttOptions:
    username: my-username
    password: my-password
# The Web UI is the web-based interface to view the camera streams.
webUI:
  # OPTIONAL: Default is "true". Enables the Web UI.
  enable: true
  # OPTIONAL: Default is "3000".
  port: 3000
  # The overview is a composite of all camera streams.
  overview:
      # OPTIONAL: Default is "true". Enables the overview,  Set to false to
      # save host memory and CPU.
      enable: true
      # OPTIONAL: Default is 540. Sets the width of the thumbnail images
      # generated for the overview. Smaller is faster, bigger is prettier. :)
      thumbnailWidth: 540
# The media server provides FLV live streams of the cameras being monitored.
mediaServer:
  http:
    # REQUIRED: Default is "8000".
    port: 8000
# OPTIONAL: Global ONVIF settings to be applied to all cameras. If overriding
# settings are not defined for a specific camera, these settings will be used.
onvif:
  username: my-username
  password: my-password
# REQUIRED: List of cameras to be monitored.
cameras:
  # REQUIRED: The name to be used for a particular camera.
  - name: Camera One
    # OPTIONAL (if no global settings): Camera specific ONVIF settings.
    onvif:
      # REQUIRED: Host name or IP of the camera
      hostname: camera-one.lan
  # MOAR CAMERAS!
  - name: Camera Two
    onvif:
      hostname: camera-two.lan

services:
frugal-nvr:
  container_name: frugal-nvr
  restart: unless-stopped
  image: sclaflin/frugal-nvr:latest
  # Sets the size of /dev/shm. Frugal tends to have a lot of read/write
  # operations of temporary files. The shared memory disk is used to save wear
  # and tear on drives. Set this to a value large enough to accommodate the
  # largest video clips you think you may need. A good start is 500mb.
  shm_size: 500mb
  # Set this to your local time zone. Please note that this is important
  # to keep the WebUI working properly.
  environment:
    - TZ=America/Chicago
  # Expose the WebUI & Media Server ports
  ports:
    - 8000:8000
    - 3000:3000

  volumes:
    # Mount your hosts storage locations for video & data
    - ./videos:/app/videos
    - ./data:/app/data
    # Mount your config file to make it do the things (and stuff).
    - ./config.yml:/app/config.yml