truenas/community/frigate/app_versions.json

{
    "1.1.2": {
        "healthy": true,
        "supported": true,
        "healthy_error": null,
        "location": "/__w/charts/charts/community/frigate/1.1.2",
        "last_update": "2023-11-14 10:11:57",
        "required_features": [
            "normalize/ixVolume",
            "definitions/gpuConfiguration"
        ],
        "human_version": "0.12.1_1.1.2",
        "version": "1.1.2",
        "chart_metadata": {
            "name": "frigate",
            "description": "Frigate is an NVR With Realtime Object Detection for IP Cameras",
            "annotations": {
                "title": "Frigate"
            },
            "type": "application",
            "version": "1.1.2",
            "apiVersion": "v2",
            "appVersion": "0.12.1",
            "kubeVersion": ">=1.16.0-0",
            "maintainers": [
                {
                    "name": "truenas",
                    "url": "https://www.truenas.com/",
                    "email": "dev@ixsystems.com"
                }
            ],
            "dependencies": [
                {
                    "name": "common",
                    "repository": "file://../../../common",
                    "version": "1.2.2"
                }
            ],
            "home": "https://github.com/blakeblackshear/frigate",
            "icon": "https://media.sys.truenas.net/apps/frigate/icons/icon.svg",
            "sources": [
                "https://github.com/truenas/charts/tree/master/library/ix-dev/community/frigate",
                "https://github.com/blakeblackshear/frigate"
            ],
            "keywords": [
                "camera",
                "nvr"
            ]
        },
        "app_metadata": {
            "runAsContext": [
                {
                    "userName": "root",
                    "groupName": "root",
                    "gid": 0,
                    "uid": 0,
                    "description": "Frigate runs as root user. When USB Bus is mounted, it is able to escalate privileges."
                }
            ],
            "capabilities": [
                {
                    "name": "CHOWN",
                    "description": "Frigate is able to chown files."
                },
                {
                    "name": "FOWNER",
                    "description": "Frigate are able to bypass permission checks for it's sub-processes."
                },
                {
                    "name": "DAC_OVERRIDE",
                    "description": "Frigate is able to bypass permission checks."
                },
                {
                    "name": "SETGID",
                    "description": "Frigate is able to set group ID for it's sub-processes."
                },
                {
                    "name": "SETUID",
                    "description": "Frigate is able to set user ID for it's sub-processes."
                }
            ],
            "hostMounts": []
        },
        "schema": {
            "groups": [
                {
                    "name": "Frigate Configuration",
                    "description": "Configure Frigate"
                },
                {
                    "name": "Network Configuration",
                    "description": "Configure Network for Frigate"
                },
                {
                    "name": "Storage Configuration",
                    "description": "Configure Storage for Frigate"
                },
                {
                    "name": "Resources Configuration",
                    "description": "Configure Resources for Frigate"
                }
            ],
            "portals": {
                "web_portal": {
                    "protocols": [
                        "$kubernetes-resource_configmap_portal_protocol"
                    ],
                    "host": [
                        "$kubernetes-resource_configmap_portal_host"
                    ],
                    "ports": [
                        "$kubernetes-resource_configmap_portal_port"
                    ],
                    "path": "$kubernetes-resource_configmap_portal_path"
                }
            },
            "questions": [
                {
                    "variable": "frigateConfig",
                    "label": "",
                    "group": "Frigate Configuration",
                    "schema": {
                        "type": "dict",
                        "attrs": [
                            {
                                "variable": "mountUSBBus",
                                "label": "Mount USB Bus",
                                "description": "Mount the USB bus to the container.</br>\nThis is required if you want to use USB devices, like Coral</br>\nThis will mount the USB bus to /dev/bus/usb inside the container.\n",
                                "schema": {
                                    "type": "boolean",
                                    "default": false
                                }
                            },
                            {
                                "variable": "additionalEnvs",
                                "label": "Additional Environment Variables",
                                "description": "Configure additional environment variables for Frigate.",
                                "schema": {
                                    "type": "list",
                                    "default": [],
                                    "items": [
                                        {
                                            "variable": "env",
                                            "label": "Environment Variable",
                                            "schema": {
                                                "type": "dict",
                                                "attrs": [
                                                    {
                                                        "variable": "name",
                                                        "label": "Name",
                                                        "schema": {
                                                            "type": "string",
                                                            "required": true
                                                        }
                                                    },
                                                    {
                                                        "variable": "value",
                                                        "label": "Value",
                                                        "schema": {
                                                            "type": "string",
                                                            "required": true
                                                        }
                                                    }
                                                ]
                                            }
                                        }
                                    ]
                                }
                            }
                        ]
                    }
                },
                {
                    "variable": "frigateNetwork",
                    "label": "",
                    "group": "Network Configuration",
                    "schema": {
                        "type": "dict",
                        "attrs": [
                            {
                                "variable": "hostNetwork",
                                "label": "Host Network",
                                "description": "Bind to the host network. It's recommended to keep this disabled.</br>\n",
                                "schema": {
                                    "type": "boolean",
                                    "default": false,
                                    "show_subquestions_if": false,
                                    "subquestions": [
                                        {
                                            "variable": "webPort",
                                            "label": "Web Port",
                                            "description": "The port for the Frigate Web UI.</br>\nInternal port: 5000\n",
                                            "schema": {
                                                "type": "int",
                                                "default": 30058,
                                                "min": 9000,
                                                "max": 65535,
                                                "required": true
                                            }
                                        },
                                        {
                                            "variable": "enableRtmp",
                                            "label": "Enable RTMP",
                                            "description": "Enable RTMP for Frigate.",
                                            "schema": {
                                                "type": "boolean",
                                                "default": false
                                            }
                                        },
                                        {
                                            "variable": "rtmpPort",
                                            "label": "RTMP Port",
                                            "description": "The RTMP port for Frigate.</br>\nInternal port: 1935\n",
                                            "schema": {
                                                "type": "int",
                                                "default": 30059,
                                                "show_if": [
                                                    [
                                                        "enableRtmp",
                                                        "=",
                                                        true
                                                    ]
                                                ],
                                                "min": 9000,
                                                "max": 65535,
                                                "required": true
                                            }
                                        },
                                        {
                                            "variable": "enableRtsp",
                                            "label": "Enable RTSP",
                                            "description": "Enable RTSP for Frigate.",
                                            "schema": {
                                                "type": "boolean",
                                                "default": false
                                            }
                                        },
                                        {
                                            "variable": "rtspPort",
                                            "label": "RTSP Port",
                                            "description": "The RTSP port for Frigate.</br>\nInternal port: 8554\n",
                                            "schema": {
                                                "type": "int",
                                                "default": 30060,
                                                "show_if": [
                                                    [
                                                        "enableRtsp",
                                                        "=",
                                                        true
                                                    ]
                                                ],
                                                "min": 9000,
                                                "max": 65535,
                                                "required": true
                                            }
                                        },
                                        {
                                            "variable": "enableWebRtc",
                                            "label": "Enable WebRTC",
                                            "description": "Enable WebRTC for Frigate.",
                                            "schema": {
                                                "type": "boolean",
                                                "default": false
                                            }
                                        },
                                        {
                                            "variable": "webRtcPort",
                                            "label": "WebRTC Port",
                                            "description": "The WebRTC port for Frigate.</br>\nInternal port: 8555</br>\nApplies to both TCP and UDP.\n",
                                            "schema": {
                                                "type": "int",
                                                "default": 30061,
                                                "show_if": [
                                                    [
                                                        "enableWebRtc",
                                                        "=",
                                                        true
                                                    ]
                                                ],
                                                "min": 9000,
                                                "max": 65535,
                                                "required": true
                                            }
                                        }
                                    ]
                                }
                            }
                        ]
                    }
                },
                {
                    "variable": "frigateStorage",
                    "label": "",
                    "group": "Storage Configuration",
                    "schema": {
                        "type": "dict",
                        "attrs": [
                            {
                                "variable": "config",
                                "label": "Frigate Config Storage",
                                "description": "The path to store Frigate Configuration.",
                                "schema": {
                                    "type": "dict",
                                    "attrs": [
                                        {
                                            "variable": "type",
                                            "label": "Type",
                                            "description": "ixVolume: Is dataset created automatically by the system.</br>\nHost Path: Is a path that already exists on the system.\n",
                                            "schema": {
                                                "type": "string",
                                                "required": true,
                                                "immutable": true,
                                                "default": "ixVolume",
                                                "enum": [
                                                    {
                                                        "value": "hostPath",
                                                        "description": "Host Path (Path that already exists on the system)"
                                                    },
                                                    {
                                                        "value": "ixVolume",
                                                        "description": "ixVolume (Dataset created automatically by the system)"
                                                    }
                                                ]
                                            }
                                        },
                                        {
                                            "variable": "datasetName",
                                            "label": "Dataset Name",
                                            "schema": {
                                                "type": "string",
                                                "show_if": [
                                                    [
                                                        "type",
                                                        "=",
                                                        "ixVolume"
                                                    ]
                                                ],
                                                "required": true,
                                                "hidden": true,
                                                "immutable": true,
                                                "default": "config",
                                                "$ref": [
                                                    "normalize/ixVolume"
                                                ]
                                            }
                                        },
                                        {
                                            "variable": "hostPath",
                                            "label": "Host Path",
                                            "schema": {
                                                "type": "hostpath",
                                                "show_if": [
                                                    [
                                                        "type",
                                                        "=",
                                                        "hostPath"
                                                    ]
                                                ],
                                                "immutable": true,
                                                "required": true
                                            }
                                        }
                                    ]
                                }
                            },
                            {
                                "variable": "media",
                                "label": "Frigate Media Storage",
                                "description": "The path to store Frigate Media.",
                                "schema": {
                                    "type": "dict",
                                    "attrs": [
                                        {
                                            "variable": "type",
                                            "label": "Type",
                                            "description": "ixVolume: Is dataset created automatically by the system.</br>\nHost Path: Is a path that already exists on the system.\n",
                                            "schema": {
                                                "type": "string",
                                                "required": true,
                                                "immutable": true,
                                                "default": "ixVolume",
                                                "enum": [
                                                    {
                                                        "value": "hostPath",
                                                        "description": "Host Path (Path that already exists on the system)"
                                                    },
                                                    {
                                                        "value": "ixVolume",
                                                        "description": "ixVolume (Dataset created automatically by the system)"
                                                    }
                                                ]
                                            }
                                        },
                                        {
                                            "variable": "datasetName",
                                            "label": "Dataset Name",
                                            "schema": {
                                                "type": "string",
                                                "show_if": [
                                                    [
                                                        "type",
                                                        "=",
                                                        "ixVolume"
                                                    ]
                                                ],
                                                "required": true,
                                                "hidden": true,
                                                "immutable": true,
                                                "default": "config",
                                                "$ref": [
                                                    "normalize/ixVolume"
                                                ]
                                            }
                                        },
                                        {
                                            "variable": "hostPath",
                                            "label": "Host Path",
                                            "schema": {
                                                "type": "hostpath",
                                                "show_if": [
                                                    [
                                                        "type",
                                                        "=",
                                                        "hostPath"
                                                    ]
                                                ],
                                                "immutable": true,
                                                "required": true
                                            }
                                        }
                                    ]
                                }
                            },
                            {
                                "variable": "cache",
                                "label": "Frigate Cache Storage",
                                "schema": {
                                    "type": "dict",
                                    "attrs": [
                                        {
                                            "variable": "sizeGiB",
                                            "label": "Size (GiB)",
                                            "description": "The size of RAM is allowed to Frigate to use as cache",
                                            "schema": {
                                                "type": "int",
                                                "max": 4,
                                                "default": 1,
                                                "required": true
                                            }
                                        }
                                    ]
                                }
                            },
                            {
                                "variable": "shm",
                                "label": "Frigate /dev/shm Storage",
                                "schema": {
                                    "type": "dict",
                                    "attrs": [
                                        {
                                            "variable": "sizeMiB",
                                            "label": "Size (MiB)",
                                            "description": "The size of RAM is allowed to Frigate to use as /dev/shm</br>\nhttps://docs.frigate.video/frigate/installation/#calculating-required-shm-size\n",
                                            "schema": {
                                                "type": "int",
                                                "max": 2048,
                                                "default": 64,
                                                "required": true
                                            }
                                        }
                                    ]
                                }
                            },
                            {
                                "variable": "additionalStorages",
                                "label": "Additional Storage",
                                "description": "Additional storage for Frigate.",
                                "schema": {
                                    "type": "list",
                                    "default": [],
                                    "items": [
                                        {
                                            "variable": "storageEntry",
                                            "label": "Storage Entry",
                                            "schema": {
                                                "type": "dict",
                                                "attrs": [
                                                    {
                                                        "variable": "type",
                                                        "label": "Type",
                                                        "description": "ixVolume: Is dataset created automatically by the system.</br>\nHost Path: Is a path that already exists on the system.</br>\nSMB Share: Is a SMB share that is mounted to a persistent volume claim.\n",
                                                        "schema": {
                                                            "type": "string",
                                                            "required": true,
                                                            "default": "ixVolume",
                                                            "immutable": true,
                                                            "enum": [
                                                                {
                                                                    "value": "hostPath",
                                                                    "description": "Host Path (Path that already exists on the system)"
                                                                },
                                                                {
                                                                    "value": "ixVolume",
                                                                    "description": "ixVolume (Dataset created automatically by the system)"
                                                                },
                                                                {
                                                                    "value": "smb-pv-pvc",
                                                                    "description": "SMB Share (Mounts a persistent volume claim to a SMB share)"
                                                                }
                                                            ]
                                                        }
                                                    },
                                                    {
                                                        "variable": "mountPath",
                                                        "label": "Mount Path",
                                                        "description": "The path inside the container to mount the storage.",
                                                        "schema": {
                                                            "type": "path",
                                                            "required": true
                                                        }
                                                    },
                                                    {
                                                        "variable": "hostPath",
                                                        "label": "Host Path",
                                                        "description": "The host path to use for storage.",
                                                        "schema": {
                                                            "type": "hostpath",
                                                            "show_if": [
                                                                [
                                                                    "type",
                                                                    "=",
                                                                    "hostPath"
                                                                ]
                                                            ],
                                                            "required": true
                                                        }
                                                    },
                                                    {
                                                        "variable": "datasetName",
                                                        "label": "Dataset Name",
                                                        "description": "The name of the dataset to use for storage.",
                                                        "schema": {
                                                            "type": "string",
                                                            "show_if": [
                                                                [
                                                                    "type",
                                                                    "=",
                                                                    "ixVolume"
                                                                ]
                                                            ],
                                                            "required": true,
                                                            "immutable": true,
                                                            "default": "storage_entry",
                                                            "$ref": [
                                                                "normalize/ixVolume"
                                                            ]
                                                        }
                                                    },
                                                    {
                                                        "variable": "server",
                                                        "label": "Server",
                                                        "description": "The server for the SMB share.",
                                                        "schema": {
                                                            "type": "string",
                                                            "show_if": [
                                                                [
                                                                    "type",
                                                                    "=",
                                                                    "smb-pv-pvc"
                                                                ]
                                                            ],
                                                            "required": true
                                                        }
                                                    },
                                                    {
                                                        "variable": "share",
                                                        "label": "Share",
                                                        "description": "The share name for the SMB share.",
                                                        "schema": {
                                                            "type": "string",
                                                            "show_if": [
                                                                [
                                                                    "type",
                                                                    "=",
                                                                    "smb-pv-pvc"
                                                                ]
                                                            ],
                                                            "required": true
                                                        }
                                                    },
                                                    {
                                                        "variable": "domain",
                                                        "label": "Domain (Optional)",
                                                        "description": "The domain for the SMB share.",
                                                        "schema": {
                                                            "type": "string",
                                                            "show_if": [
                                                                [
                                                                    "type",
                                                                    "=",
                                                                    "smb-pv-pvc"
                                                                ]
                                                            ]
                                                        }
                                                    },
                                                    {
                                                        "variable": "username",
                                                        "label": "Username",
                                                        "description": "The username for the SMB share.",
                                                        "schema": {
                                                            "type": "string",
                                                            "show_if": [
                                                                [
                                                                    "type",
                                                                    "=",
                                                                    "smb-pv-pvc"
                                                                ]
                                                            ],
                                                            "required": true
                                                        }
                                                    },
                                                    {
                                                        "variable": "password",
                                                        "label": "Password",
                                                        "description": "The password for the SMB share.",
                                                        "schema": {
                                                            "type": "string",
                                                            "show_if": [
                                                                [
                                                                    "type",
                                                                    "=",
                                                                    "smb-pv-pvc"
                                                                ]
                                                            ],
                                                            "required": true,
                                                            "private": true
                                                        }
                                                    },
                                                    {
                                                        "variable": "size",
                                                        "label": "Size (in Gi)",
                                                        "description": "The size of the volume quota.",
                                                        "schema": {
                                                            "type": "int",
                                                            "show_if": [
                                                                [
                                                                    "type",
                                                                    "=",
                                                                    "smb-pv-pvc"
                                                                ]
                                                            ],
                                                            "required": true,
                                                            "min": 1,
                                                            "default": 1
                                                        }
                                                    }
                                                ]
                                            }
                                        }
                                    ]
                                }
                            }
                        ]
                    }
                },
                {
                    "variable": "resources",
                    "group": "Resources Configuration",
                    "label": "",
                    "schema": {
                        "type": "dict",
                        "attrs": [
                            {
                                "variable": "limits",
                                "label": "Limits",
                                "schema": {
                                    "type": "dict",
                                    "attrs": [
                                        {
                                            "variable": "cpu",
                                            "label": "CPU",
                                            "description": "CPU limit for Frigate.",
                                            "schema": {
                                                "type": "string",
                                                "max_length": 6,
                                                "valid_chars": "^(0\\.[1-9]|[1-9][0-9]*)(\\.[0-9]|m?)$",
                                                "valid_chars_error": "Valid CPU limit formats are</br>\n- Plain Integer - eg. 1</br>\n- Float - eg. 0.5</br>\n- Milicpu - eg. 500m\n",
                                                "default": "4000m",
                                                "required": true
                                            }
                                        },
                                        {
                                            "variable": "memory",
                                            "label": "Memory",
                                            "description": "Memory limit for Frigate.",
                                            "schema": {
                                                "type": "string",
                                                "max_length": 12,
                                                "valid_chars": "^[1-9][0-9]*([EPTGMK]i?|e[0-9]+)?$",
                                                "valid_chars_error": "Valid Memory limit formats are</br>\n- Suffixed with E/P/T/G/M/K - eg. 1G</br>\n- Suffixed with Ei/Pi/Ti/Gi/Mi/Ki - eg. 1Gi</br>\n- Plain Integer in bytes - eg. 1024</br>\n- Exponent - eg. 134e6\n",
                                                "default": "8Gi",
                                                "required": true
                                            }
                                        }
                                    ]
                                }
                            }
                        ]
                    }
                },
                {
                    "variable": "frigateGPU",
                    "group": "Resources Configuration",
                    "label": "GPU Configuration",
                    "schema": {
                        "type": "dict",
                        "$ref": [
                            "definitions/gpuConfiguration"
                        ],
                        "attrs": []
                    }
                }
            ]
        },
        "app_readme": "<h1>Frigate</h1>\n<p><a href=\"https://github.com/frigate/frigate\">Frigate</a> is an NVR With Realtime Object Detection for IP Cameras</p>\n<blockquote>\n<p>Note: <strong>m.2</strong> Coral TPU devices is not supported.</p>\n</blockquote>",
        "detailed_readme": "<h1>Frigate</h1>\n<p><a href=\"https://github.com/frigate/frigate\">Frigate</a> is an NVR With Realtime Object Detection for IP Cameras</p>\n<blockquote>\n<p>Note: <strong>m.2</strong> Coral TPU devices is not supported.</p>\n</blockquote>",
        "changelog": null
    }
}