From 0735a8ac756076d87963c64b7594ad8c9806c5bf Mon Sep 17 00:00:00 2001 From: Josh Hawkins <32435876+hawkeye217@users.noreply.github.com> Date: Mon, 10 Aug 2026 16:54:41 -0500 Subject: [PATCH] Docs updates (#23947) * misc docs updates * add warning about proxies to 5000 for notifications --- docs/docs/configuration/cameras.md | 25 ++++++++++++++++++++++++ docs/docs/configuration/notifications.md | 8 +++++++- docs/docs/integrations/mqtt.md | 2 ++ docs/docs/troubleshooting/faqs.md | 12 ++++++++++-- 4 files changed, 44 insertions(+), 3 deletions(-) diff --git a/docs/docs/configuration/cameras.md b/docs/docs/configuration/cameras.md index 5fa3223898..640b78841f 100644 --- a/docs/docs/configuration/cameras.md +++ b/docs/docs/configuration/cameras.md @@ -50,6 +50,31 @@ Connect each stream to get a live preview, an estimated bandwidth figure, and a Other features, including [hardware acceleration](hardware_acceleration_video.md), [two way talk](/configuration/live#two-way-talk), and audio transcoding, is configured after the camera has been added. For camera model specific quirks, see the [camera specific](camera_specific.md) docs. +## Deleting a camera + +Click **Delete Camera** in , choose the camera, and confirm. Deleting a camera requires the `admin` role and cannot be undone. + +:::warning + +Deleting a camera permanently removes its recordings, tracked objects, and configuration. If you only want to stop processing a camera, set its state to **Off** or **Disabled** in instead. See [camera state](/configuration/live#camera-state). + +::: + +Deleting a camera removes: + +- The camera's section of your config file, along with its entries in any [role](authentication.md#user-roles) camera list. A custom role left with no cameras is removed as well. +- Every database record for the camera: tracked objects, review items, recordings, previews, timeline entries, the saved region grid, and [triggers](semantic_search.md#triggers). +- Every media file for the camera: recordings, snapshots, thumbnails, and preview clips. + +[Exports](/usage/exports) are kept by default, so saved footage survives the deletion of the camera it came from. Turn on **Also delete exports for this camera** in the confirmation step to remove those too. + +The camera's processes are stopped and the change takes effect immediately, so no restart is required. If the resulting config cannot be parsed, Frigate restores the previous config and reports an error instead of leaving Frigate in a broken state. + +Two things are not cleaned up for you: + +- **go2rtc streams.** Frigate makes a best effort to stop a running [go2rtc](go2rtc.md) stream named after the camera, but stream entries in your config file remain and are recreated on the next restart. Remove them in or in your config file. +- **Camera groups.** A deleted camera stays listed in any [camera group](#setting-up-camera-groups) that referenced it. The group skips the missing camera, so this is harmless, but you can edit the group to drop the stale entry. + ## Setting Up Camera Inputs Several inputs can be configured for each camera and the role of each input can be mixed and matched based on your needs. This allows you to use a lower resolution stream for object detection, but create recordings from a higher resolution stream, or vice versa. diff --git a/docs/docs/configuration/notifications.md b/docs/docs/configuration/notifications.md index 01ea2e7c41..67b4f2374d 100644 --- a/docs/docs/configuration/notifications.md +++ b/docs/docs/configuration/notifications.md @@ -22,7 +22,7 @@ Push notifications require internet access from the Frigate server to the browse In order to use notifications the following requirements must be met: -- Frigate must be accessed via a secure `https` connection ([see the authorization docs](/configuration/authentication)). +- Frigate must be accessed via a secure `https` connection while signed in as a Frigate user ([see the authorization docs](/configuration/authentication)). - A supported browser must be used. Currently Chrome, Firefox, and Safari are known to be supported. - In order for notifications to be usable externally, Frigate must be accessible externally. - For iOS devices, some users have also indicated that the Notifications switch needs to be enabled in iOS Settings --> Apps --> Safari --> Advanced --> Features. @@ -88,6 +88,12 @@ cameras: Once notifications are enabled, press the `Register This Device` button on all devices that you would like to receive notifications on. This will register the background worker. After this Frigate must be restarted and then notifications will begin to be sent. +:::warning + +Each registration is attached to the Frigate user account you are signed in as, so you must register over a secure connection to the authenticated port (`8971`). Reverse proxies and tunnels should point at port `8971`. + +::: + ## Supported Notifications Currently notifications are only supported for review alerts. More notifications will be supported in the future. diff --git a/docs/docs/integrations/mqtt.md b/docs/docs/integrations/mqtt.md index 08c3926ffd..6a9bdeb324 100644 --- a/docs/docs/integrations/mqtt.md +++ b/docs/docs/integrations/mqtt.md @@ -308,6 +308,8 @@ Publishes the current health status of each role that is enabled (`audio`, `dete - `offline`: Stream is offline and is being restarted - `disabled`: Camera is currently turned off (either at runtime via the `enabled/set` topic, or persistently via the configuration file). See [Camera state](/configuration/live#camera-state) for the distinction. +These reflect the state of Frigate's process for that role, not the camera's reachability, so an unreachable camera alternates between `offline` and `online` as the watchdog restarts ffmpeg. Wait for the status to hold steady (for example with Home Assistant's `for:`) rather than acting on a single message. + ### `frigate//` Publishes the count of objects for the camera for use as a sensor in Home Assistant. diff --git a/docs/docs/troubleshooting/faqs.md b/docs/docs/troubleshooting/faqs.md index 1a51cb64e2..46c08b9bd0 100644 --- a/docs/docs/troubleshooting/faqs.md +++ b/docs/docs/troubleshooting/faqs.md @@ -65,9 +65,17 @@ This is because Frigate does not run in host mode so localhost points to the Fri ### How do I know if my camera is offline -A camera being offline can be detected via MQTT or /api/stats, the camera_fps for any offline camera will be 0. +Frigate publishes a per-role health status to [`frigate//status/`](/integrations/mqtt#frigatecamera_namestatusrole), where `` is each enabled role on the camera (`detect`, `record`, and `audio`). The published value is one of: -Also, Home Assistant will mark any offline camera as being unavailable when the camera is offline. +- `online`: Frigate's process for that role is running normally +- `offline`: the process is down and Frigate is restarting it +- `disabled`: the camera is turned off, either at runtime or in the configuration file + +These reflect the state of Frigate's process for that role, not the camera's reachability, so an unreachable camera alternates between `offline` and `online` as the watchdog restarts ffmpeg. Wait for the status to hold steady (for example with Home Assistant's `for:`) rather than acting on a single message. + +Because the status is per role, a camera whose substream is fine but whose recording stream has dropped will report `online` for `detect` and `offline` for `record`. The status is republished whenever it changes. + +You can also detect an offline camera through `/api/stats`, where `camera_fps` will be 0. ### How can I view the Frigate log files without using the Web UI?