From 7a47c0893794eb3fb8d52fdc45bde0046e2d6755 Mon Sep 17 00:00:00 2001 From: Josh Hawkins <32435876+hawkeye217@users.noreply.github.com> Date: Wed, 4 Mar 2026 12:07:08 -0600 Subject: [PATCH] adopt official HA language, change add-on to app --- docs/docs/configuration/authentication.md | 2 +- .../hardware_acceleration_video.md | 7 ++--- docs/docs/configuration/index.md | 16 ++++++------ docs/docs/configuration/live.md | 21 ++++----------- docs/docs/development/contributing.md | 6 ++--- docs/docs/frigate/installation.md | 26 +++++++++---------- docs/docs/frigate/updating.md | 24 ++++++++--------- docs/docs/guides/configuring_go2rtc.md | 8 ++---- docs/docs/guides/getting_started.md | 14 +++++----- docs/docs/guides/ha_network_storage.md | 6 ++--- docs/docs/integrations/home-assistant.md | 6 ++--- docs/docs/integrations/plus.md | 4 +-- docs/docs/troubleshooting/edgetpu.md | 2 +- 13 files changed, 64 insertions(+), 78 deletions(-) diff --git a/docs/docs/configuration/authentication.md b/docs/docs/configuration/authentication.md index 70f756b68..a312b5944 100644 --- a/docs/docs/configuration/authentication.md +++ b/docs/docs/configuration/authentication.md @@ -86,7 +86,7 @@ Frigate looks for a JWT token secret in the following order: 1. An environment variable named `FRIGATE_JWT_SECRET` 2. A file named `FRIGATE_JWT_SECRET` in the directory specified by the `CREDENTIALS_DIRECTORY` environment variable (defaults to the Docker Secrets directory: `/run/secrets/`) -3. A `jwt_secret` option from the Home Assistant Add-on options +3. A `jwt_secret` option from the Home Assistant App options 4. A `.jwt_secret` file in the config directory If no secret is found on startup, Frigate generates one and stores it in a `.jwt_secret` file in the config directory. diff --git a/docs/docs/configuration/hardware_acceleration_video.md b/docs/docs/configuration/hardware_acceleration_video.md index bbbf5a640..46be3bb50 100644 --- a/docs/docs/configuration/hardware_acceleration_video.md +++ b/docs/docs/configuration/hardware_acceleration_video.md @@ -10,6 +10,7 @@ import CommunityBadge from '@site/src/components/CommunityBadge'; It is highly recommended to use an integrated or discrete GPU for hardware acceleration video decoding in Frigate. Some types of hardware acceleration are detected and used automatically, but you may need to update your configuration to enable hardware accelerated decoding in ffmpeg. To verify that hardware acceleration is working: + - Check the logs: A message will either say that hardware acceleration was automatically detected, or there will be a warning that no hardware acceleration was automatically detected - If hardware acceleration is specified in the config, verification can be done by ensuring the logs are free from errors. There is no CPU fallback for hardware acceleration. @@ -67,7 +68,7 @@ Frigate can utilize most Intel integrated GPUs and Arc GPUs to accelerate video :::note -The default driver is `iHD`. You may need to change the driver to `i965` by adding the following environment variable `LIBVA_DRIVER_NAME=i965` to your docker-compose file or [in the `config.yml` for HA Add-on users](advanced.md#environment_vars). +The default driver is `iHD`. You may need to change the driver to `i965` by adding the following environment variable `LIBVA_DRIVER_NAME=i965` to your docker-compose file or [in the `config.yml` for HA App users](advanced.md#environment_vars). See [The Intel Docs](https://www.intel.com/content/www/us/en/support/articles/000005505/processors.html) to figure out what generation your CPU is. @@ -188,7 +189,7 @@ Frigate can utilize modern AMD integrated GPUs and AMD GPUs to accelerate video ### Configuring Radeon Driver -You need to change the driver to `radeonsi` by adding the following environment variable `LIBVA_DRIVER_NAME=radeonsi` to your docker-compose file or [in the `config.yml` for HA Add-on users](advanced.md#environment_vars). +You need to change the driver to `radeonsi` by adding the following environment variable `LIBVA_DRIVER_NAME=radeonsi` to your docker-compose file or [in the `config.yml` for HA App users](advanced.md#environment_vars). ### Via VAAPI @@ -292,7 +293,7 @@ These instructions were originally based on the [Jellyfin documentation](https:/ ## Raspberry Pi 3/4 Ensure you increase the allocated RAM for your GPU to at least 128 (`raspi-config` > Performance Options > GPU Memory). -If you are using the HA Add-on, you may need to use the full access variant and turn off _Protection mode_ for hardware acceleration. +If you are using the HA App, you may need to use the full access variant and turn off _Protection mode_ for hardware acceleration. ```yaml # if you want to decode a h264 stream diff --git a/docs/docs/configuration/index.md b/docs/docs/configuration/index.md index 2144ef7ea..c1b0dc903 100644 --- a/docs/docs/configuration/index.md +++ b/docs/docs/configuration/index.md @@ -3,7 +3,7 @@ id: index title: Frigate Configuration --- -For Home Assistant Add-on installations, the config file should be at `/addon_configs//config.yml`, where `` is specific to the variant of the Frigate Add-on you are running. See the list of directories [here](#accessing-add-on-config-dir). +For Home Assistant App installations, the config file should be at `/addon_configs//config.yml`, where `` is specific to the variant of the Frigate App you are running. See the list of directories [here](#accessing-app-config-dir). For all other installation types, the config file should be mapped to `/config/config.yml` inside the container. @@ -25,11 +25,11 @@ cameras: - detect ``` -## Accessing the Home Assistant Add-on configuration directory {#accessing-add-on-config-dir} +## Accessing the Home Assistant App configuration directory {#accessing-app-config-dir} -When running Frigate through the HA Add-on, the Frigate `/config` directory is mapped to `/addon_configs/` in the host, where `` is specific to the variant of the Frigate Add-on you are running. +When running Frigate through the HA App, the Frigate `/config` directory is mapped to `/addon_configs/` in the host, where `` is specific to the variant of the Frigate App you are running. -| Add-on Variant | Configuration directory | +| App Variant | Configuration directory | | -------------------------- | ----------------------------------------- | | Frigate | `/addon_configs/ccab4aaf_frigate` | | Frigate (Full Access) | `/addon_configs/ccab4aaf_frigate-fa` | @@ -38,11 +38,11 @@ When running Frigate through the HA Add-on, the Frigate `/config` directory is m **Whenever you see `/config` in the documentation, it refers to this directory.** -If for example you are running the standard Add-on variant and use the [VS Code Add-on](https://github.com/hassio-addons/addon-vscode) to browse your files, you can click _File_ > _Open folder..._ and navigate to `/addon_configs/ccab4aaf_frigate` to access the Frigate `/config` directory and edit the `config.yaml` file. You can also use the built-in file editor in the Frigate UI to edit the configuration file. +If for example you are running the standard App variant and use the [VS Code App](https://github.com/hassio-addons/addon-vscode) to browse your files, you can click _File_ > _Open folder..._ and navigate to `/addon_configs/ccab4aaf_frigate` to access the Frigate `/config` directory and edit the `config.yaml` file. You can also use the built-in file editor in the Frigate UI to edit the configuration file. ## VS Code Configuration Schema -VS Code supports JSON schemas for automatically validating configuration files. You can enable this feature by adding `# yaml-language-server: $schema=http://frigate_host:5000/api/config/schema.json` to the beginning of the configuration file. Replace `frigate_host` with the IP address or hostname of your Frigate server. If you're using both VS Code and Frigate as an Add-on, you should use `ccab4aaf-frigate` instead. Make sure to expose the internal unauthenticated port `5000` when accessing the config from VS Code on another machine. +VS Code supports JSON schemas for automatically validating configuration files. You can enable this feature by adding `# yaml-language-server: $schema=http://frigate_host:5000/api/config/schema.json` to the beginning of the configuration file. Replace `frigate_host` with the IP address or hostname of your Frigate server. If you're using both VS Code and Frigate as an App, you should use `ccab4aaf-frigate` instead. Make sure to expose the internal unauthenticated port `5000` when accessing the config from VS Code on another machine. ## Environment Variable Substitution @@ -82,10 +82,10 @@ genai: Here are some common starter configuration examples. Refer to the [reference config](./reference.md) for detailed information about all the config values. -### Raspberry Pi Home Assistant Add-on with USB Coral +### Raspberry Pi Home Assistant App with USB Coral - Single camera with 720p, 5fps stream for detect -- MQTT connected to the Home Assistant Mosquitto Add-on +- MQTT connected to the Home Assistant Mosquitto App - Hardware acceleration for decoding video - USB Coral detector - Save all video with any detectable motion for 7 days regardless of whether any objects were detected or not diff --git a/docs/docs/configuration/live.md b/docs/docs/configuration/live.md index 910cb69f1..c55d29a59 100644 --- a/docs/docs/configuration/live.md +++ b/docs/docs/configuration/live.md @@ -15,7 +15,7 @@ The jsmpeg live view will use more browser and client GPU resources. Using go2rt | ------ | ------------------------------------- | ---------- | ---------------------------- | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | jsmpeg | same as `detect -> fps`, capped at 10 | 720p | no | no | Resolution is configurable, but go2rtc is recommended if you want higher resolutions and better frame rates. jsmpeg is Frigate's default without go2rtc configured. | | mse | native | native | yes (depends on audio codec) | yes | iPhone requires iOS 17.1+, Firefox is h.264 only. This is Frigate's default when go2rtc is configured. | -| webrtc | native | native | yes (depends on audio codec) | yes | Requires extra configuration. Frigate attempts to use WebRTC when MSE fails or when using a camera's two-way talk feature. | +| webrtc | native | native | yes (depends on audio codec) | yes | Requires extra configuration. Frigate attempts to use WebRTC when MSE fails or when using a camera's two-way talk feature. | ### Camera Settings Recommendations @@ -114,7 +114,7 @@ cameras: WebRTC works by creating a TCP or UDP connection on port `8555`. However, it requires additional configuration: - For external access, over the internet, setup your router to forward port `8555` to port `8555` on the Frigate device, for both TCP and UDP. -- For internal/local access, unless you are running through the HA Add-on, you will also need to set the WebRTC candidates list in the go2rtc config. For example, if `192.168.1.10` is the local IP of the device running Frigate: +- For internal/local access, unless you are running through the HA App, you will also need to set the WebRTC candidates list in the go2rtc config. For example, if `192.168.1.10` is the local IP of the device running Frigate: ```yaml title="config.yml" go2rtc: @@ -128,13 +128,13 @@ WebRTC works by creating a TCP or UDP connection on port `8555`. However, it req - For access through Tailscale, the Frigate system's Tailscale IP must be added as a WebRTC candidate. Tailscale IPs all start with `100.`, and are reserved within the `100.64.0.0/10` CIDR block. -- Note that some browsers may not support H.265 (HEVC). You can check your browser's current version for H.265 compatibility [here](https://github.com/AlexxIT/go2rtc?tab=readme-ov-file#codecs-madness). +- Note that some browsers may not support H.265 (HEVC). You can check your browser's current version for H.265 compatibility [here](https://github.com/AlexxIT/go2rtc?tab=readme-ov-file#codecs-madness). :::tip -This extra configuration may not be required if Frigate has been installed as a Home Assistant Add-on, as Frigate uses the Supervisor's API to generate a WebRTC candidate. +This extra configuration may not be required if Frigate has been installed as a Home Assistant App, as Frigate uses the Supervisor's API to generate a WebRTC candidate. -However, it is recommended if issues occur to define the candidates manually. You should do this if the Frigate Add-on fails to generate a valid candidate. If an error occurs you will see some warnings like the below in the Add-on logs page during the initialization: +However, it is recommended if issues occur to define the candidates manually. You should do this if the Frigate App fails to generate a valid candidate. If an error occurs you will see some warnings like the below in the App logs page during the initialization: ```log [WARN] Failed to get IP address from supervisor @@ -222,34 +222,28 @@ Note that disabling a camera through the config file (`enabled: False`) removes When your browser runs into problems playing back your camera streams, it will log short error messages to the browser console. They indicate playback, codec, or network issues on the client/browser side, not something server side with Frigate itself. Below are the common messages you may see and simple actions you can take to try to resolve them. - **startup** - - What it means: The player failed to initialize or connect to the live stream (network or startup error). - What to try: Reload the Live view or click _Reset_. Verify `go2rtc` is running and the camera stream is reachable. Try switching to a different stream from the Live UI dropdown (if available) or use a different browser. - Possible console messages from the player code: - - `Error opening MediaSource.` - `Browser reported a network error.` - `Max error count ${errorCount} exceeded.` (the numeric value will vary) - **mse-decode** - - What it means: The browser reported a decoding error while trying to play the stream, which usually is a result of a codec incompatibility or corrupted frames. - What to try: Check the browser console for the supported and negotiated codecs. Ensure your camera/restream is using H.264 video and AAC audio (these are the most compatible). If your camera uses a non-standard audio codec, configure `go2rtc` to transcode the stream to AAC. Try another browser (some browsers have stricter MSE/codec support) and, for iPhone, ensure you're on iOS 17.1 or newer. - Possible console messages from the player code: - - `Safari cannot open MediaSource.` - `Safari reported InvalidStateError.` - `Safari reported decoding errors.` - **stalled** - - What it means: Playback has stalled because the player has fallen too far behind live (extended buffering or no data arriving). - What to try: This is usually indicative of the browser struggling to decode too many high-resolution streams at once. Try selecting a lower-bandwidth stream (substream), reduce the number of live streams open, improve the network connection, or lower the camera resolution. Also check your camera's keyframe (I-frame) interval — shorter intervals make playback start and recover faster. You can also try increasing the timeout value in the UI pane of Frigate's settings. - Possible console messages from the player code: - - `Buffer time (10 seconds) exceeded, browser may not be playing media correctly.` - `Media playback has stalled after seconds due to insufficient buffering or a network interruption.` (the seconds value will vary) @@ -270,21 +264,18 @@ When your browser runs into problems playing back your camera streams, it will l If you are using continuous streaming or you are loading more than a few high resolution streams at once on the dashboard, your browser may struggle to begin playback of your streams before the timeout. Frigate always prioritizes showing a live stream as quickly as possible, even if it is a lower quality jsmpeg stream. You can use the "Reset" link/button to try loading your high resolution stream again. Errors in stream playback (e.g., connection failures, codec issues, or buffering timeouts) that cause the fallback to low bandwidth mode (jsmpeg) are logged to the browser console for easier debugging. These errors may include: - - Network issues (e.g., MSE or WebRTC network connection problems). - Unsupported codecs or stream formats (e.g., H.265 in WebRTC, which is not supported in some browsers). - Buffering timeouts or low bandwidth conditions causing fallback to jsmpeg. - Browser compatibility problems (e.g., iOS Safari limitations with MSE). To view browser console logs: - 1. Open the Frigate Live View in your browser. 2. Open the browser's Developer Tools (F12 or right-click > Inspect > Console tab). 3. Reproduce the error (e.g., load a problematic stream or simulate network issues). 4. Look for messages prefixed with the camera name. These logs help identify if the issue is player-specific (MSE vs. WebRTC) or related to camera configuration (e.g., go2rtc streams, codecs). If you see frequent errors: - - Verify your camera's H.264/AAC settings (see [Frigate's camera settings recommendations](#camera_settings_recommendations)). - Check go2rtc configuration for transcoding (e.g., audio to AAC/OPUS). - Test with a different stream via the UI dropdown (if `live -> streams` is configured). @@ -324,9 +315,7 @@ When your browser runs into problems playing back your camera streams, it will l To prevent this, make the `detect` stream match the go2rtc live stream's aspect ratio (resolution does not need to match, just the aspect ratio). You can either adjust the camera's output resolution or set the `width` and `height` values in your config's `detect` section to a resolution with an aspect ratio that matches. Example: Resolutions from two streams - - Mismatched (may cause aspect ratio switching on the dashboard): - - Live/go2rtc stream: 1920x1080 (16:9) - Detect stream: 640x352 (~1.82:1, not 16:9) diff --git a/docs/docs/development/contributing.md b/docs/docs/development/contributing.md index a123f70b8..0a3b76990 100644 --- a/docs/docs/development/contributing.md +++ b/docs/docs/development/contributing.md @@ -17,15 +17,15 @@ From here, follow the guides for: - [Web Interface](#web-interface) - [Documentation](#documentation) -### Frigate Home Assistant Add-on +### Frigate Home Assistant App -This repository holds the Home Assistant Add-on, for use with Home Assistant OS and compatible installations. It is the piece that allows you to run Frigate from your Home Assistant Supervisor tab. +This repository holds the Home Assistant App, for use with Home Assistant OS and compatible installations. It is the piece that allows you to run Frigate from your Home Assistant Supervisor tab. Fork [blakeblackshear/frigate-hass-addons](https://github.com/blakeblackshear/frigate-hass-addons) to your own Github profile, then clone the forked repo to your local machine. ### Frigate Home Assistant Integration -This repository holds the custom integration that allows your Home Assistant installation to automatically create entities for your Frigate instance, whether you are running Frigate as a standalone Docker container or as a [Home Assistant Add-on](#frigate-home-assistant-add-on). +This repository holds the custom integration that allows your Home Assistant installation to automatically create entities for your Frigate instance, whether you are running Frigate as a standalone Docker container or as a [Home Assistant App](#frigate-home-assistant-app). Fork [blakeblackshear/frigate-hass-integration](https://github.com/blakeblackshear/frigate-hass-integration) to your own GitHub profile, then clone the forked repo to your local machine. diff --git a/docs/docs/frigate/installation.md b/docs/docs/frigate/installation.md index 96a283fe4..cef98f483 100644 --- a/docs/docs/frigate/installation.md +++ b/docs/docs/frigate/installation.md @@ -3,11 +3,11 @@ id: installation title: Installation --- -Frigate is a Docker container that can be run on any Docker host including as a [Home Assistant Add-on](https://www.home-assistant.io/addons/). Note that the Home Assistant Add-on is **not** the same thing as the integration. The [integration](/integrations/home-assistant) is required to integrate Frigate into Home Assistant, whether you are running Frigate as a standalone Docker container or as a Home Assistant Add-on. +Frigate is a Docker container that can be run on any Docker host including as a [Home Assistant App](https://www.home-assistant.io/addons/). Note that the Home Assistant App is **not** the same thing as the integration. The [integration](/integrations/home-assistant) is required to integrate Frigate into Home Assistant, whether you are running Frigate as a standalone Docker container or as a Home Assistant App. :::tip -If you already have Frigate installed as a Home Assistant Add-on, check out the [getting started guide](../guides/getting_started#configuring-frigate) to configure Frigate. +If you already have Frigate installed as a Home Assistant App, check out the [getting started guide](../guides/getting_started#configuring-frigate) to configure Frigate. ::: @@ -92,7 +92,7 @@ $ python -c 'print("{:.2f}MB".format(((1280 * 720 * 1.5 * 20 + 270480) / 1048576 253MB ``` -The shm size cannot be set per container for Home Assistant add-ons. However, this is probably not required since by default Home Assistant Supervisor allocates `/dev/shm` with half the size of your total memory. If your machine has 8GB of memory, chances are that Frigate will have access to up to 4GB without any additional configuration. +The shm size cannot be set per container for Home Assistant Apps. However, this is probably not required since by default Home Assistant Supervisor allocates `/dev/shm` with half the size of your total memory. If your machine has 8GB of memory, chances are that Frigate will have access to up to 4GB without any additional configuration. ## Extra Steps for Specific Hardware @@ -510,7 +510,7 @@ The community supported docker image tags for the current stable version are: - `stable-tensorrt-jp6` - Frigate build optimized for Nvidia Jetson devices running Jetpack 6 - `stable-rk` - Frigate build for SBCs with Rockchip SoC -## Home Assistant Add-on +## Home Assistant App :::warning @@ -521,7 +521,7 @@ There are important limitations in HA OS 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. - Intel NPUs are not supported because HA OS does not include the NPU firmware. -- Nvidia GPUs are not supported because addons do not support the Nvidia runtime. +- Nvidia GPUs are not supported because HA Apps do not support the Nvidia runtime. ::: @@ -531,27 +531,27 @@ See [the network storage guide](/guides/ha_network_storage.md) for instructions ::: -Home Assistant OS users can install via the Add-on repository. +Home Assistant OS users can install via the App repository. -1. In Home Assistant, navigate to _Settings_ > _Add-ons_ > _Add-on Store_ > _Repositories_ +1. In Home Assistant, navigate to _Settings_ > _Apps_ > _App Store_ > _Repositories_ 2. Add `https://github.com/blakeblackshear/frigate-hass-addons` -3. Install the desired variant of the Frigate Add-on (see below) +3. Install the desired variant of the Frigate App (see below) 4. Setup your network configuration in the `Configuration` tab -5. Start the Add-on +5. Start the App 6. Use the _Open Web UI_ button to access the Frigate UI, then click in the _cog icon_ > _Configuration editor_ and configure Frigate to your liking -There are several variants of the Add-on available: +There are several variants of the App available: -| Add-on Variant | Description | +| App Variant | Description | | -------------------------- | ---------------------------------------------------------- | | Frigate | Current release with protection mode on | | Frigate (Full Access) | Current release with the option to disable protection mode | | Frigate Beta | Beta release with protection mode on | | Frigate Beta (Full Access) | Beta release with the option to disable protection mode | -If you are using hardware acceleration for ffmpeg, you **may** need to use the _Full Access_ variant of the Add-on. This is because the Frigate Add-on runs in a container with limited access to the host system. The _Full Access_ variant allows you to disable _Protection mode_ and give Frigate full access to the host system. +If you are using hardware acceleration for ffmpeg, you **may** need to use the _Full Access_ variant of the App. This is because the Frigate App runs in a container with limited access to the host system. The _Full Access_ variant allows you to disable _Protection mode_ and give Frigate full access to the host system. -You can also edit the Frigate configuration file through the [VS Code Add-on](https://github.com/hassio-addons/addon-vscode) or similar. In that case, the configuration file will be at `/addon_configs//config.yml`, where `` is specific to the variant of the Frigate Add-on you are running. See the list of directories [here](../configuration/index.md#accessing-add-on-config-dir). +You can also edit the Frigate configuration file through the [VS Code App](https://github.com/hassio-addons/addon-vscode) or similar. In that case, the configuration file will be at `/addon_configs//config.yml`, where `` is specific to the variant of the Frigate App you are running. See the list of directories [here](../configuration/index.md#accessing-app-config-dir). ## Kubernetes diff --git a/docs/docs/frigate/updating.md b/docs/docs/frigate/updating.md index 589ab7ff1..841a3e2d5 100644 --- a/docs/docs/frigate/updating.md +++ b/docs/docs/frigate/updating.md @@ -7,7 +7,7 @@ title: Updating The current stable version of Frigate is **0.17.0**. The release notes and any breaking changes for this version can be found on the [Frigate GitHub releases page](https://github.com/blakeblackshear/frigate/releases/tag/v0.17.0). -Keeping Frigate up to date ensures you benefit from the latest features, performance improvements, and bug fixes. The update process varies slightly depending on your installation method (Docker, Home Assistant Addon, etc.). Below are instructions for the most common setups. +Keeping Frigate up to date ensures you benefit from the latest features, performance improvements, and bug fixes. The update process varies slightly depending on your installation method (Docker, Home Assistant App, etc.). Below are instructions for the most common setups. ## Before You Begin @@ -67,30 +67,30 @@ If you’re running Frigate via Docker (recommended method), follow these steps: - If you’ve customized other settings (e.g., `shm-size`), ensure they’re still appropriate after the update. - Docker will automatically use the updated image when you restart the container, as long as you pulled the correct version. -## Updating the Home Assistant Addon +## Updating the Home Assistant App (formerly Addon) -For users running Frigate as a Home Assistant Addon: +For users running Frigate as a Home Assistant App: 1. **Check for Updates**: - - Navigate to **Settings > Add-ons** in Home Assistant. - - Find your installed Frigate addon (e.g., "Frigate NVR" or "Frigate NVR (Full Access)"). + - Navigate to **Settings > Apps** in Home Assistant. + - Find your installed Frigate app (e.g., "Frigate NVR" or "Frigate NVR (Full Access)"). - If an update is available, you’ll see an "Update" button. -2. **Update the Addon**: - - Click the "Update" button next to the Frigate addon. +2. **Update the App**: + - Click the "Update" button next to the Frigate app. - Wait for the process to complete. Home Assistant will handle downloading and installing the new version. -3. **Restart the Addon**: - - After updating, go to the addon’s page and click "Restart" to apply the changes. +3. **Restart the App**: + - After updating, go to the app’s page and click "Restart" to apply the changes. 4. **Verify the Update**: - - Check the addon logs (under the "Log" tab) to ensure Frigate starts without errors. + - Check the app logs (under the "Log" tab) to ensure Frigate starts without errors. - Access the Frigate Web UI to confirm the new version is running. ### Notes - Ensure your `/config/frigate.yml` is compatible with the new version by reviewing the [Release notes](https://github.com/blakeblackshear/frigate/releases). -- If using custom hardware (e.g., Coral or GPU), verify that configurations still work, as addon updates don’t modify your hardware settings. +- If using custom hardware (e.g., Coral or GPU), verify that configurations still work, as app updates don’t modify your hardware settings. ## Rolling Back @@ -101,7 +101,7 @@ If an update causes issues: 3. Revert to the previous image version: - For Docker: Specify an older tag (e.g., `ghcr.io/blakeblackshear/frigate:0.16.4`) in your `docker run` command. - For Docker Compose: Edit your `docker-compose.yml`, specify the older version tag (e.g., `ghcr.io/blakeblackshear/frigate:0.16.4`), and re-run `docker compose up -d`. - - For Home Assistant: Reinstall the previous addon version manually via the repository if needed and restart the addon. + - For Home Assistant: Restore from the app/addon backup you took before you updated. 4. Verify the old version is running again. ## Troubleshooting diff --git a/docs/docs/guides/configuring_go2rtc.md b/docs/docs/guides/configuring_go2rtc.md index ca50a90d3..2dbbccada 100644 --- a/docs/docs/guides/configuring_go2rtc.md +++ b/docs/docs/guides/configuring_go2rtc.md @@ -33,19 +33,16 @@ After adding this to the config, restart Frigate and try to watch the live strea ### What if my video doesn't play? - Check Logs: - - Access the go2rtc logs in the Frigate UI under Logs in the sidebar. - If go2rtc is having difficulty connecting to your camera, you should see some error messages in the log. - Check go2rtc Web Interface: if you don't see any errors in the logs, try viewing the camera through go2rtc's web interface. - - Navigate to port 1984 in your browser to access go2rtc's web interface. - If using Frigate through Home Assistant, enable the web interface at port 1984. - If using Docker, forward port 1984 before accessing the web interface. - Click `stream` for the specific camera to see if the camera's stream is being received. - Check Video Codec: - - If the camera stream works in go2rtc but not in your browser, the video codec might be unsupported. - If using H265, switch to H264. Refer to [video codec compatibility](https://github.com/AlexxIT/go2rtc/tree/v1.9.10#codecs-madness) in go2rtc documentation. - If unable to switch from H265 to H264, or if the stream format is different (e.g., MJPEG), re-encode the video using [FFmpeg parameters](https://github.com/AlexxIT/go2rtc/tree/v1.9.10#source-ffmpeg). It supports rotating and resizing video feeds and hardware acceleration. Keep in mind that transcoding video from one format to another is a resource intensive task and you may be better off using the built-in jsmpeg view. @@ -58,7 +55,6 @@ After adding this to the config, restart Frigate and try to watch the live strea ``` - Switch to FFmpeg if needed: - - Some camera streams may need to use the ffmpeg module in go2rtc. This has the downside of slower startup times, but has compatibility with more stream types. ```yaml @@ -101,9 +97,9 @@ After adding this to the config, restart Frigate and try to watch the live strea :::warning -To access the go2rtc stream externally when utilizing the Frigate Add-On (for +To access the go2rtc stream externally when utilizing the Frigate App (for instance through VLC), you must first enable the RTSP Restream port. -You can do this by visiting the Frigate Add-On configuration page within Home +You can do this by visiting the Frigate App configuration page within Home Assistant and revealing the hidden options under the "Show disabled ports" section. diff --git a/docs/docs/guides/getting_started.md b/docs/docs/guides/getting_started.md index efc9edb42..1100a759b 100644 --- a/docs/docs/guides/getting_started.md +++ b/docs/docs/guides/getting_started.md @@ -9,7 +9,7 @@ title: Getting started If you already have an environment with Linux and Docker installed, you can continue to [Installing Frigate](#installing-frigate) below. -If you already have Frigate installed through Docker or through a Home Assistant Add-on, you can continue to [Configuring Frigate](#configuring-frigate) below. +If you already have Frigate installed through Docker or through a Home Assistant App, you can continue to [Configuring Frigate](#configuring-frigate) below. ::: @@ -81,7 +81,7 @@ Now you have a minimal Debian server that requires very little maintenance. ## Installing Frigate -This section shows how to create a minimal directory structure for a Docker installation on Debian. If you have installed Frigate as a Home Assistant Add-on or another way, you can continue to [Configuring Frigate](#configuring-frigate). +This section shows how to create a minimal directory structure for a Docker installation on Debian. If you have installed Frigate as a Home Assistant App or another way, you can continue to [Configuring Frigate](#configuring-frigate). ### Setup directories @@ -174,7 +174,7 @@ cameras: ### Step 4: Configure detectors -By default, Frigate will use a single CPU detector. +By default, Frigate will use a single CPU detector. In many cases, the integrated graphics on Intel CPUs provides sufficient performance for typical Frigate setups. If you have an Intel processor, you can follow the configuration below. @@ -187,12 +187,12 @@ You need to refer to **Configure hardware acceleration** above to enable the con mqtt: ... detectors: # <---- add detectors - ov: + ov: type: openvino # <---- use openvino detector device: GPU # We will use the default MobileNet_v2 model from OpenVINO. -model: +model: width: 300 height: 300 input_tensor: nhwc @@ -209,12 +209,12 @@ cameras: ``` - + If you have a USB Coral, you will need to add a detectors section to your config.
Use USB Coral detector - + `docker-compose.yml` (after modifying, you will need to run `docker compose up -d` to apply changes) ```yaml diff --git a/docs/docs/guides/ha_network_storage.md b/docs/docs/guides/ha_network_storage.md index 78cddddeb..134e1952c 100644 --- a/docs/docs/guides/ha_network_storage.md +++ b/docs/docs/guides/ha_network_storage.md @@ -3,7 +3,7 @@ id: ha_network_storage title: Home Assistant network storage --- -As of Home Assistant 2023.6, Network Mounted Storage is supported for Add-ons. +As of Home Assistant 2023.6, Network Mounted Storage is supported for Apps. ## Setting Up Remote Storage For Frigate @@ -14,7 +14,7 @@ As of Home Assistant 2023.6, Network Mounted Storage is supported for Add-ons. ### Initial Setup -1. Stop the Frigate Add-on +1. Stop the Frigate App ### Move current data @@ -37,4 +37,4 @@ Keeping the current data is optional, but the data will need to be moved regardl 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 Add-on +7. Start the Frigate App diff --git a/docs/docs/integrations/home-assistant.md b/docs/docs/integrations/home-assistant.md index 1ba5bfca1..5b9c01437 100644 --- a/docs/docs/integrations/home-assistant.md +++ b/docs/docs/integrations/home-assistant.md @@ -99,11 +99,11 @@ services: ... ``` -### Home Assistant Add-on +### Home Assistant App -If you are using Home Assistant Add-on, the URL should be one of the following depending on which Add-on variant you are using. Note that if you are using the Proxy Add-on, you should NOT point the integration at the proxy URL. Just enter the same URL used to access Frigate directly from your network. +If you are using Home Assistant App, the URL should be one of the following depending on which App variant you are using. Note that if you are using the Proxy App, you should NOT point the integration at the proxy URL. Just enter the same URL used to access Frigate directly from your network. -| Add-on Variant | URL | +| App Variant | URL | | -------------------------- | -------------------------------------- | | Frigate | `http://ccab4aaf-frigate:5000` | | Frigate (Full Access) | `http://ccab4aaf-frigate-fa:5000` | diff --git a/docs/docs/integrations/plus.md b/docs/docs/integrations/plus.md index 36efa5e74..aa3d78df5 100644 --- a/docs/docs/integrations/plus.md +++ b/docs/docs/integrations/plus.md @@ -19,11 +19,11 @@ Once logged in, you can generate an API key for Frigate in Settings. ### Set your API key -In Frigate, you can use an environment variable or a docker secret named `PLUS_API_KEY` to enable the `Frigate+` buttons on the Explore page. Home Assistant Addon users can set it under Settings > Add-ons > Frigate > Configuration > Options (be sure to toggle the "Show unused optional configuration options" switch). +In Frigate, you can use an environment variable or a docker secret named `PLUS_API_KEY` to enable the `Frigate+` buttons on the Explore page. Home Assistant App users can set it under Settings > Apps > Frigate > Configuration > Options (be sure to toggle the "Show unused optional configuration options" switch). :::warning -You cannot use the `environment_vars` section of your Frigate configuration file to set this environment variable. It must be defined as an environment variable in the docker config or Home Assistant Add-on config. +You cannot use the `environment_vars` section of your Frigate configuration file to set this environment variable. It must be defined as an environment variable in the docker config or Home Assistant App config. ::: diff --git a/docs/docs/troubleshooting/edgetpu.md b/docs/docs/troubleshooting/edgetpu.md index 97b2b0040..4ee25afd0 100644 --- a/docs/docs/troubleshooting/edgetpu.md +++ b/docs/docs/troubleshooting/edgetpu.md @@ -32,7 +32,7 @@ The USB coral can draw up to 900mA and this can be too much for some on-device U The USB coral has different IDs when it is uninitialized and initialized. - When running Frigate in a VM, Proxmox lxc, etc. you must ensure both device IDs are mapped. -- When running through the Home Assistant OS you may need to run the Full Access variant of the Frigate Add-on with the _Protection mode_ switch disabled so that the coral can be accessed. +- When running through the Home Assistant OS you may need to run the Full Access variant of the Frigate App with the _Protection mode_ switch disabled so that the coral can be accessed. ### Synology 716+II running DSM 7.2.1-69057 Update 5