mirror of
https://github.com/blakeblackshear/frigate.git
synced 2026-06-21 11:51:53 +03:00
Move around config items to reflect reference config is now for advanced users
This commit is contained in:
Nicolas Mowen
parent
0889a87812
commit
1fcf57c45a
@ -1,7 +1,6 @@
|
|||||||
---
|
---
|
||||||
id: advanced
|
id: system
|
||||||
title: Advanced Options
|
title: System
|
||||||
sidebar_label: Advanced Options
|
|
||||||
---
|
---
|
||||||
|
|
||||||
import ConfigTabs from "@site/src/components/ConfigTabs";
|
import ConfigTabs from "@site/src/components/ConfigTabs";
|
||||||
@ -202,7 +201,7 @@ model:
|
|||||||
|
|
||||||
:::warning
|
:::warning
|
||||||
|
|
||||||
If the labelmap is customized then the labels used for alerts will need to be adjusted as well. See [alert labels](../configuration/review.md#restricting-alerts-to-specific-labels) for more info.
|
If the labelmap is customized then the labels used for alerts will need to be adjusted as well. See [alert labels](../review.md#restricting-alerts-to-specific-labels) for more info.
|
||||||
|
|
||||||
:::
|
:::
|
||||||
|
|
||||||
@ -167,7 +167,7 @@ A fast [detector](object_detectors.md) is recommended. CPU detectors will not pe
|
|||||||
|
|
||||||
A full-frame zone in `required_zones` is not recommended, especially if you've calibrated your camera and there are `movement_weights` defined in the configuration file. Frigate will continue to autotrack an object that has entered one of the `required_zones`, even if it moves outside of that zone.
|
A full-frame zone in `required_zones` is not recommended, especially if you've calibrated your camera and there are `movement_weights` defined in the configuration file. Frigate will continue to autotrack an object that has entered one of the `required_zones`, even if it moves outside of that zone.
|
||||||
|
|
||||||
Some users have found it helpful to adjust the zone `inertia` value. See the [configuration reference](index.md).
|
Some users have found it helpful to adjust the zone `inertia` value. See the [configuration reference](advanced/reference.md).
|
||||||
|
|
||||||
## Zooming
|
## Zooming
|
||||||
|
|
||||||
|
|||||||
@ -1,5 +1,5 @@
|
|||||||
---
|
---
|
||||||
id: index
|
id: config
|
||||||
title: Frigate Configuration
|
title: Frigate Configuration
|
||||||
---
|
---
|
||||||
|
|
||||||
@ -11,7 +11,7 @@ Frigate intelligently displays your camera streams on the Live view dashboard. B
|
|||||||
|
|
||||||
### Live View technologies
|
### Live View technologies
|
||||||
|
|
||||||
Frigate intelligently uses three different streaming technologies to display your camera streams on the dashboard and the single camera view, switching between available modes based on network bandwidth, player errors, or required features like two-way talk. The highest quality and fluency of the Live view requires the bundled `go2rtc` to be [configured](/configuration/go2rtc).
|
Frigate intelligently uses three different streaming technologies to display your camera streams on the dashboard and the single camera view, switching between available modes based on network bandwidth, player errors, or required features like two-way talk. The highest quality and fluency of the Live view requires the bundled `go2rtc` to be configured as shown in the [step by step guide](/configuration/advanced/go2rtc).
|
||||||
|
|
||||||
The jsmpeg live view will use more browser and client GPU resources. Using go2rtc is highly recommended and will provide a superior experience.
|
The jsmpeg live view will use more browser and client GPU resources. Using go2rtc is highly recommended and will provide a superior experience.
|
||||||
|
|
||||||
|
|||||||
@ -600,7 +600,7 @@ There are several variants of the App available:
|
|||||||
|
|
||||||
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.
|
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 App](https://github.com/hassio-addons/addon-vscode) or similar. In that case, the configuration file will be at `/addon_configs/<addon_directory>/config.yml`, where `<addon_directory>` 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).
|
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/<addon_directory>/config.yml`, where `<addon_directory>` is specific to the variant of the Frigate App you are running. See the list of directories [here](../configuration/advanced/config.md#accessing-app-config-dir).
|
||||||
|
|
||||||
## Kubernetes
|
## Kubernetes
|
||||||
|
|
||||||
|
|||||||
@ -301,7 +301,7 @@ cameras:
|
|||||||
|
|
||||||
More details on available detectors can be found [here](../configuration/object_detectors.md).
|
More details on available detectors can be found [here](../configuration/object_detectors.md).
|
||||||
|
|
||||||
Restart Frigate and you should start seeing detections for `person`. If you want to track other objects, they can be configured in <NavPath path="Settings > Global configuration > Objects" /> or via the [configuration file reference](../configuration/reference.md).
|
Restart Frigate and you should start seeing detections for `person`. If you want to track other objects, they can be configured in <NavPath path="Settings > Global configuration > Objects" /> or via the [configuration file reference](../configuration/advanced/reference.md).
|
||||||
|
|
||||||
### Step 5: Setup motion masks
|
### Step 5: Setup motion masks
|
||||||
|
|
||||||
@ -388,14 +388,14 @@ If you only plan to use Frigate for recording, it is still recommended to define
|
|||||||
|
|
||||||
:::
|
:::
|
||||||
|
|
||||||
By default, Frigate will retain video of all tracked objects for 10 days. The full set of options for recording can be found [here](../configuration/reference.md).
|
By default, Frigate will retain video of all tracked objects for 10 days. The full set of options for recording can be found [here](../configuration/advanced/reference.md).
|
||||||
|
|
||||||
### Step 7: Complete config
|
### Step 7: Complete config
|
||||||
|
|
||||||
At this point you have a complete config with basic functionality.
|
At this point you have a complete config with basic functionality.
|
||||||
|
|
||||||
- View [common configuration examples](../configuration/index.md#common-configuration-examples) for a list of common configuration examples.
|
- View [common configuration examples](../configuration/advanced/config.md#common-configuration-examples) for a list of common configuration examples.
|
||||||
- View [full config reference](../configuration/reference.md) for a complete list of configuration options.
|
- View [full config reference](../configuration/advanced/reference.md) for a complete list of configuration options.
|
||||||
|
|
||||||
### Follow up
|
### Follow up
|
||||||
|
|
||||||
|
|||||||
@ -24,7 +24,7 @@ Video decoding is one of the most CPU-intensive tasks in Frigate. While an AI ac
|
|||||||
|
|
||||||
### Configuration
|
### Configuration
|
||||||
|
|
||||||
Frigate provides preset configurations for common hardware acceleration scenarios. Set up `hwaccel_args` based on your hardware in your [configuration](../configuration/reference) as described in the [getting started guide](../guides/getting_started).
|
Frigate provides preset configurations for common hardware acceleration scenarios. Set up `hwaccel_args` based on your hardware in your [configuration](../configuration/advanced/reference) as described in the [getting started guide](../guides/getting_started).
|
||||||
|
|
||||||
### Troubleshooting Hardware Acceleration
|
### Troubleshooting Hardware Acceleration
|
||||||
|
|
||||||
|
|||||||
@ -7,7 +7,7 @@ import ConfigTabs from "@site/src/components/ConfigTabs";
|
|||||||
import TabItem from "@theme/TabItem";
|
import TabItem from "@theme/TabItem";
|
||||||
import NavPath from "@site/src/components/NavPath";
|
import NavPath from "@site/src/components/NavPath";
|
||||||
|
|
||||||
This page covers common problems with the bundled [go2rtc](/configuration/go2rtc) and how to resolve them, whether your cameras were added with the setup wizard or configured by hand.
|
This page covers common problems with the bundled [go2rtc](/configuration/advanced/go2rtc) and how to resolve them, whether your cameras were added with the setup wizard or configured by hand.
|
||||||
|
|
||||||
When a stream won't play or behaves oddly, the most important first step is to figure out **where** in the pipeline it breaks. Frigate's live view is a chain — _camera → go2rtc → your browser_ — and each stage fails for different reasons. Work through the checks below in order, then jump to the matching problem category.
|
When a stream won't play or behaves oddly, the most important first step is to figure out **where** in the pipeline it breaks. Frigate's live view is a chain — _camera → go2rtc → your browser_ — and each stage fails for different reasons. Work through the checks below in order, then jump to the matching problem category.
|
||||||
|
|
||||||
|
|||||||
188
docs/sidebars.ts
188
docs/sidebars.ts
@ -21,88 +21,116 @@ const sidebars: SidebarsConfig = {
|
|||||||
"guides/ha_network_storage",
|
"guides/ha_network_storage",
|
||||||
"guides/reverse_proxy",
|
"guides/reverse_proxy",
|
||||||
],
|
],
|
||||||
Configuration: {
|
Configuration: [
|
||||||
"Configuration Files": [
|
"configuration/config",
|
||||||
"configuration/index",
|
{
|
||||||
"configuration/reference",
|
type: "category",
|
||||||
{
|
label: "Detectors",
|
||||||
type: "link",
|
items: [
|
||||||
label: "Go2RTC Configuration Reference",
|
"configuration/object_detectors",
|
||||||
href: "https://github.com/AlexxIT/go2rtc/tree/v1.9.13#configuration",
|
"configuration/audio_detectors",
|
||||||
} as PropSidebarItemLink,
|
],
|
||||||
],
|
},
|
||||||
Detectors: [
|
{
|
||||||
"configuration/object_detectors",
|
type: "category",
|
||||||
"configuration/audio_detectors",
|
label: "Enrichments",
|
||||||
],
|
items: [
|
||||||
Enrichments: [
|
"configuration/semantic_search",
|
||||||
"configuration/semantic_search",
|
"configuration/face_recognition",
|
||||||
"configuration/face_recognition",
|
"configuration/license_plate_recognition",
|
||||||
"configuration/license_plate_recognition",
|
"configuration/bird_classification",
|
||||||
"configuration/bird_classification",
|
{
|
||||||
{
|
type: "category",
|
||||||
type: "category",
|
label: "Custom Classification",
|
||||||
label: "Custom Classification",
|
link: {
|
||||||
link: {
|
type: "generated-index",
|
||||||
type: "generated-index",
|
title: "Custom Classification",
|
||||||
title: "Custom Classification",
|
description: "Configuration for custom classification models",
|
||||||
description: "Configuration for custom classification models",
|
},
|
||||||
|
items: [
|
||||||
|
"configuration/custom_classification/state_classification",
|
||||||
|
"configuration/custom_classification/object_classification",
|
||||||
|
],
|
||||||
},
|
},
|
||||||
items: [
|
{
|
||||||
"configuration/custom_classification/state_classification",
|
type: "category",
|
||||||
"configuration/custom_classification/object_classification",
|
label: "Generative AI",
|
||||||
],
|
link: {
|
||||||
},
|
type: "generated-index",
|
||||||
{
|
title: "Generative AI",
|
||||||
type: "category",
|
description: "Generative AI Features",
|
||||||
label: "Generative AI",
|
},
|
||||||
link: {
|
items: [
|
||||||
type: "generated-index",
|
"configuration/genai/genai_config",
|
||||||
title: "Generative AI",
|
"configuration/genai/genai_review",
|
||||||
description: "Generative AI Features",
|
"configuration/genai/genai_objects",
|
||||||
|
],
|
||||||
},
|
},
|
||||||
items: [
|
],
|
||||||
"configuration/genai/genai_config",
|
},
|
||||||
"configuration/genai/genai_review",
|
{
|
||||||
"configuration/genai/genai_objects",
|
type: "category",
|
||||||
],
|
label: "Cameras",
|
||||||
},
|
items: [
|
||||||
],
|
"configuration/cameras",
|
||||||
Cameras: [
|
"configuration/review",
|
||||||
"configuration/cameras",
|
"configuration/record",
|
||||||
"configuration/review",
|
"configuration/exports",
|
||||||
"configuration/record",
|
"configuration/snapshots",
|
||||||
"configuration/exports",
|
"configuration/motion_detection",
|
||||||
"configuration/snapshots",
|
"configuration/birdseye",
|
||||||
"configuration/motion_detection",
|
"configuration/live",
|
||||||
"configuration/birdseye",
|
"configuration/restream",
|
||||||
"configuration/live",
|
"configuration/autotracking",
|
||||||
"configuration/restream",
|
"configuration/camera_specific",
|
||||||
"configuration/autotracking",
|
],
|
||||||
"configuration/camera_specific",
|
},
|
||||||
],
|
{
|
||||||
Objects: [
|
type: "category",
|
||||||
"configuration/object_filters",
|
label: "Objects",
|
||||||
"configuration/masks",
|
items: [
|
||||||
"configuration/zones",
|
"configuration/object_filters",
|
||||||
"configuration/objects",
|
"configuration/masks",
|
||||||
"configuration/stationary_objects",
|
"configuration/zones",
|
||||||
],
|
"configuration/objects",
|
||||||
"Hardware Acceleration": [
|
"configuration/stationary_objects",
|
||||||
"configuration/hardware_acceleration_video",
|
],
|
||||||
"configuration/hardware_acceleration_enrichments",
|
},
|
||||||
],
|
{
|
||||||
"Extra Configuration": [
|
type: "category",
|
||||||
"configuration/authentication",
|
label: "Hardware Acceleration",
|
||||||
"configuration/notifications",
|
items: [
|
||||||
"configuration/profiles",
|
"configuration/hardware_acceleration_video",
|
||||||
"configuration/go2rtc",
|
"configuration/hardware_acceleration_enrichments",
|
||||||
"configuration/ffmpeg_presets",
|
],
|
||||||
"configuration/pwa",
|
},
|
||||||
"configuration/tls",
|
{
|
||||||
"configuration/advanced",
|
type: "category",
|
||||||
],
|
label: "Extra Configuration",
|
||||||
},
|
items: [
|
||||||
|
"configuration/authentication",
|
||||||
|
"configuration/notifications",
|
||||||
|
"configuration/profiles",
|
||||||
|
"configuration/go2rtc",
|
||||||
|
"configuration/ffmpeg_presets",
|
||||||
|
"configuration/pwa",
|
||||||
|
"configuration/tls",
|
||||||
|
],
|
||||||
|
},
|
||||||
|
{
|
||||||
|
type: "category",
|
||||||
|
label: "Advanced Configuration",
|
||||||
|
items: [
|
||||||
|
"configuration/advanced/system",
|
||||||
|
"configuration/advanced/reference",
|
||||||
|
{
|
||||||
|
type: "link",
|
||||||
|
label: "Go2RTC Configuration Reference",
|
||||||
|
href: "https://github.com/AlexxIT/go2rtc/tree/v1.9.13#configuration",
|
||||||
|
} as PropSidebarItemLink,
|
||||||
|
],
|
||||||
|
},
|
||||||
|
],
|
||||||
Integrations: [
|
Integrations: [
|
||||||
"integrations/plus",
|
"integrations/plus",
|
||||||
"integrations/home-assistant",
|
"integrations/home-assistant",
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user