description:Improve contrast. Enables dynamic contrast improvement. This should help improve night detections at the cost of making motion detection more sensitive for daytime.
schema:
type:boolean
default:false
- variable:mqtt_off_delay
label:MQTT Off Delay
description:Delay when updating camera motion through MQTT from ON -> OFF
schema:
type:int
default:30
- variable:record
label:Record
schema:
additional_attrs:true
type:dict
attrs:
- variable:render_config
label:Render Configuration
description:Enable it to add the configuration in the config file
schema:
type:boolean
default:false
show_subquestions_if:true
subquestions:
- variable:enabled
label:Enabled
description:|
Enable recording
WARNING:If recording is disabled in the config, turning it on via the UI or MQTT later will have no effect.
WARNING:Frigate does not currently support limiting recordings based on available disk space automatically.
If using recordings,you must specify retention settings for a number of days that will fit within the available disk space of your drive or Frigate will crash.
schema:
type:boolean
default:true
- variable:expire_interval
label:Expire Interval
description:Number of minutes to wait between cleanup runs
schema:
type:int
required:true
default:60
- variable:retain
label:Retain
description:Retention settings for recording
schema:
additional_attrs:true
type:dict
attrs:
- variable:render_config
label:Render Retain Config
schema:
type:boolean
default:false
show_subquestions_if:true
subquestions:
- variable:days
label:Days
description:|
Number of days to retain recordings regardless of events
NOTE:This should be set to 0 and retention should be defined in events section below if you only want to retain recordings of events.
schema:
type:int
required:true
default:0
- variable:mode
label:Mode
description:|
Mode for retention.
All - save all recording segments regardless of activity
Motion - save all recordings segments with any detected motion
Active Objects - save all recording segments with active/moving objects
NOTE:This mode only applies when the days setting above is greater than 0
schema:
type:string
show_if:[["days","!=",0]]
required:true
default:all
enum:
- value:all
description:All
- value:motion
description:Motion
- value:active_objects
description:Active Objects
- variable:events
label:Events
description:Event recording settings
schema:
additional_attrs:true
type:dict
attrs:
- variable:pre_capture
label:Pre Capture
description:Number of seconds before the event to include
schema:
type:int
required:true
default:5
- variable:post_capture
label:Post Capture
description:Number of seconds after the event to include
schema:
type:int
required:true
default:5
- variable:objects
label:Objects
description:Objects to save recordings for. Defaults to all objects.
schema:
type:list
default:[]
items:
- variable:object_entry
label:Object Entry
schema:
type:string
required:true
default:""
- variable:required_zones
label:Required Zones
description:Restrict recordings to objects that entered any of the listed zones
schema:
type:list
default:[]
items:
- variable:zone_entry
label:Zone Entry
schema:
type:string
required:true
default:""
- variable:retain
label:Retain
description:Retention settings for recordings of events
schema:
additional_attrs:true
type:dict
attrs:
- variable:render_config
label:Render Retain Config
schema:
type:boolean
default:false
show_subquestions_if:true
subquestions:
- variable:default
label:Default
description:Default retention days
schema:
type:int
required:true
default:10
- variable:mode
label:Mode
description:|
Mode for retention.
All - save all recording segments for events regardless of activity
Motion - save all recordings segments for events with any detected motion
Active Objects - save all recording segments for event with active/moving objects
schema:
type:string
required:true
default:motion
enum:
- value:all
description:All
- value:motion
description:Motion
- value:active_objects
description:Active Objects
- variable:objects
label:Objects
description:Per object retention days
schema:
type:list
default:[]
items:
- variable:objects_entry
label:Objects Entry
schema:
additional_attrs:true
type:dict
attrs:
- variable:object
label:Object
description:For example Person
schema:
type:string
required:true
default:""
- variable:days
label:Retention Days
description:Retention days for the object
schema:
type:int
required:true
default:15
- variable:snapshots
label:Snapshots
schema:
additional_attrs:true
type:dict
attrs:
- variable:render_config
label:Render Configuration
description:Enable it to add the configuration in the config file
schema:
type:boolean
default:false
show_subquestions_if:true
subquestions:
- variable:enabled
label:Enabled
description:|
Optional:Enable writing jpg snapshot to /media/frigate/clips
This value can be set via MQTT and will be updated in startup based on retained value
schema:
type:boolean
default:true
- variable:clean_copy
label:Clean Copy
description:Save a clean PNG copy of the snapshot image
schema:
type:boolean
default:true
- variable:timestamp
label:Timestamp
description:Print a timestamp on the snapshots
schema:
type:boolean
default:false
- variable:bounding_box
label:Bounding Box
description:Draw bounding box on the snapshots
schema:
type:boolean
default:false
- variable:crop
label:Crop
description:Crop the snapshot
schema:
type:boolean
default:false
- variable:height
label:Height
description:Height to resize the snapshot to
schema:
type:int
"null": true
- variable:required_zones
label:Required Zones
description:Restrict recordings to objects that entered any of the listed zones
schema:
type:list
default:[]
items:
- variable:zone_entry
label:Zone Entry
schema:
type:string
required:true
default:""
- variable:retain
label:Retain
description:Retention settings for recordings of events
schema:
additional_attrs:true
type:dict
attrs:
- variable:render_config
label:Render Retain Config
schema:
type:boolean
default:false
show_subquestions_if:true
subquestions:
- variable:default
label:Default
description:Default retention days
schema:
type:int
required:true
default:10
- variable:objects
label:Objects
description:Per object retention days
schema:
type:list
default:[]
items:
- variable:objects_entry
label:Objects Entry
schema:
additional_attrs:true
type:dict
attrs:
- variable:object
label:Object
description:For example Person
schema:
type:string
required:true
default:""
- variable:days
label:Retention Days
description:Retention days for the object
schema:
type:int
required:true
default:15
- variable:rtmp
label:RTMP
schema:
additional_attrs:true
type:dict
attrs:
- variable:render_config
label:Render Configuration
description:Enable it to add the configuration in the config file
schema:
type:boolean
default:false
show_subquestions_if:true
subquestions:
- variable:enabled
label:Enabled
description:Enable the RTMP stream
schema:
type:boolean
default:true
- variable:live
label:Live
schema:
additional_attrs:true
type:dict
attrs:
- variable:render_config
label:Render Configuration
description:Enable it to add the configuration in the config file
schema:
type:boolean
default:false
show_subquestions_if:true
subquestions:
- variable:height
label:Height
description:|
Set the height of the live stream.
This must be less than or equal to the height of the detect stream. Lower resolutions
reduce bandwidth required for viewing the live stream. Width is computed to match known aspect ratio.
schema:
type:int
required:true
default:720
- variable:quality
label:Quality
description:|
Set the encode quality of the live stream
1is the highest quality, and 31 is the lowest. Lower quality feeds utilize less CPU resources.
schema:
type:int
required:true
min:1
max:31
default:8
- variable:timestamp_style
label:Timestamp Style
schema:
additional_attrs:true
type:dict
attrs:
- variable:render_config
label:Render Configuration
description:Enable it to add the configuration in the config file
schema:
type:boolean
default:false
show_subquestions_if:true
subquestions:
- variable:position
label:Position
description:Position of the timestamp
schema:
type:string
required:true
default:tl
enum:
- value:tl
description:Top Left
- value:tr
description:Top Right
- value:bl
description:Bottom Left
- value:br
description:Bottom Right
- variable:format
label:Format
description:Format specifier conform to the Python package "datetime"
schema:
type:string
required:true
default:"%m/%d/%Y %H:%M:%S"
- variable:color
label:Color
schema:
additional_attrs:true
type:dict
attrs:
- variable:red
label:Red
schema:
type:int
default:255
required:true
- variable:green
label:Green
schema:
type:int
required:true
default:255
- variable:blue
label:Blue
schema:
type:int
required:true
default:255
- variable:thickness
label:Thickness
description:Line thickness of font
schema:
type:int
required:true
default:2
- variable:effect
label:Effect
description:|
Effect of lettering
None - No effect
Solid - Solid background in inverse color of font
Shadow - Shadow for font
schema:
type:string
required:true
default:None
enum:
- value:None
description:None
- value:solid
description:Solid
- value:shadow
description:Shadow
- variable:cameras
label:Cameras
schema:
type:list
default:[]
items:
- variable:camera_entry
label:Camera Entry
schema:
additional_attrs:true
type:dict
attrs:
- variable:camera_name
label:Camera Name
schema:
type:string
required:true
default:""
- variable:ffmpeg
label:ffmpeg
description:ffmpeg Settings for the camera
schema:
additional_attrs:true
type:dict
attrs:
- variable:inputs
label:Inputs
description:A list of input streams for the camera. See documentation for more information.
schema:
type:list
required:true
default:[]
items:
- variable:input_entry
label:Input Entry
schema:
additional_attrs:true
type:dict
attrs:
- variable:path
label:Path
description:The path to the stream
schema:
type:string
required:true
default:""
- variable:roles
label:Roles
schema:
type:list
required:true
default:[]
items:
- variable:role_entry
label:Role Entry
schema:
type:string
required:true
default:""
enum:
- value:detect
description:Detect
- value:rtmp
description:RTMP
- value:record
description:Record
- variable:global_args
label:Global Args
description:Camera specific global args
schema:
type:string
default:""
- variable:hwaccel_args
label:HW Acceleration Args
description:Camera specific hwaccel args
schema:
type:string
default:""
- variable:input_args
label:Input Args
description:Camera specific input args
schema:
type:string
default:""
- variable:output_args
label:Output Args
description:Camera specific output args
schema:
type:string
default:""
- variable:best_image_timeout
label:Best Image Timeout
description:Timeout for highest scoring image before allowing it to be replaced by a newer image.
description:MQTT Configuration for jpg snapshots published for this camera
schema:
additional_attrs:true
type:dict
attrs:
- variable:render_config
label:Render Configuration
description:Enable it to add the configuration in the config file
schema:
type:boolean
default:false
show_subquestions_if:true
subquestions:
- variable:enabled
label:Enabled
description:|
Enable publishing snapshot via mqtt for camera
NOTE:Only applies to publishing image data to MQTT via 'frigate/<camera_name>/<object_name>/snapshot'.
All other messages will still be published.
schema:
type:boolean
default:true
- variable:timestamp
label:Timestamp
description:Print a timestamp on the snapshots
schema:
type:boolean
default:true
- variable:bounding_box
label:Bounding Box
description:Draw bounding box on the snapshots
schema:
type:boolean
default:true
- variable:crop
label:Crop
description:Crop the snapshot
schema:
type:boolean
default:true
- variable:height
label:Height
description:Height to resize the snapshot to
schema:
type:int
required:true
default:720
- variable:quality
label:Quality
description:JPEG encode quality
schema:
type:int
required:true
default:70
- variable:required_zones
label:Required Zones
description:Restrict mqtt messages to objects that entered any of the listed zones
schema:
type:list
default:[]
items:
- variable:required_zone
label:Required Zone
schema:
type:string
required:true
default:""
- variable:ui
label:UI
description:Configuration for how camera is handled in the GUI.
schema:
additional_attrs:true
type:dict
attrs:
- variable:render_config
label:Render Configuration
description:Enable it to add the configuration in the config file
schema:
type:boolean
default:false
show_subquestions_if:true
subquestions:
- variable:order
label:order
description:Adjust sort order of cameras in the UI. Larger numbers come later By default the cameras are sorted alphabetically.
schema:
"null": true
type:int
- variable:dashboard
label:Dashboard
description:Whether or not to show the camera in the Frigate UI
schema:
type:boolean
default:true
- variable:TZ
label:Timezone
group:"General Settings"
schema:
type:string
default:"Etc/UTC"
$ref:
- "definitions/timezone"
- variable:envList
label:Extra Environment Variables
description:"Please be aware that some variables are set in the background, adding duplicates here might cause issues or prevent the app from starting..."
group:"General Settings"
schema:
type:list
default:[]
items:
- variable:envItem
label:Environment Variable
schema:
additional_attrs:true
type:dict
attrs:
- variable:name
label:Name
schema:
type:string
- variable:value
label:Value
schema:
type:string
- variable:service
group:Networking and Services
label:Configure Service(s)
schema:
additional_attrs:true
type:dict
attrs:
- variable:main
label:Main Service
description:The Primary service on which the healthcheck runs, often the webUI
schema:
additional_attrs:true
type:dict
attrs:
- variable:enabled
label:Enable the Service
schema:
type:boolean
default:true
hidden:true
- variable:type
label:Service Type
description:"ClusterIP's are only internally available and Loadbalancer exposes the service using the system loadbalancer"
schema:
type:string
default:LoadBalancer
enum:
- value:LoadBalancer
description:LoadBalancer (Expose Ports)
- value:ClusterIP
description:ClusterIP (Do Not Expose Ports)
- value:Simple
description:Deprecated CHANGE THIS
- variable:loadBalancerIP
label:LoadBalancer IP
description:"MetalLB Only: Selects the Loadbalancer IP to expose on. Required when using PortalButton with MetalLB"
schema:
show_if:[["type","=","LoadBalancer"]]
type:string
default:""
- variable:ports
label:"Service's Port(s) Configuration"
schema:
additional_attrs:true
type:dict
attrs:
- variable:main
label:Main Service Port Configuration
schema:
additional_attrs:true
type:dict
attrs:
- variable:port
label:Port
description:This port exposes the container port on the service
schema:
type:int
default:10500
editable:true
required:true
- variable:rtmp
label:RTMP Service
description:The service on which nodes connect to.
schema:
additional_attrs:true
type:dict
attrs:
- variable:enabled
label:Enable the Service
schema:
type:boolean
default:true
hidden:true
- variable:type
label:Service Type
description:"ClusterIP's are only internally available and Loadbalancer exposes the service using the system loadbalancer"
schema:
type:string
default:LoadBalancer
enum:
- value:LoadBalancer
description:LoadBalancer (Expose Ports)
- value:ClusterIP
description:ClusterIP (Do Not Expose Ports)
- value:Simple
description:Deprecated CHANGE THIS
- variable:loadBalancerIP
label:LoadBalancer IP
description:"MetalLB Only: Selects the Loadbalancer IP to expose on. Required when using PortalButton with MetalLB"
schema:
show_if:[["type","=","LoadBalancer"]]
type:string
default:""
- variable:ports
label:"Service's Port(s) Configuration"
schema:
additional_attrs:true
type:dict
attrs:
- variable:rtmp
label:RTMP Service Port Configuration
schema:
additional_attrs:true
type:dict
attrs:
- variable:port
label:Port
description:This port exposes the container port on the service
schema:
type:int
default:1935
editable:true
required:true
- variable:serviceexpert
group:Networking and Services
label:Show Expert Config
schema:
type:boolean
default:false
show_subquestions_if:true
subquestions:
- variable:hostNetwork
group:Networking and Services
label:Host-Networking (Complicated)
schema:
type:boolean
default:false
- variable:externalInterfaces
description:Add External Interfaces
label:Add external Interfaces
group:Networking
schema:
type:list
items:
- variable:interfaceConfiguration
description:Interface Configuration
label:Interface Configuration
schema:
type:dict
$ref:
- "normalize/interfaceConfiguration"
attrs:
- variable:hostInterface
description:Please Specify Host Interface
label:Host Interface
schema:
type:string
required:true
$ref:
- "definitions/interface"
- variable:ipam
description:Define how IP Address will be managed
label:IP Address Management
schema:
type:dict
required:true
attrs:
- variable:type
description:Specify type for IPAM
label:IPAM Type
schema:
type:string
required:true
enum:
- value:dhcp
description:Use DHCP
- value:static
description:Use Static IP
show_subquestions_if:static
subquestions:
- variable:staticIPConfigurations
label:Static IP Addresses
schema:
type:list
items:
- variable:staticIP
label:Static IP
schema:
type:ipaddr
cidr:true
- variable:staticRoutes
label:Static Routes
schema:
type:list
items:
- variable:staticRouteConfiguration
label:Static Route Configuration
schema:
additional_attrs:true
type:dict
attrs:
- variable:destination
label:Destination
schema:
type:ipaddr
cidr:true
required:true
- variable:gateway
label:Gateway
schema:
type:ipaddr
cidr:false
required:true
- variable:serviceList
label:Add Manual Custom Services
group:Networking and Services
schema:
type:list
default:[]
items:
- variable:serviceListEntry
label:Custom Service
schema:
additional_attrs:true
type:dict
attrs:
- variable:enabled
label:Enable the service
schema:
type:boolean
default:true
hidden:true
- variable:name
label:Name
schema:
type:string
default:""
- variable:type
label:Service Type
description:"ClusterIP's are only internally available and Loadbalancer exposes the service using the system loadbalancer"
schema:
type:string
default:LoadBalancer
enum:
- value:LoadBalancer
description:LoadBalancer (Expose Ports)
- value:ClusterIP
description:ClusterIP (Do Not Expose Ports)
- value:Simple
description:Deprecated CHANGE THIS
- variable:loadBalancerIP
label:LoadBalancer IP
description:"MetalLB Only: Selects the Loadbalancer IP to expose on. Required when using PortalButton with MetalLB"
schema:
show_if:[["type","=","LoadBalancer"]]
type:string
default:""
- variable:advancedsvcset
label:Show Advanced Service Settings
schema:
type:boolean
default:false
show_subquestions_if:true
subquestions:
- variable:externalIPs
label:"External IP's"
description:"External IP's"
schema:
type:list
default:[]
items:
- variable:externalIP
label:External IP
schema:
type:string
- variable:ipFamilyPolicy
label:IP Family Policy
description:Specify the IP Policy
schema:
type:string
default:SingleStack
enum:
- value:SingleStack
description:SingleStack
- value:PreferDualStack
description:PreferDualStack
- value:RequireDualStack
description:RequireDualStack
- variable:ipFamilies
label:IP Families
description:(Advanced) The IP Families that should be used
schema:
type:list
default:[]
items:
- variable:ipFamily
label:IP Family
schema:
type:string
- variable:portsList
label:Additional Service Ports
schema:
type:list
default:[]
items:
- variable:portsListEntry
label:Custom ports
schema:
additional_attrs:true
type:dict
attrs:
- variable:enabled
label:Enable the Port
schema:
type:boolean
default:true
hidden:true
- variable:name
label:Port Name
schema:
type:string
default:""
- variable:protocol
label:Port Type
schema:
type:string
default:TCP
enum:
- value:HTTP
description:HTTP
- value:HTTPS
description:HTTPS
- value:TCP
description:TCP
- value:UDP
description:UDP
- variable:targetPort
label:Target Port
description:This port exposes the container port on the service
schema:
type:int
required:true
- variable:port
label:Container Port
schema:
type:int
required:true
- variable:persistence
label:Integrated Persistent Storage
description:Integrated Persistent Storage
group:Storage and Persistence
schema:
additional_attrs:true
type:dict
attrs:
- variable:media
label:App Media
description:Stores the Application Media
schema:
additional_attrs:true
type:dict
attrs:
- variable:type
label:Type of Storage
description:Sets the persistence type, Anything other than PVC could break rollback!
schema:
type:string
default:pvc
enum:
- value:pvc
description:PVC
- value:hostPath
description:Host Path
- value:emptyDir
description:emptyDir
- value:nfs
description:NFS Share
- variable:server
label:NFS Server
schema:
show_if:[["type","=","nfs"]]
type:string
default:""
- variable:path
label:Path on NFS Server
schema:
show_if:[["type","=","nfs"]]
type:string
default:""
- variable:setPermissions
label:Automatic Permissions
description:Automatically set permissions on install
schema:
show_if:[["type","=","hostPath"]]
type:boolean
default:false
- variable:readOnly
label:Read Only
schema:
type:boolean
default:false
- variable:hostPath
label:Host Path
description:Path inside the container the storage is mounted
schema:
show_if:[["type","=","hostPath"]]
type:hostpath
- variable:medium
label:EmptyDir Medium
schema:
show_if:[["type","=","emptyDir"]]
type:string
default:""
enum:
- value:""
description:Default
- value:Memory
description:Memory
- variable:size
label:Size quotum of Storage (Do NOT REDUCE after installation)
description:This value can ONLY be INCREASED after the installation
schema:
show_if:[["type","=","pvc"]]
type:string
default:256Gi
- variable:db
label:App DB
description:Stores the Application DB
schema:
additional_attrs:true
type:dict
attrs:
- variable:type
label:Type of Storage
description:Sets the persistence type, Anything other than PVC could break rollback!
schema:
type:string
default:pvc
enum:
- value:pvc
description:PVC
- value:hostPath
description:Host Path
- value:emptyDir
description:emptyDir
- value:nfs
description:NFS Share
- variable:server
label:NFS Server
schema:
show_if:[["type","=","nfs"]]
type:string
default:""
- variable:path
label:Path on NFS Server
schema:
show_if:[["type","=","nfs"]]
type:string
default:""
- variable:setPermissions
label:Automatic Permissions
description:Automatically set permissions on install
schema:
show_if:[["type","=","hostPath"]]
type:boolean
default:false
- variable:readOnly
label:Read Only
schema:
type:boolean
default:false
- variable:hostPath
label:Host Path
description:Path inside the container the storage is mounted
schema:
show_if:[["type","=","hostPath"]]
type:hostpath
- variable:medium
label:EmptyDir Medium
schema:
show_if:[["type","=","emptyDir"]]
type:string
default:""
enum:
- value:""
description:Default
- value:Memory
description:Memory
- variable:size
label:Size quotum of Storage (Do NOT REDUCE after installation)
description:This value can ONLY be INCREASED after the installation
schema:
show_if:[["type","=","pvc"]]
type:string
default:256Gi
- variable:persistenceList
label:Additional App Storage
group:Storage and Persistence
schema:
type:list
default:[]
items:
- variable:persistenceListEntry
label:Custom Storage
schema:
additional_attrs:true
type:dict
attrs:
- variable:enabled
label:Enable the storage
schema:
type:boolean
default:true
hidden:true
- variable:type
label:Type of Storage
description:Sets the persistence type, Anything other than PVC could break rollback!
schema:
type:string
default:hostPath
enum:
- value:pvc
description:PVC
- value:hostPath
description:Host Path
- value:emptyDir
description:emptyDir
- value:nfs
description:NFS Share
- variable:server
label:NFS Server
schema:
show_if:[["type","=","nfs"]]
type:string
default:""
- variable:path
label:Path on NFS Server
schema:
show_if:[["type","=","nfs"]]
type:string
default:""
- variable:setPermissions
label:Automatic Permissions
description:Automatically set permissions on install
schema:
show_if:[["type","=","hostPath"]]
type:boolean
default:false
- variable:readOnly
label:Read Only
schema:
type:boolean
default:false
- variable:hostPath
label:Host Path
description:Path inside the container the storage is mounted
schema:
show_if:[["type","=","hostPath"]]
type:hostpath
- variable:mountPath
label:Mount Path
description:Path inside the container the storage is mounted