From 4b1afcaf8507ae2012e1f68b365f198143be0827 Mon Sep 17 00:00:00 2001 From: Felipe Santos Date: Fri, 21 Mar 2025 19:59:51 -0300 Subject: [PATCH] Move addon config section to configuration doc --- docs/docs/configuration/hardware_acceleration.md | 6 +++--- docs/docs/configuration/index.md | 14 ++++++++++++-- docs/docs/frigate/installation.md | 12 +----------- 3 files changed, 16 insertions(+), 16 deletions(-) diff --git a/docs/docs/configuration/hardware_acceleration.md b/docs/docs/configuration/hardware_acceleration.md index e3bff0a0e..fc01abc02 100644 --- a/docs/docs/configuration/hardware_acceleration.md +++ b/docs/docs/configuration/hardware_acceleration.md @@ -14,7 +14,7 @@ Depending on your system, these parameters may not be compatible. More informati ## 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 addon, you may need to use the full access variant and turn off `Protection mode` for hardware acceleration. +If you are using the HassOS addon, 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 @@ -80,7 +80,7 @@ Or map in all the `/dev/video*` devices. :::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 `frigate.yaml` for HA OS 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.yaml` for HassOS addon 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. @@ -191,7 +191,7 @@ VAAPI supports automatic profile selection so it will work automatically with bo :::note -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 `frigate.yaml` for HA OS 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.yaml` for HassOS addon users](advanced.md#environment_vars). ::: diff --git a/docs/docs/configuration/index.md b/docs/docs/configuration/index.md index a60da3499..fb185971b 100644 --- a/docs/docs/configuration/index.md +++ b/docs/docs/configuration/index.md @@ -3,9 +3,11 @@ id: index title: Frigate Configuration --- -For Home Assistant Addon installations, the config file needs to be in the root of your Home Assistant config directory (same location as `configuration.yaml`). It can be named `frigate.yaml` or `frigate.yml`, but if both files exist `frigate.yaml` will be preferred and `frigate.yml` will be ignored. +For HassOS addon installations, the config file should be at `/addon_configs/ccab4aaf_frigate/config.yaml` ([click here to learn more on how to access this directory](#accessing-addon-config)). -For all other installation types, the config file should be mapped to `/config/config.yml` inside the container. +For all other installation types, the config file should be mapped to `/config/config.yaml` inside the container. + +It can be named `config.yaml` or `config.yml`, but if both files exist `config.yaml` will be preferred and `config.yml` will be ignored. It is recommended to start with a minimal configuration and add to it as described in [this guide](../guides/getting_started.md) and use the built in configuration editor in Frigate's UI which supports validation. @@ -23,6 +25,14 @@ cameras: - detect ``` +## Accessing the HassOS addon configuration directory {#accessing-addon-config} + +When running Frigate through the HassOS addon, the Frigate `/config` directory is mapped to a directory in the host inside `/addon_configs`. The directory name depends on the addon variant you are using. For example, if you are using the standard Frigate addon variant, the directory will be `/addon_configs/ccab4aaf_frigate`. + +**Whenever you see `/config` in the documentation, it refers to this directory.** + +If for example you use the [VS Code addon](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. + ## VSCode Configuration Schema VSCode 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 VSCode 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 VSCode on another machine. diff --git a/docs/docs/frigate/installation.md b/docs/docs/frigate/installation.md index 9489e566b..58d46ccd2 100644 --- a/docs/docs/frigate/installation.md +++ b/docs/docs/frigate/installation.md @@ -281,7 +281,7 @@ HassOS users can install via the addon repository. 2. Add https://github.com/blakeblackshear/frigate-hass-addons 3. Install your desired Frigate NVR Addon and navigate to it's page 4. Setup your network configuration in the `Configuration` tab -5. (not for proxy addon) Create the file `config.yaml` in your `/addon_configs/ccab4aaf_frigate` directory with your detailed Frigate configuration (see below for more details on how to access this directory) +5. (not for proxy addon) Create the file `config.yaml` in your `/addon_configs/ccab4aaf_frigate` directory with your detailed Frigate configuration ([click here to learn more on how to access this directory](../configuration/index.md#accessing-addon-config)) 6. Start the addon container 7. (not for proxy addon) If you are using hardware acceleration for ffmpeg, you may need to disable "Protection mode" @@ -295,16 +295,6 @@ There are several variants of the addon available: | Frigate Beta (Full Access) | Beta release with the option to disable protection mode | | Frigate HailoRT Beta | Beta release with HailoRT support | -:::info Accessing Frigate's `/config` directory - -When running Frigate through the HA addon, the Frigate `/config` directory is mapped to a directory in the host inside `/addon_configs`. The directory name depends on the addon variant you are using. For example, if you are using the standard Frigate addon, the directory will be `/addon_configs/ccab4aaf_frigate`. - -**Whenever you see `/config` in the documentation, it refers to this directory.** - -If for example you use the [VS Code addon](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. - -::: - ## Kubernetes Use the [helm chart](https://github.com/blakeblackshear/blakeshome-charts/tree/master/charts/frigate).