From 39bf6c44bcae060b01937b58d1f856725dac7a59 Mon Sep 17 00:00:00 2001 From: William Lam Date: Mon, 22 May 2023 18:53:24 -0700 Subject: [PATCH 01/14] Update ESXi documentation to point to latest instructions (#6576) Signed-off-by: William Lam Co-authored-by: William Lam --- docs/docs/frigate/installation.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/docs/frigate/installation.md b/docs/docs/frigate/installation.md index 27e200541..b63bbf69d 100644 --- a/docs/docs/frigate/installation.md +++ b/docs/docs/frigate/installation.md @@ -234,9 +234,9 @@ To install make sure you have the [community app plugin here](https://forums.unr It is recommended to run Frigate in LXC for maximum performance. See [this discussion](https://github.com/blakeblackshear/frigate/discussions/1111) for more information. -## ESX +## ESXi -For details on running Frigate under ESX, see details [here](https://github.com/blakeblackshear/frigate/issues/305). +For details on running Frigate using ESXi, please see the instructions [here](https://williamlam.com/2023/05/frigate-nvr-with-coral-tpu-igpu-passthrough-using-esxi-on-intel-nuc.html). ## Synology NAS on DSM 7 From deec5b8bfd1f1ead5705e951a9edb0805331797f Mon Sep 17 00:00:00 2001 From: Blake Blackshear Date: Thu, 1 Jun 2023 07:30:41 -0400 Subject: [PATCH 02/14] fix build (#6668) --- docker/install_deps.sh | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docker/install_deps.sh b/docker/install_deps.sh index 4b6ea7923..f84087b9d 100755 --- a/docker/install_deps.sh +++ b/docker/install_deps.sh @@ -17,8 +17,9 @@ apt-get -qq install --no-install-recommends -y \ mkdir -p -m 600 /root/.gnupg # add coral repo -wget --quiet -O /usr/share/keyrings/google-edgetpu.gpg https://packages.cloud.google.com/apt/doc/apt-key.gpg -echo "deb [signed-by=/usr/share/keyrings/google-edgetpu.gpg] https://packages.cloud.google.com/apt coral-edgetpu-stable main" | tee /etc/apt/sources.list.d/coral-edgetpu.list +curl -fsSLo - https://packages.cloud.google.com/apt/doc/apt-key.gpg | \ + gpg --dearmor -o /etc/apt/trusted.gpg.d/google-cloud-packages-archive-keyring.gpg +echo "deb https://packages.cloud.google.com/apt coral-edgetpu-stable main" | tee /etc/apt/sources.list.d/coral-edgetpu.list echo "libedgetpu1-max libedgetpu/accepted-eula select true" | debconf-set-selections # enable non-free repo From 367d7244d37f4e48ce1760b319c0fe141ab58711 Mon Sep 17 00:00:00 2001 From: Sergey Krashevich Date: Sun, 11 Jun 2023 15:21:06 +0300 Subject: [PATCH 03/14] Update Double Take link to point to the maintained fork by skrashevich with improved features and fixed errors (#6746) --- docs/docs/integrations/third_party_extensions.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/docs/integrations/third_party_extensions.md b/docs/docs/integrations/third_party_extensions.md index 6c708d27d..30d3cad15 100644 --- a/docs/docs/integrations/third_party_extensions.md +++ b/docs/docs/integrations/third_party_extensions.md @@ -13,7 +13,8 @@ Please use your own knowledge to assess and vet them before you install anything ::: -## [Double Take](https://github.com/jakowenko/double-take) +## [Double Take](https://github.com/skrashevich/double-take) -[Double Take](https://github.com/jakowenko/double-take) provides an unified UI and API for processing and training images for facial recognition. +[Double Take](https://github.com/skrashevich/double-take) provides an unified UI and API for processing and training images for facial recognition. It supports automatically setting the sub labels in Frigate for person objects that are detected and recognized. +This is a fork (with fixed errors and new features) of [original Double Take](https://github.com/jakowenko/double-take) project which, unfortunately, isn't being maintained by author. From bd9942b426ce7e4557602b9333f816ad1dc7d914 Mon Sep 17 00:00:00 2001 From: Nicholas Flamy <30300649+NicholasFlamy@users.noreply.github.com> Date: Mon, 12 Jun 2023 00:07:34 +0400 Subject: [PATCH 04/14] Add FAQ about MQTT not connecting (#6554) * Update faqs.md I spent hours trying to figure this out and if this could be included in some way that would potentially help someone out there. * Update docs/docs/troubleshooting/faqs.md Co-authored-by: Nicolas Mowen * Update docs/docs/troubleshooting/faqs.md Co-authored-by: Nicolas Mowen * Update faqs.md --------- Co-authored-by: Nicolas Mowen Co-authored-by: Blake Blackshear --- docs/docs/troubleshooting/faqs.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/docs/troubleshooting/faqs.md b/docs/docs/troubleshooting/faqs.md index 4b166b037..9b736316f 100644 --- a/docs/docs/troubleshooting/faqs.md +++ b/docs/docs/troubleshooting/faqs.md @@ -40,3 +40,9 @@ If you see repeated "On connect called" messages in your logs, check for another ### Error: Database Is Locked SQLite does not work well on a network share, if the `/media` folder is mapped to a network share then [this guide](../configuration/advanced.md#database) should be used to move the database to a location on the internal drive. + +### Unable to publish to MQTT: client is not connected + +If MQTT isn't working in docker try using the IP of the device hosting the MQTT server instead of `localhost`, `127.0.0.1`, or `mosquitto.ix-mosquitto.svc.cluster.local`. + +This is because, by default, Frigate does not run in host mode so localhost points to the Frigate container and not the host device's network. From 730416418d195a9113cc1dac862e6ee48b7cea31 Mon Sep 17 00:00:00 2001 From: Daniel Asztalos Date: Wed, 14 Jun 2023 00:34:14 +0200 Subject: [PATCH 05/14] Typo fixed in hardware.md (#6788) --- docs/docs/frigate/hardware.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/frigate/hardware.md b/docs/docs/frigate/hardware.md index acbd2c7fd..fea92a422 100644 --- a/docs/docs/frigate/hardware.md +++ b/docs/docs/frigate/hardware.md @@ -31,7 +31,7 @@ My current favorite is the Minisforum GK41 because of the dual NICs that allow y ## Detectors -A detector is a device which is optimized for running inferences efficiently to detect objects. Using a recommended detector means there will be less latency between detections and more detections can be run per second. Frigate is designed around the epectation that a detector is used to achieve very low inference speeds. Offloading TensorFlow to a detector is an order of magnitude faster and will reduce your CPU load dramatically. As of 0.12, Frigate supports a handful of different detector types with varying inference speeds and performance. +A detector is a device which is optimized for running inferences efficiently to detect objects. Using a recommended detector means there will be less latency between detections and more detections can be run per second. Frigate is designed around the expectation that a detector is used to achieve very low inference speeds. Offloading TensorFlow to a detector is an order of magnitude faster and will reduce your CPU load dramatically. As of 0.12, Frigate supports a handful of different detector types with varying inference speeds and performance. ### Google Coral TPU From 8cb8a030bed6dcf0d73ef7436927e6684bc9f306 Mon Sep 17 00:00:00 2001 From: Nicolas Mowen Date: Fri, 30 Jun 2023 21:13:08 -0600 Subject: [PATCH 06/14] Update docs to reflect HA addon storage feature (#6681) * Clean up docs given HA addon storage support * Add guide for using HA network storage * Add to sidebar * Specify that media type needs to be used * Link to storage guide from install docs * Instruct users to store DB in /config * Update ha_network_storage.md * Recommend that data is moved or deleted --- docs/docs/frigate/installation.md | 33 +++---------------- docs/docs/guides/ha_network_storage.md | 45 ++++++++++++++++++++++++++ docs/sidebars.js | 1 + 3 files changed, 50 insertions(+), 29 deletions(-) create mode 100644 docs/docs/guides/ha_network_storage.md diff --git a/docs/docs/frigate/installation.md b/docs/docs/frigate/installation.md index b63bbf69d..eb6aed56c 100644 --- a/docs/docs/frigate/installation.md +++ b/docs/docs/frigate/installation.md @@ -159,12 +159,13 @@ docker run -d \ ghcr.io/blakeblackshear/frigate:stable ``` -## Home Assistant Operating System (HassOS) +## Home Assistant Addon :::caution +As of HomeAssistant OS 10.2 and Core 2023.6 defining separate storage for media is supported. + There are important limitations in Home Assistant Operating System to be aware of: -- Utilizing external storage for recordings or snapshots requires [modifying udev rules manually](https://community.home-assistant.io/t/solved-mount-usb-drive-in-hassio-to-be-used-on-the-media-folder-with-udev-customization/258406/46). - AMD GPUs are not supported because HA OS does not include the mesa driver. - Nvidia GPUs are not supported because addons do not support the nvidia runtime. @@ -172,7 +173,7 @@ There are important limitations in Home Assistant Operating System to be aware o :::tip -If possible, it is recommended to run Frigate standalone in Docker and use [Frigate's Proxy Addon](https://github.com/blakeblackshear/frigate-hass-addons/blob/main/frigate_proxy/README.md). +See [the network storage guide](/guides/ha_network_storage.md) for instructions to setup network storage for frigate. ::: @@ -195,32 +196,6 @@ There are several versions of the addon available: | Frigate NVR Beta | Beta release with protection mode on | | Frigate NVR Beta (Full Access) | Beta release with the option to disable protection mode | -## Home Assistant Supervised - -:::caution - -There are important limitations in Home Assistant Supervised to be aware of: -- Nvidia GPUs are not supported because addons do not support the nvidia runtime. - -::: - -:::tip - -If possible, it is recommended to run Frigate standalone in Docker and use [Frigate's Proxy Addon](https://github.com/blakeblackshear/frigate-hass-addons/blob/main/frigate_proxy/README.md). - -::: - -When running Home Assistant with the [Supervised install method](https://github.com/home-assistant/supervised-installer), you can get the benefit of running the Addon along with the ability to customize the storage used by Frigate. - -In order to customize the storage location for Frigate, simply use `fstab` to mount the drive you want at `/usr/share/hassio/media`. Here is an example fstab entry: - -```shell -UUID=1a65fec6-c25f-404a-b3d2-1f2fcf6095c8 /media/data ext4 defaults 0 0 -/media/data/homeassistant/media /usr/share/hassio/media none bind 0 0 -``` - -Then follow the instructions listed for [Home Assistant Operating System](#home-assistant-operating-system-hassos). - ## Kubernetes Use the [helm chart](https://github.com/blakeblackshear/blakeshome-charts/tree/master/charts/frigate). diff --git a/docs/docs/guides/ha_network_storage.md b/docs/docs/guides/ha_network_storage.md new file mode 100644 index 000000000..77bd79c53 --- /dev/null +++ b/docs/docs/guides/ha_network_storage.md @@ -0,0 +1,45 @@ +--- +id: ha_network_storage +title: HA Network Storage +--- + +As of HomeAsisstant Core 2023.6, Network Mounted Storage is supported for addons. + +## Setting Up Remote Storage For Frigate + +### Prerequisites + +- HA Core 2023.6 or newer is installed +- Running HA OS 10.2 or newer OR Running Supervised with latest os-agent installed (this is required for superivsed install) + +### Initial Setup + +1. Stop the Frigate addon +2. Update your config so the DB is stored in the /config directory by adding: +```yaml +database: + path: /config/frigate.db +``` + +### Move current data + +Keeping the current data is optional, but the data will need to be moved regardless so the share can be created successfully. + +#### If you want to keep the current data + +1. Move the frigate.db, frigate.db-shm, frigate.db-wal files to the /config directory +2. Rename the /media/frigate folder to /media/frigate_tmp + +#### If you don't want to keep the current data + +1. Delete the /media/frigate folder and all of its contents + +### Create the media share + +1. Go to **Settings -> System -> Storage -> Add Network Storage** +2. Name the share `frigate` (this is required) +3. Choose type `media` +4. Fill out the additional required info for your particular NAS +5. Connect +6. Move files from `/media/frigate_tmp` to `/media/frigate` if they were kept in previous step +7. Start the Frigate addon diff --git a/docs/sidebars.js b/docs/sidebars.js index 41628f2ed..70c572a70 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -11,6 +11,7 @@ module.exports = { "guides/configuring_go2rtc", "guides/false_positives", "guides/ha_notifications", + "guides/ha_network_storage", "guides/stationary_objects", "guides/reverse_proxy", ], From 3f509b6ff916b9e628fff7a0aa2fc9a52f8e5525 Mon Sep 17 00:00:00 2001 From: Nicolas Mowen Date: Thu, 6 Jul 2023 06:57:03 -0600 Subject: [PATCH 07/14] Update reolink docs to make go2rtc config more clear (#6985) --- docs/docs/configuration/camera_specific.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/docs/configuration/camera_specific.md b/docs/docs/configuration/camera_specific.md index 8de3837f5..a495ac3a3 100644 --- a/docs/docs/configuration/camera_specific.md +++ b/docs/docs/configuration/camera_specific.md @@ -108,21 +108,21 @@ According to [this discussion](https://github.com/blakeblackshear/frigate/issues ```yaml go2rtc: streams: - reolink: + your_reolink_camera: - http://reolink_ip/flv?port=1935&app=bcs&stream=channel0_main.bcs&user=username&password=password - - "ffmpeg:reolink#audio=opus" - reolink_sub: + - "ffmpeg:your_reolink_camera#audio=opus" + your_reolink_camera_sub: - http://reolink_ip/flv?port=1935&app=bcs&stream=channel0_ext.bcs&user=username&password=password cameras: reolink: ffmpeg: inputs: - - path: rtsp://127.0.0.1:8554/reolink?video=copy&audio=aac + - path: rtsp://127.0.0.1:8554/your_reolink_camera?video=copy&audio=aac input_args: preset-rtsp-restream roles: - record - - path: rtsp://127.0.0.1:8554/reolink_sub?video=copy + - path: rtsp://127.0.0.1:8554/your_reolink_camera_sub?video=copy input_args: preset-rtsp-restream roles: - detect From 1fd23f86aa93b9a5947c98d223ed8e251c710213 Mon Sep 17 00:00:00 2001 From: wire67 Date: Sat, 8 Jul 2023 19:52:22 +0800 Subject: [PATCH 08/14] Update ha_network_storage.md to make it clear which config file (#7084) * Update ha_network_storage.md to make it clear which config file * Update docs/docs/guides/ha_network_storage.md with relative url Co-authored-by: Nicolas Mowen --------- Co-authored-by: Nicolas Mowen --- docs/docs/guides/ha_network_storage.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/guides/ha_network_storage.md b/docs/docs/guides/ha_network_storage.md index 77bd79c53..498dd7d0c 100644 --- a/docs/docs/guides/ha_network_storage.md +++ b/docs/docs/guides/ha_network_storage.md @@ -15,7 +15,7 @@ As of HomeAsisstant Core 2023.6, Network Mounted Storage is supported for addons ### Initial Setup 1. Stop the Frigate addon -2. Update your config so the DB is stored in the /config directory by adding: +2. Update your [config](configuration/index.md) so the DB is stored in the /config directory by adding: ```yaml database: path: /config/frigate.db From 6a4f3174034eb7b2a542938af4db83cbbd0fbfcc Mon Sep 17 00:00:00 2001 From: Nicolas Mowen Date: Sun, 23 Jul 2023 06:48:14 -0600 Subject: [PATCH 09/14] Update reolink config (#7253) --- docs/docs/configuration/camera_specific.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/docs/configuration/camera_specific.md b/docs/docs/configuration/camera_specific.md index a495ac3a3..34ef13662 100644 --- a/docs/docs/configuration/camera_specific.md +++ b/docs/docs/configuration/camera_specific.md @@ -108,11 +108,18 @@ According to [this discussion](https://github.com/blakeblackshear/frigate/issues ```yaml go2rtc: streams: +<<<<<<< Updated upstream your_reolink_camera: - http://reolink_ip/flv?port=1935&app=bcs&stream=channel0_main.bcs&user=username&password=password - "ffmpeg:your_reolink_camera#audio=opus" your_reolink_camera_sub: - http://reolink_ip/flv?port=1935&app=bcs&stream=channel0_ext.bcs&user=username&password=password +======= + reolink: + - "ffmpeg:http://reolink_ip/flv?port=1935&app=bcs&stream=channel0_main.bcs&user=username&password=password#video=copy#audio=copy#audio=opus" + reolink_sub: + - "ffmpeg:http://reolink_ip/flv?port=1935&app=bcs&stream=channel0_ext.bcs&user=username&password=password" +>>>>>>> Stashed changes cameras: reolink: From 157b160b9db1828edaae6065208d46af8c0eec4e Mon Sep 17 00:00:00 2001 From: Sean Kelly Date: Sun, 23 Jul 2023 09:52:41 -0700 Subject: [PATCH 10/14] Resolve conflict (#7264) --- docs/docs/configuration/camera_specific.md | 10 +--------- 1 file changed, 1 insertion(+), 9 deletions(-) diff --git a/docs/docs/configuration/camera_specific.md b/docs/docs/configuration/camera_specific.md index 34ef13662..2b355d4ac 100644 --- a/docs/docs/configuration/camera_specific.md +++ b/docs/docs/configuration/camera_specific.md @@ -108,18 +108,10 @@ According to [this discussion](https://github.com/blakeblackshear/frigate/issues ```yaml go2rtc: streams: -<<<<<<< Updated upstream your_reolink_camera: - - http://reolink_ip/flv?port=1935&app=bcs&stream=channel0_main.bcs&user=username&password=password - - "ffmpeg:your_reolink_camera#audio=opus" - your_reolink_camera_sub: - - http://reolink_ip/flv?port=1935&app=bcs&stream=channel0_ext.bcs&user=username&password=password -======= - reolink: - "ffmpeg:http://reolink_ip/flv?port=1935&app=bcs&stream=channel0_main.bcs&user=username&password=password#video=copy#audio=copy#audio=opus" - reolink_sub: + your_reolink_camera_sub: - "ffmpeg:http://reolink_ip/flv?port=1935&app=bcs&stream=channel0_ext.bcs&user=username&password=password" ->>>>>>> Stashed changes cameras: reolink: From c815f3c33191f7ce7e6b87dd3ab61b9a4646a084 Mon Sep 17 00:00:00 2001 From: Nicolas Mowen Date: Sat, 19 Aug 2023 12:41:26 -0600 Subject: [PATCH 11/14] Clarify go2rtc requirement for ha integration (#7503) --- docs/docs/guides/configuring_go2rtc.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/docs/guides/configuring_go2rtc.md b/docs/docs/guides/configuring_go2rtc.md index cc3ff8681..f4b246911 100644 --- a/docs/docs/guides/configuring_go2rtc.md +++ b/docs/docs/guides/configuring_go2rtc.md @@ -6,7 +6,8 @@ title: Configuring go2rtc Use of the bundled go2rtc is optional. You can still configure FFmpeg to connect directly to your cameras. However, adding go2rtc to your configuration is required for the following features: - WebRTC or MSE for live viewing with higher resolutions and frame rates than the jsmpeg stream which is limited to the detect stream -- RTSP (instead of RTMP) relay for use with Home Assistant or other consumers to reduce the number of connections to your camera streams +- Live stream support for cameras in Home Assistant Integration +- RTSP (instead of RTMP) relay for use with other consumers to reduce the number of connections to your camera streams # Setup a go2rtc stream From 6146afe8f70a255fef977630d7c8351824775618 Mon Sep 17 00:00:00 2001 From: Nicolas Mowen Date: Sat, 19 Aug 2023 15:19:52 -0600 Subject: [PATCH 12/14] Make clear only network storage is supported for addon (#7505) * Make clear only network storage is supported for addon * fix typo Co-authored-by: Blake Blackshear --------- Co-authored-by: Blake Blackshear --- docs/docs/frigate/installation.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/docs/frigate/installation.md b/docs/docs/frigate/installation.md index eb6aed56c..a15bd8d6c 100644 --- a/docs/docs/frigate/installation.md +++ b/docs/docs/frigate/installation.md @@ -163,9 +163,10 @@ docker run -d \ :::caution -As of HomeAssistant OS 10.2 and Core 2023.6 defining separate storage for media is supported. +As of HomeAssistant OS 10.2 and Core 2023.6 defining separate network storage for media is supported. There are important limitations in Home Assistant Operating System to be aware of: +- Separate local storage for media is not yet supported by Home Assistant - AMD GPUs are not supported because HA OS does not include the mesa driver. - Nvidia GPUs are not supported because addons do not support the nvidia runtime. From f25bee76728a038926b468a5548949afbc82ee9e Mon Sep 17 00:00:00 2001 From: Nicolas Mowen Date: Fri, 1 Sep 2023 05:59:08 -0600 Subject: [PATCH 13/14] Remove custom model example from basic coral docs (#7639) --- docs/docs/configuration/detectors.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/docs/configuration/detectors.md b/docs/docs/configuration/detectors.md index 63004846c..83291605f 100644 --- a/docs/docs/configuration/detectors.md +++ b/docs/docs/configuration/detectors.md @@ -42,8 +42,6 @@ detectors: coral: type: edgetpu device: usb - model: - path: "/custom_model.tflite" ``` ### Multiple USB Corals From a63af1a891b228ee6a51783ec15686a7587a0233 Mon Sep 17 00:00:00 2001 From: flyize Date: Mon, 4 Sep 2023 11:12:24 -0400 Subject: [PATCH 14/14] Update false_positives.md (#7685) Mention about false positives from stationary objects. Added because I just had this issue and the current page didn't really help me. --- docs/docs/guides/false_positives.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/docs/guides/false_positives.md b/docs/docs/guides/false_positives.md index 84d67a3b0..6102fd63b 100644 --- a/docs/docs/guides/false_positives.md +++ b/docs/docs/guides/false_positives.md @@ -21,3 +21,5 @@ For object filters in your configuration, any single detection below `min_score` | 6 | 0.95 | 0.7, 0.85, 0.95, 0.90, 0.88, 0.95 | 0.89 | Yes | In frame 2, the score is below the `min_score` value, so Frigate ignores it and it becomes a 0.0. The computed score is the median of the score history (padding to at least 3 values), and only when that computed score crosses the `threshold` is the object marked as a true positive. That happens in frame 4 in the example. + +If you're seeing false positives from stationary objects, please see Object Masks here: https://docs.frigate.video/configuration/masks/