2025-03-12 21:54:20 +03:00
|
|
|
import type { SidebarsConfig } from "@docusaurus/plugin-content-docs";
|
|
|
|
|
import { PropSidebarItemLink } from "@docusaurus/plugin-content-docs";
|
|
|
|
|
import frigateHttpApiSidebar from "./docs/integrations/api/sidebar";
|
2024-10-07 23:27:35 +03:00
|
|
|
|
|
|
|
|
const sidebars: SidebarsConfig = {
|
|
|
|
|
docs: {
|
|
|
|
|
Frigate: [
|
2025-09-25 14:15:04 +03:00
|
|
|
"frigate/index",
|
|
|
|
|
"frigate/hardware",
|
|
|
|
|
"frigate/planning_setup",
|
|
|
|
|
"frigate/installation",
|
|
|
|
|
"frigate/updating",
|
|
|
|
|
"frigate/camera_setup",
|
|
|
|
|
"frigate/video_pipeline",
|
|
|
|
|
"frigate/glossary",
|
2024-10-07 23:27:35 +03:00
|
|
|
],
|
|
|
|
|
Guides: [
|
2025-03-12 21:54:20 +03:00
|
|
|
"guides/getting_started",
|
|
|
|
|
"guides/configuring_go2rtc",
|
|
|
|
|
"guides/ha_notifications",
|
|
|
|
|
"guides/ha_network_storage",
|
|
|
|
|
"guides/reverse_proxy",
|
2024-10-07 23:27:35 +03:00
|
|
|
],
|
|
|
|
|
Configuration: {
|
2025-03-12 21:54:20 +03:00
|
|
|
"Configuration Files": [
|
|
|
|
|
"configuration/index",
|
|
|
|
|
"configuration/reference",
|
2024-10-07 23:27:35 +03:00
|
|
|
{
|
2025-03-12 21:54:20 +03:00
|
|
|
type: "link",
|
|
|
|
|
label: "Go2RTC Configuration Reference",
|
2026-01-14 18:15:45 +03:00
|
|
|
href: "https://github.com/AlexxIT/go2rtc/tree/v1.9.13#configuration",
|
2024-10-07 23:27:35 +03:00
|
|
|
} as PropSidebarItemLink,
|
|
|
|
|
],
|
|
|
|
|
Detectors: [
|
2025-03-12 21:54:20 +03:00
|
|
|
"configuration/object_detectors",
|
|
|
|
|
"configuration/audio_detectors",
|
2024-10-07 23:27:35 +03:00
|
|
|
],
|
2025-03-26 22:42:30 +03:00
|
|
|
Enrichments: [
|
2025-03-12 21:54:20 +03:00
|
|
|
"configuration/semantic_search",
|
|
|
|
|
"configuration/face_recognition",
|
|
|
|
|
"configuration/license_plate_recognition",
|
2025-03-26 22:42:30 +03:00
|
|
|
"configuration/bird_classification",
|
2025-09-23 17:29:16 +03:00
|
|
|
{
|
|
|
|
|
type: "category",
|
|
|
|
|
label: "Custom Classification",
|
|
|
|
|
link: {
|
|
|
|
|
type: "generated-index",
|
|
|
|
|
title: "Custom Classification",
|
|
|
|
|
description: "Configuration for custom classification models",
|
|
|
|
|
},
|
|
|
|
|
items: [
|
|
|
|
|
"configuration/custom_classification/state_classification",
|
|
|
|
|
"configuration/custom_classification/object_classification",
|
|
|
|
|
],
|
|
|
|
|
},
|
2025-08-14 00:37:00 +03:00
|
|
|
{
|
|
|
|
|
type: "category",
|
|
|
|
|
label: "Generative AI",
|
|
|
|
|
link: {
|
|
|
|
|
type: "generated-index",
|
|
|
|
|
title: "Generative AI",
|
|
|
|
|
description: "Generative AI Features",
|
|
|
|
|
},
|
|
|
|
|
items: [
|
|
|
|
|
"configuration/genai/genai_config",
|
|
|
|
|
"configuration/genai/genai_review",
|
|
|
|
|
"configuration/genai/genai_objects",
|
|
|
|
|
],
|
|
|
|
|
},
|
2024-10-07 23:27:35 +03:00
|
|
|
],
|
|
|
|
|
Cameras: [
|
2025-03-12 21:54:20 +03:00
|
|
|
"configuration/cameras",
|
|
|
|
|
"configuration/review",
|
|
|
|
|
"configuration/record",
|
|
|
|
|
"configuration/snapshots",
|
|
|
|
|
"configuration/motion_detection",
|
|
|
|
|
"configuration/birdseye",
|
|
|
|
|
"configuration/live",
|
|
|
|
|
"configuration/restream",
|
|
|
|
|
"configuration/autotracking",
|
|
|
|
|
"configuration/camera_specific",
|
2024-10-07 23:27:35 +03:00
|
|
|
],
|
|
|
|
|
Objects: [
|
2025-03-12 21:54:20 +03:00
|
|
|
"configuration/object_filters",
|
|
|
|
|
"configuration/masks",
|
|
|
|
|
"configuration/zones",
|
|
|
|
|
"configuration/objects",
|
|
|
|
|
"configuration/stationary_objects",
|
2024-10-07 23:27:35 +03:00
|
|
|
],
|
2025-05-01 16:17:35 +03:00
|
|
|
"Hardware Acceleration": [
|
|
|
|
|
"configuration/hardware_acceleration_video",
|
|
|
|
|
"configuration/hardware_acceleration_enrichments",
|
|
|
|
|
],
|
2025-03-12 21:54:20 +03:00
|
|
|
"Extra Configuration": [
|
|
|
|
|
"configuration/authentication",
|
|
|
|
|
"configuration/notifications",
|
Camera profile support (#22482)
* add CameraProfileConfig model for named config overrides
* add profiles field to CameraConfig
* add active_profile field to FrigateConfig
Runtime-only field excluded from YAML serialization, tracks which
profile is currently active.
* add ProfileManager for profile activation and persistence
Handles snapshotting base configs, applying profile overrides via
deep_merge + apply_section_update, publishing ZMQ updates, and
persisting active profile to /config/.active_profile.
* add profile API endpoints (GET /profiles, GET/PUT /profile)
* add MQTT and dispatcher integration for profiles
- Subscribe to frigate/profile/set MQTT topic
- Publish profile/state and profiles/available on connect
- Add _on_profile_command handler to dispatcher
- Broadcast active profile state on WebSocket connect
* wire ProfileManager into app startup and FastAPI
- Create ProfileManager after dispatcher init
- Restore persisted profile on startup
- Pass dispatcher and profile_manager to FastAPI app
* add tests for invalid profile values and keys
Tests that Pydantic rejects: invalid field values (fps: "not_a_number"),
unknown section keys (ffmpeg in profile), invalid nested values, and
invalid profiles in full config parsing.
* formatting
* fix CameraLiveConfig JSON serialization error on profile activation
refactor _publish_updates to only publish ZMQ updates for
sections that actually changed, not all sections on affected cameras.
* consolidate
* add enabled field to camera profiles for enabling/disabling cameras
* add zones support to camera profiles
* add frontend profile types, color utility, and config save support
* add profile state management and save preview support
* add profileName prop to BaseSection for profile-aware config editing
* add profile section dropdown and wire into camera settings pages
* add per-profile camera enable/disable to Camera Management view
* add profiles summary page with card-based layout and fix backend zone comparison bug
* add active profile badge to settings toolbar
* i18n
* add red dot for any pending changes including profiles
* profile support for mask and zone editor
* fix hidden field validation errors caused by lodash wildcard and schema gaps
lodash unset does not support wildcard (*) segments, so hidden fields like
filters.*.mask were never stripped from form data, leaving null raw_coordinates
that fail RJSF anyOf validation. Add unsetWithWildcard helper and also strip
hidden fields from the JSON schema itself as defense-in-depth.
* add face_recognition and lpr to profile-eligible sections
* move profile dropdown from section panes to settings header
* add profiles enable toggle and improve empty state
* formatting
* tweaks
* tweak colors and switch
* fix profile save diff, masksAndZones delete, and config sync
* ui tweaks
* ensure profile manager gets updated config
* rename profile settings to ui settings
* refactor profilesview and add dots/border colors when overridden
* implement an update_config method for profile manager
* fix mask deletion
* more unique colors
* add top-level profiles config section with friendly names
* implement profile friendly names and improve profile UI
- Add ProfileDefinitionConfig type and profiles field to FrigateConfig
- Use ProfilesApiResponse type with friendly_name support throughout
- Replace Record<string, unknown> with proper JsonObject/JsonValue types
- Add profile creation form matching zone pattern (Zod + NameAndIdFields)
- Add pencil icon for renaming profile friendly names in ProfilesView
- Move Profiles menu item to first under Camera Configuration
- Add activity indicators on save/rename/delete buttons
- Display friendly names in CameraManagementView profile selector
- Fix duplicate colored dots in management profile dropdown
- Fix i18n namespace for overridden base config tooltips
- Move profile override deletion from dropdown trash icon to footer
button with confirmation dialog, matching Reset to Global pattern
- Remove Add Profile from section header dropdown to prevent saving
camera overrides before top-level profile definition exists
- Clean up newProfiles state after API profile deletion
- Refresh profiles SWR cache after saving profile definitions
* remove profile badge in settings and add profiles to main menu
* use icon only on mobile
* change color order
* docs
* show activity indicator on trash icon while deleting a profile
* tweak language
* immediately create profiles on backend instead of deferring to Save All
* hide restart-required fields when editing a profile section
fields that require a restart cannot take effect via profile switching,
so they are merged into hiddenFields when profileName is set
* show active profile indicator in desktop status bar
* fix profile config inheritance bug where Pydantic defaults override base values
The /config API was dumping profile overrides with model_dump() which included
all Pydantic defaults. When the frontend merged these over
the camera's base config, explicitly-set base values were
lost. Now profile overrides are re-dumped with exclude_unset=True so only
user-specified fields are returned.
Also fixes the Save All path generating spurious deletion markers for
restart-required fields that are hidden during profile
editing but not excluded from the raw data sanitization in
prepareSectionSavePayload.
* docs tweaks
* docs tweak
* formatting
* formatting
* fix typing
* fix test pollution
test_maintainer was injecting MagicMock() into sys.modules["frigate.config.camera.updater"] at module load time and never restoring it. When the profile tests later imported CameraConfigUpdateEnum and CameraConfigUpdateTopic from that module, they got mock objects instead of the real dataclass/enum, so equality comparisons always failed
* remove
* fix settings showing profile-merged values when editing base config
When a profile is active, the in-memory config contains effective
(profile-merged) values. The settings UI was displaying these merged
values even when the "Base Config" view was selected.
Backend: snapshot pre-profile base configs in ProfileManager and expose
them via a `base_config` key in the /api/config camera response when a
profile is active. The top-level sections continue to reflect the
effective running config.
Frontend: read from `base_config` when available in BaseSection,
useConfigOverride, useAllCameraOverrides, and prepareSectionSavePayload.
Include formData labels in Object/Audio switches widgets so that labels
added only by a profile override remain visible when editing that profile.
* use rasterized_mask as field
makes it easier to exclude from the schema with exclude=True
prevents leaking of the field when using model_dump for profiles
* fix zones
- Fix zone colors not matching across profiles by falling back to base zone color when profile zone data lacks a color field
- Use base_config for base-layer values in masks/zones view so profile-merged values don't pollute the base config editing view
- Handle zones separately in profile manager snapshot/restore since ZoneConfig requires special serialization (color as private attr, contour generation)
- Inherit base zone color and generate contours for profile zone overrides in profile manager
* formatting
* don't require restart for camera enabled change for profiles
* publish camera state when changing profiles
* formatting
* remove available profiles from mqtt
* improve typing
2026-03-19 17:47:57 +03:00
|
|
|
"configuration/profiles",
|
2025-03-12 21:54:20 +03:00
|
|
|
"configuration/ffmpeg_presets",
|
2024-10-07 23:27:35 +03:00
|
|
|
"configuration/pwa",
|
2025-03-12 21:54:20 +03:00
|
|
|
"configuration/tls",
|
|
|
|
|
"configuration/advanced",
|
2024-10-07 23:27:35 +03:00
|
|
|
],
|
|
|
|
|
},
|
|
|
|
|
Integrations: [
|
2025-03-12 21:54:20 +03:00
|
|
|
"integrations/plus",
|
|
|
|
|
"integrations/home-assistant",
|
2024-10-07 23:27:35 +03:00
|
|
|
// This is the HTTP API generated by OpenAPI
|
|
|
|
|
{
|
2025-03-12 21:54:20 +03:00
|
|
|
type: "category",
|
|
|
|
|
label: "HTTP API",
|
2024-10-07 23:27:35 +03:00
|
|
|
link: {
|
2025-03-12 21:54:20 +03:00
|
|
|
type: "generated-index",
|
|
|
|
|
title: "Frigate HTTP API",
|
|
|
|
|
description: "HTTP API",
|
|
|
|
|
slug: "/integrations/api/frigate-http-api",
|
2024-10-07 23:27:35 +03:00
|
|
|
},
|
|
|
|
|
items: frigateHttpApiSidebar,
|
|
|
|
|
},
|
2025-03-12 21:54:20 +03:00
|
|
|
"integrations/mqtt",
|
2025-10-12 00:29:24 +03:00
|
|
|
"integrations/homekit",
|
2025-03-12 21:54:20 +03:00
|
|
|
"configuration/metrics",
|
|
|
|
|
"integrations/third_party_extensions",
|
2024-10-07 23:27:35 +03:00
|
|
|
],
|
2025-09-25 14:15:04 +03:00
|
|
|
"Frigate+": [
|
|
|
|
|
"plus/index",
|
|
|
|
|
"plus/annotating",
|
|
|
|
|
"plus/first_model",
|
|
|
|
|
"plus/faq",
|
2024-10-07 23:27:35 +03:00
|
|
|
],
|
|
|
|
|
Troubleshooting: [
|
2025-03-12 21:54:20 +03:00
|
|
|
"troubleshooting/faqs",
|
|
|
|
|
"troubleshooting/recordings",
|
2025-12-18 02:52:27 +03:00
|
|
|
"troubleshooting/dummy-camera",
|
2026-01-04 21:12:03 +03:00
|
|
|
{
|
|
|
|
|
type: "category",
|
|
|
|
|
label: "Troubleshooting Hardware",
|
|
|
|
|
link: {
|
|
|
|
|
type: "generated-index",
|
|
|
|
|
title: "Troubleshooting Hardware",
|
|
|
|
|
description: "Troubleshooting Problems with Hardware",
|
|
|
|
|
},
|
|
|
|
|
items: ["troubleshooting/gpu", "troubleshooting/edgetpu"],
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
type: "category",
|
|
|
|
|
label: "Troubleshooting Resource Usage",
|
|
|
|
|
link: {
|
|
|
|
|
type: "generated-index",
|
|
|
|
|
title: "Troubleshooting Resource Usage",
|
|
|
|
|
description: "Troubleshooting issues with resource usage",
|
|
|
|
|
},
|
|
|
|
|
items: ["troubleshooting/cpu", "troubleshooting/memory"],
|
|
|
|
|
},
|
2024-10-07 23:27:35 +03:00
|
|
|
],
|
|
|
|
|
Development: [
|
2025-03-12 21:54:20 +03:00
|
|
|
"development/contributing",
|
|
|
|
|
"development/contributing-boards",
|
2024-10-07 23:27:35 +03:00
|
|
|
],
|
|
|
|
|
},
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
export default sidebars;
|