administrator/frigate
1
0
Fork 0
mirror of https://github.com/blakeblackshear/frigate.git synced 2026-01-23 12:38:29 +03:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity
0e2480005e
frigate/docs
History
DMontgomery40 f4ce7db1ac Add comprehensive GUI configuration editor 
Implements a complete GUI-based configuration editor that provides a
user-friendly alternative to editing YAML files. No more YAML nightmares!

## Features

### Complete Coverage
- ALL 500+ configuration fields across 70+ nested objects accessible
- 35 top-level sections with 100% schema coverage
- 27 camera fields with 20 nested sub-configurations
- Every detector type, every option, every setting

### User-Friendly Interface
- 17+ tabbed sections for logical organization
- Schema-driven form generation (auto-adapts to new fields)
- Tooltips on every field with descriptions
- Real-time validation with helpful error messages
- Smart defaults pre-filled
- Example values in placeholders

### Sections Include
- Cameras (streams, detection, zones, recording, motion, PTZ)
- Detectors (Coral, OpenVINO, TensorRT, CPU, etc.)
- Objects (tracking, filters, masks)
- Recording (retention, storage, events)
- Snapshots (capture, retention)
- Motion Detection
- MQTT (broker, topics)
- Audio Detection & Transcription
- Face Recognition
- License Plate Recognition (LPR)
- Semantic Search
- Birdseye View
- Review System
- GenAI Integration
- Authentication & Roles
- UI Preferences
- Advanced (database, logging, telemetry, networking, proxy, TLS)

### Technical Implementation
- React Hook Form for performant form state
- Schema-driven architecture (single source of truth)
- TypeScript for type safety
- Radix UI components for accessibility
- Comprehensive validation
- YAML ↔ GUI mode toggle

### Files Added
- web/src/components/config/GuiConfigEditor.tsx - Main editor
- web/src/components/config/SchemaFormRenderer.tsx - Schema-to-UI engine
- web/src/components/config/fields/* - Field components (7 types)
- web/src/components/config/sections/* - Section components
- web/src/lib/configUtils.ts - YAML conversion & validation
- web/src/types/configSchema.ts - TypeScript types
- docs/docs/guides/config_gui.md - User documentation
- COMPLETE_CONFIG_SCHEMA.json - Full schema reference
- CONFIG_SCHEMA_SUMMARY.md - Schema documentation
- verify_gui_completeness.py - Coverage verification script

### Verification
Smoke test confirms 100% coverage:
- ✅ 35 top-level sections (ALL in schema)
- ✅ 26 explicit GUI tabs
- ✅ 27 camera fields with 20 sub-configs
- ✅ All JSON Schema types supported
- ✅ Every field accessible
2025-09-29 23:09:38 -06:00
..
docs Add comprehensive GUI configuration editor 2025-09-29 23:09:38 -06:00
plugins docs: include available objects in documentation 2021-03-09 06:23:37 -06:00
src Add chinese docs (#17954) 2025-05-06 08:49:49 -06:00
static Update openapi schema with include_thumbnails deprecation comment (#19777) 2025-08-26 15:24:43 -06:00
.gitignore docs: move docs to docusaurus 2021-01-26 21:40:33 -06:00
babel.config.js docs: move docs to docusaurus 2021-01-26 21:40:33 -06:00
docusaurus.config.ts Merge remote-tracking branch 'origin/master' into dev 2025-06-27 06:53:02 -05:00
package-lock.json Deps updates (#20133) 2025-09-19 06:02:02 -05:00
package.json Merge remote-tracking branch 'origin/master' into dev 2025-06-27 06:53:02 -05:00
README.md Use Swagger documentation for Frigate HTTP API (#14178) 2024-10-07 14:27:35 -06:00
sidebars.ts Update go2rtc to 1.9.10 (#20202) 2025-09-25 06:15:04 -05:00

README.md

Website

This website is built using Docusaurus 3.5, a modern static website generator.

For installation and contributing instructions, please follow the Contributing Docs.

Development

  1. Run npm i to install dependencies
  2. Run npm run start to start the website