mirror of
https://github.com/blakeblackshear/frigate.git
synced 2026-06-11 07:39:11 -04:00
b7cdc1c614
* refactor go2rtc docs * clarify go2rtc language in live * add export docs * Move around config items to reflect reference config is now for advanced users * Remove outdated ipv6 section * Fix broken links * live usage docs * review usage docs * history usage * explore usage * add usage sidebar and move related text to usage sections * update links * update live * move exports to usage * fix anchors * Make starts of usage pages consistent * refactor network config * Adjustments for review * Add AI details to history page * describe alerts vs detections in review usage * simplify --------- Co-authored-by: Nicolas Mowen <nickmowen213@gmail.com>
200 lines
5.6 KiB
TypeScript
200 lines
5.6 KiB
TypeScript
import type { SidebarsConfig } from "@docusaurus/plugin-content-docs";
|
|
import { PropSidebarItemLink } from "@docusaurus/plugin-content-docs";
|
|
import frigateHttpApiSidebar from "./docs/integrations/api/sidebar";
|
|
|
|
const sidebars: SidebarsConfig = {
|
|
docs: {
|
|
Frigate: [
|
|
"frigate/index",
|
|
"frigate/hardware",
|
|
"frigate/planning_setup",
|
|
"frigate/installation",
|
|
"frigate/updating",
|
|
"frigate/camera_setup",
|
|
"frigate/video_pipeline",
|
|
"frigate/network_requirements",
|
|
"frigate/glossary",
|
|
],
|
|
Guides: [
|
|
"guides/getting_started",
|
|
"guides/ha_notifications",
|
|
"guides/ha_network_storage",
|
|
"guides/reverse_proxy",
|
|
],
|
|
Usage: [
|
|
"usage/live",
|
|
"usage/review",
|
|
"usage/history",
|
|
"usage/explore",
|
|
"usage/exports",
|
|
],
|
|
Configuration: [
|
|
"configuration/config",
|
|
{
|
|
type: "category",
|
|
label: "Detectors",
|
|
items: [
|
|
"configuration/object_detectors",
|
|
"configuration/audio_detectors",
|
|
],
|
|
},
|
|
{
|
|
type: "category",
|
|
label: "Enrichments",
|
|
items: [
|
|
"configuration/semantic_search",
|
|
"configuration/face_recognition",
|
|
"configuration/license_plate_recognition",
|
|
"configuration/bird_classification",
|
|
{
|
|
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",
|
|
],
|
|
},
|
|
{
|
|
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",
|
|
],
|
|
},
|
|
],
|
|
},
|
|
{
|
|
type: "category",
|
|
label: "Cameras",
|
|
items: [
|
|
"configuration/cameras",
|
|
"configuration/review",
|
|
"configuration/record",
|
|
"configuration/snapshots",
|
|
"configuration/motion_detection",
|
|
"configuration/birdseye",
|
|
"configuration/live",
|
|
"configuration/restream",
|
|
"configuration/autotracking",
|
|
"configuration/camera_specific",
|
|
],
|
|
},
|
|
{
|
|
type: "category",
|
|
label: "Objects",
|
|
items: [
|
|
"configuration/object_filters",
|
|
"configuration/masks",
|
|
"configuration/zones",
|
|
"configuration/objects",
|
|
"configuration/stationary_objects",
|
|
],
|
|
},
|
|
{
|
|
type: "category",
|
|
label: "Hardware Acceleration",
|
|
items: [
|
|
"configuration/hardware_acceleration_video",
|
|
"configuration/hardware_acceleration_enrichments",
|
|
],
|
|
},
|
|
{
|
|
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/plus",
|
|
"integrations/home-assistant",
|
|
// This is the HTTP API generated by OpenAPI
|
|
{
|
|
type: "category",
|
|
label: "HTTP API",
|
|
link: {
|
|
type: "generated-index",
|
|
title: "Frigate HTTP API",
|
|
description: "HTTP API",
|
|
slug: "/integrations/api/frigate-http-api",
|
|
},
|
|
items: frigateHttpApiSidebar,
|
|
},
|
|
"integrations/mqtt",
|
|
"integrations/homekit",
|
|
"configuration/metrics",
|
|
"integrations/third_party_extensions",
|
|
],
|
|
"Frigate+": [
|
|
"plus/index",
|
|
"plus/annotating",
|
|
"plus/first_model",
|
|
"plus/faq",
|
|
],
|
|
Troubleshooting: [
|
|
"troubleshooting/faqs",
|
|
"troubleshooting/go2rtc",
|
|
"troubleshooting/recordings",
|
|
"troubleshooting/dummy-camera",
|
|
{
|
|
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"],
|
|
},
|
|
],
|
|
Development: [
|
|
"development/contributing",
|
|
"development/contributing-boards",
|
|
],
|
|
},
|
|
};
|
|
|
|
export default sidebars;
|