frigate/docs/docs/configuration
Josh Hawkins c93dad9bd9
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 09:47:57 -05:00
..
custom_classification Miscellaneous Fixes (0.17 beta) (#21474) 2025-12-31 05:48:56 -07:00
genai Debug replay (#22212) 2026-03-04 10:07:34 -06:00
advanced.md Add networking options for configuring listening ports (#21779) 2026-02-26 21:27:56 -07:00
audio_detectors.md docs: fix alt text and capitalization in documentation (#21551) 2026-01-07 07:22:05 -07:00
authentication.md Miscellaneous fixes (0.17 beta) (#21934) 2026-02-12 13:42:08 -07:00
autotracking.md Clarify docs on autotracking support (#20465) 2025-10-13 13:42:29 -06:00
bird_classification.md Bird classification docs (#17369) 2025-03-26 14:42:30 -05:00
birdseye.md Move database and config from homeassistant /config to addon /config (#16337) 2025-03-24 09:05:59 -05:00
camera_specific.md Update go2rtc to v1.9.13 (#21648) 2026-02-26 21:27:56 -07:00
cameras.md Miscellaneous fixes (0.17 beta) (#21699) 2026-01-20 08:17:58 -07:00
face_recognition.md Merge remote-tracking branch 'origin/master' into dev 2025-10-25 11:16:09 +00:00
ffmpeg_presets.md docs: rk ffmpeg preset is outdated (#19780) 2025-08-26 15:24:58 -06:00
hardware_acceleration_enrichments.md Docs updates (#22131) 2026-02-26 10:57:33 -07:00
hardware_acceleration_video.md Miscellaneous fixes (0.17 Beta) (#21489) 2026-01-04 12:12:03 -06:00
index.md Masks and zones improvements (#22163) 2026-02-28 07:04:43 -07:00
license_plate_recognition.md Miscellaneous fixes (0.17 beta) (#21867) 2026-02-03 08:31:00 -06:00
live.md Merge remote-tracking branch 'origin/master' into dev 2025-12-31 13:15:05 +00:00
masks.md Masks and zones improvements (#22163) 2026-02-28 07:04:43 -07:00
metrics.md Use /api/metrics instead of /metrics (#16425) 2025-02-09 12:50:42 -07:00
motion_detection.md Skip motion threshold configuration (#22255) 2026-03-05 18:20:03 -06:00
notifications.md Add note for notifications on iOS devices (#16744) 2025-02-22 09:19:37 -06:00
object_detectors.md Initial commit for AXERA AI accelerators (#22206) 2026-03-11 06:49:28 -06:00
object_filters.md Object area debugging and improvements (#16432) 2025-02-09 14:48:23 -07:00
objects.md Update object docs (#14295) 2024-10-12 07:13:00 -05:00
profiles.md Camera profile support (#22482) 2026-03-19 09:47:57 -05:00
pwa.md Update PWA requirements and add usage section (#20562) 2025-10-26 05:39:09 -06:00
record.md Media sync API refactor and UI (#21542) 2026-02-26 21:27:56 -07:00
reference.md Camera profile support (#22482) 2026-03-19 09:47:57 -05:00
restream.md Update go2rtc to v1.9.13 (#21648) 2026-02-26 21:27:56 -07:00
review.md Docs: Clarify review labels and objects to track (#16758) 2025-02-23 06:28:03 -07:00
semantic_search.md Support using GenAI for embeddings / semantic search (#22323) 2026-03-08 10:55:00 -05:00
snapshots.md docs: Add frame selection and clean copy details to snapshots docs (#21946) 2026-02-23 06:45:29 -07:00
stationary_objects.md Remove parked car guide as it is no longer relevant (#11451) 2024-05-20 22:56:03 +05:30
tls.md Update tls.md instructions for letsencrypt archive dir (#17747) 2025-04-16 16:57:39 -06:00
zones.md Masks and zones improvements (#22163) 2026-02-28 07:04:43 -07:00