入门指南
提示
如果你已经有一个安装了 Linux 和 Docker 的环境，可以直接跳转到下面的安装 Frigate部分。
如果你已经通过 Docker 或 Home Assistant 插件安装了 Frigate，可以直接跳转到下面的配置 Frigate部分。
硬件设置
本节将指导你如何在服务器上安装 Debian Bookworm 并安装 Docker。
安装 Debian 12 (Bookworm)
关于如何安装 Debian 服务器有很多指南，所以这里只提供简略指南。将临时显示器和键盘连接到你的设备，以便安装一个没有桌面环境的最小化服务器。
准备安装媒介
- 从Debian 网站下载小型安装镜像
- 将 ISO 写入 USB 设备（推荐使用balena Etcher工具）
- 从 USB 启动你的设备
安装并设置 Debian 以进行远程访问
- 确保你的设备已连接到网络，以便可以安装更新和软件
- 如果没有连接鼠标，选择非图形化安装选项，但两种安装方式都可以正常工作
- 系统会提示你设置 root 用户密码并创建一个带密码的用户
- 安装最小化软件。更少的依赖意味着更少的维护工作。
- 取消选中"Debian 桌面环境"和"GNOME"
- 选中"SSH 服务器"
- 保持"标准系统实用工具"选中
- 重启后，以 root 身份登录命令提示符，将用户添加到 sudoers
- 安装 sudobash
apt update && apt install -y sudo - 将你创建的用户添加到 sudo 组（将
blake改为你自己的用户名）bashusermod -aG sudo blake
- 安装 sudo
- 运行
poweroff关机
此时，你可以将设备安装到永久位置。剩余步骤可以通过 SSH 从另一台设备完成。如果你没有 SSH 客户端，可以安装Visual Studio Code 文档中列出的选项之一。
通过 SSH 完成设置
通过 SSH 连接并使用安装时创建的非 root 用户登录
设置无密码 sudo，这样就不用每次执行 sudo 命令时都输入密码（将下面命令中的
blake改为你的用户名）bashecho 'blake ALL=(ALL) NOPASSWD:ALL' | sudo tee /etc/sudoers.d/user注销并重新登录以激活无密码 sudo
为操作系统设置自动安全更新（可选）
- 运行以下命令确保所有内容都是最新的bash
sudo apt update && sudo apt upgrade -y - 安装无人值守更新bash
sudo apt install -y unattended-upgrades echo unattended-upgrades unattended-upgrades/enable_auto_updates boolean true | sudo debconf-set-selections sudo dpkg-reconfigure -f noninteractive unattended-upgrades
- 运行以下命令确保所有内容都是最新的
现在你有了一个需要很少维护的最小化 Debian 服务器。
安装 Docker
- 使用官方文档安装 Docker Engine（不是 Docker Desktop）
- 具体来说，按照使用 apt 仓库安装部分的步骤操作
- 按照Linux 安装后步骤中的说明将你的用户添加到 docker 组
安装 Frigate
本节展示如何在 Debian 上为 Docker 安装创建最小目录结构。如果你已经通过 Home Assistant 插件或其他方式安装了 Frigate，可以继续配置 Frigate部分。
设置目录
如果配置文件在初始启动时不存在，Frigate 将创建一个配置文件。以下目录结构是开始所需的最低要求。一旦 Frigate 运行起来，你可以使用内置的配置编辑器，它支持配置验证。
.
├── docker-compose.yml
├── config/
└── storage/这将创建上述结构：
mkdir storage config && touch docker-compose.yml如果你通过 SSH 在 Linux 设备上设置 Frigate，可以使用nano来编辑以下文件。如果你更喜欢使用完整的编辑器而不是终端来编辑远程文件，我推荐使用带Remote SSH 扩展的Visual Studio Code。
NOTE
这个docker-compose.yml文件只是 amd64 设备的入门文件。你需要根据安装文档中的详细说明来自定义它以适应你的设置。
docker-compose.yml
services:
frigate:
container_name: frigate
restart: unless-stopped
stop_grace_period: 30s
image: docker.cnb.cool/frigate-cn/frigate:stable
volumes:
- ./config:/config
- ./storage:/media/frigate
- type: tmpfs # 可选：1GB内存，减少SSD/SD卡损耗
target: /tmp/cache
tmpfs:
size: 1000000000
ports:
- '8971:8971'
- '8554:8554' # RTSP 视频流现在你应该可以在包含docker-compose.yml的文件夹中运行docker compose up -d来启动 Frigate。在启动时，系统会创建一个管理员用户和密码，并在日志中输出。你可以通过运行docker logs frigate来查看。现在应该可以通过https://server_ip:8971访问 Frigate，你可以使用admin用户登录并使用内置的配置编辑器完成配置。
配置 Frigate
本节假设你已经按照安装中的说明设置了环境。你还应该根据摄像头设置指南配置你的摄像头。特别注意选择检测分辨率的部分。
步骤 1：添加检测流
首先我们将为摄像头添加检测（detect）视频流：
mqtt:
enabled: False
cameras:
name_of_your_camera: # <------ 命名你的摄像头
enabled: True
ffmpeg:
inputs:
- path: rtsp://10.0.10.10:554/rtsp # <----- 你想用于检测的视频流地址
roles:
- detect步骤 2：启动 Frigate
此时你应该能够启动 Frigate 并在实时监控页面中看到视频画面。
如果你从摄像头获得错误图像，这意味着 ffmpeg 无法从你的摄像头获取视频流。检查日志中的 ffmpeg 错误消息。默认的 ffmpeg 参数设计用于支持 TCP 连接的 H264 RTSP 摄像头。
其他类型摄像头的 FFmpeg 参数可以在这里找到。
步骤 3：配置硬件加速（推荐）
现在你已经有了一个工作正常的摄像头配置，你需要设置硬件加速以最小化解码视频流所需的 CPU。查看硬件加速配置参考，了解适用于你的硬件的示例。
这里是一个使用预设配置硬件加速的示例，适用于大多数带核显的 Intel 处理器：
docker-compose.yml（修改后，你需要运行docker compose up -d来应用更改）
services:
frigate:
...
devices:
- /dev/dri/renderD128:/dev/dri/renderD128 # 用于intel硬件加速，需要根据你的实际硬件添加
...config.yml
mqtt: ... # 省略号为文档省略部分，不代表后面没内容
ffmpeg:
hwaccel_args: preset-vaapi # 此处为所有摄像头设置全局硬件加速参数
cameras:
name_of_your_camera:
ffmpeg:
inputs: ... # 省略号为文档省略部分，不代表后面没内容
hwaccel_args: preset-vaapi # 此处为针对单个摄像头使用特定硬件加速参数，不遵循全局设定。
detect: ... # 省略号为文档省略部分，不代表后面没内容提示
如果你是 7 代以上的 Intel 处理器，更推荐使用qsv进行硬件加速。更多详细信息请见qsv 配置文档。
步骤 4：配置检测器
默认情况下，Frigate 将使用单个 CPU 检测器。如果你有 USB Coral，你需要在配置中添加检测器部分。
docker-compose.yml（修改后，你需要运行docker compose up -d来应用更改）
services:
frigate:
... # 省略号为文档省略部分，不代表后面没内容
devices:
- /dev/bus/usb:/dev/bus/usb # 传递USB Coral，需要为其他版本修改
- /dev/apex_0:/dev/apex_0 # 传递PCIe Coral，按照这里的驱动说明操作 https://github.com/jnicolson/gasket-builder
... # 省略号为文档省略部分，不代表后面没内容mqtt: ... # 省略号为文档省略部分，不代表后面没内容
detectors: # 下面将添加 Coral 检测器，根据你实际的硬件情况去调整
coral:
type: edgetpu
device: usb
cameras:
name_of_your_camera:
ffmpeg: ... # 省略号为文档省略部分，不代表后面没内容
detect:
enabled: True # <---- 开启检测
... # 省略号为文档省略部分，不代表后面没内容更多关于可用检测器的详细信息可以在这里找到。
重启 Frigate，你应该就能开始看到person的检测结果。如果你想追踪其他目标/物体，需要根据配置文件参考添加（请在页面下搜索检测的目标/物体配置）。
步骤 5：设置画面变动遮罩
现在你已经优化了解码视频流的配置，你需要检查在哪里实现画面变动遮罩。你可以直接在设置页面的遮罩/ 区域选项卡中来设置遮罩。更多关于遮罩的信息可以在这里找到。
警告
注意，画面变动遮罩不应用于标记你不想检测物品/目标的区域或减少误报。它们不会改变发送到物体/目标检测的图像，所以你仍然可以在有画面变动遮罩的区域获得追踪目标、警报和检测。这些只是防止这些区域的运动启动物体/目标检测。
你的配置现在应该看起来类似这样。
mqtt:
enabled: False
detectors:
coral:
type: edgetpu
device: usb
cameras:
name_of_your_camera:
ffmpeg:
inputs:
- path: rtsp://10.0.10.10:554/rtsp
roles:
- detect
motion: # 请直接在设置页面中添加遮罩，这里只是范例
mask:
- 0,461,3,0,1919,0,1919,843,1699,492,1344,458,1346,336,973,317,869,375,866,432步骤 6：启用录制
为了在 Frigate 页面中查看事件和回放，需要启用录制。
要启用视频录制，向流添加record功能并在配置中启用它。如果在配置中禁用了录制，就无法在页面中启用它。
mqtt: ... # 省略号为文档省略部分，不代表后面没内容
detectors: ... # 省略号为文档省略部分，不代表后面没内容
cameras:
name_of_your_camera:
ffmpeg:
inputs:
- path: rtsp://10.0.10.10:554/rtsp
roles:
- detect
- path: rtsp://10.0.10.10:554/high_res_stream # <----- 可以给录制设置独立的流 #
roles:
- record # 需要像这样给流配置record功能才能录制
detect: ... # 省略号为文档省略部分，不代表后面没内容
record: # <----- 启用录制
enabled: True
motion: ... # 省略号为文档省略部分，不代表后面没内容如果你的检测和录制没有单独的流，你只需要在第一个输入的功能列表中添加 record 功能。
NOTE
如果你在 inputs 中只定义了一个流且没有为其分配detect功能，Frigate 会自动为其分配detect功能。即使你在配置的detect部分使用enabled: False禁用了物体/目标检测，Frigate 仍然会解码一个流以支持画面变动检测、Birdseye、API 图像端点和其他功能。
如果你只计划使用 Frigate 进行录制，仍建议为低分辨率流定义一个detect功能，以最小化所需流解码的资源使用。
默认情况下，Frigate 会保留所有追踪目标的视频 10 天。完整的录制选项可以在这里找到。
步骤 7：完整配置
此时你已经有了一个具有基本功能的完整配置。
后续步骤
现在你已经有了一个可工作的安装，你可以使用以下文档了解其他功能：
- 配置 go2rtc - 额外的实时查看选项和 RTSP 中继
- 区域
- 回顾
- 遮罩
- Home Assistant 集成 - 与 Home Assistant 集成