diff --git a/docs/docs/configuration/index.md b/docs/docs/configuration/index.md index 899c3cd68..b8e3bb8c7 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/ccab4aaf_frigate/config.yaml` ([click here to learn more on how to access this directory](#accessing-add-on-config)). +For Home Assistant Add-on installations, the config file should be at `/addon_configs//config.yaml`, 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 all other installation types, the config file should be mapped to `/config/config.yaml` inside the container. @@ -25,13 +25,21 @@ cameras: - detect ``` -## Accessing Frigate `/config` directory for the Home Assistant Add-on {#accessing-add-on-config} +## Accessing the Home Assistant Add-on configuration directory {#accessing-add-on-config-dir} -When running Frigate through the HA Add-on, the Frigate `/config` directory is mapped to a directory in the host inside `/addon_configs`. The directory name depends on the Add-on variant you are using. For example, if you are using the standard Frigate Add-on variant, the directory will be `/addon_configs/ccab4aaf_frigate`. +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. + +| Add-on Variant | Configuration directory | +| -------------------------- | -------------------------------------------- | +| Frigate | `/addon_configs/ccab4aaf_frigate` | +| Frigate (Full Access) | `/addon_configs/ccab4aaf_frigate_fa` | +| Frigate Beta | `/addon_configs/ccab4aaf_frigate_beta` | +| Frigate Beta (Full Access) | `/addon_configs/ccab4aaf_frigate_fa_beta` | +| Frigate HailoRT Beta | `/addon_configs/ccab4aaf_frigate_hailo_beta` | **Whenever you see `/config` in the documentation, it refers to this directory.** -If for example you 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. +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. ## VS Code Configuration Schema diff --git a/docs/docs/frigate/installation.md b/docs/docs/frigate/installation.md index 6aed6e946..65eb550bb 100644 --- a/docs/docs/frigate/installation.md +++ b/docs/docs/frigate/installation.md @@ -276,12 +276,12 @@ See [the network storage guide](/guides/ha_network_storage.md) for instructions Home Assistant OS users can install via the Add-on repository. -1. Navigate to Supervisor > Add-on Store > Repositories +1. In Home Assistant, navigate to _Settings_ > _Add-ons_ > _Add-on Store_ > _Repositories_ 2. Add `https://github.com/blakeblackshear/frigate-hass-addons` -3. Install your desired Frigate Add-on and navigate to it's page +3. Install the desired variant of the Frigate Add-on (see below) 4. Setup your network configuration in the `Configuration` tab -5. (not for the Proxy Add-on) 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-add-on-config)) -6. Start the Add-on +5. Start the Add-on +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: @@ -295,6 +295,8 @@ There are several variants of the Add-on available: 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. +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.yaml`, 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). + ## Kubernetes Use the [helm chart](https://github.com/blakeblackshear/blakeshome-charts/tree/master/charts/frigate).