administrator/frigate
1
0
Fork 0
mirror of https://github.com/blakeblackshear/frigate.git synced 2026-02-03 17:55:21 +03:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Update more docs

Browse Source
This commit is contained in:
Nick Mowen 2023-01-16 06:48:56 -07:00
parent af6c83bde1
commit 3b4ad18876
3 changed files with 16 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/docs/configuration/cameras.md
View File

@ -15,7 +15,6 @@ Each role can only be assigned to one input per camera. The options for roles ar
| ---------- | ---------------------------------------------------------------------------------------- | | ---------- | ---------------------------------------------------------------------------------------- |
| `detect` | Main feed for object detection | | `detect` | Main feed for object detection |
| `record` | Saves segments of the video feed based on configuration settings. [docs](record.md) | | `record` | Saves segments of the video feed based on configuration settings. [docs](record.md) |
| `restream` | Broadcast as RTSP feed and use the full res stream for live view. [docs](restream.md) |
| `rtmp` | Deprecated: Broadcast as an RTMP feed for other services to consume. [docs](restream.md) | | `rtmp` | Deprecated: Broadcast as an RTMP feed for other services to consume. [docs](restream.md) |
```yaml ```yaml
@ -29,7 +28,7 @@ cameras:
- path: rtsp://viewer:{FRIGATE_RTSP_PASSWORD}@10.0.10.10:554/cam/realmonitor?channel=1&subtype=2 - path: rtsp://viewer:{FRIGATE_RTSP_PASSWORD}@10.0.10.10:554/cam/realmonitor?channel=1&subtype=2
roles: roles:
- detect - detect
- rtmp - rtmp # <- deprecated, recommend using restream instead
- path: rtsp://viewer:{FRIGATE_RTSP_PASSWORD}@10.0.10.10:554/live - path: rtsp://viewer:{FRIGATE_RTSP_PASSWORD}@10.0.10.10:554/live
roles: roles:
- record - record

39
docs/docs/configuration/index.md
View File

@ -126,6 +126,9 @@ environment_vars:
birdseye: birdseye:
# Optional: Enable birdseye view (default: shown below) # Optional: Enable birdseye view (default: shown below)
enabled: True enabled: True
# Optional: Restream birdseye via RTSP (default: shown below)
# NOTE: Enabling this will set birdseye to run 24/7 which may increase CPU usage somewhat.
restream: False
# Optional: Width of the output resolution (default: shown below) # Optional: Width of the output resolution (default: shown below)
width: 1280 width: 1280
# Optional: Height of the output resolution (default: shown below) # Optional: Height of the output resolution (default: shown below)
@ -352,32 +355,18 @@ rtmp:
enabled: False enabled: False
# Optional: Restream configuration # Optional: Restream configuration
# NOTE: Can be overridden at the camera level # Uses https://github.com/AlexxIT/go2rtc
restream: restream:
# Optional: Enable the restream (default: True)
enabled: True # Optional: jsmpeg stream configuration for WebUI
# Optional: Set the audio codecs to restream with live:
# possible values are aac, copy, opus. Set to copy # Optional: Set the height of the jsmpeg stream. (default: 720)
# only to avoid transcoding (default: shown below) # This must be less than or equal to the height of the detect stream. Lower resolutions
audio_encoding: # reduce bandwidth required for viewing the jsmpeg stream. Width is computed to match known aspect ratio.
- aac height: 720
- opus # Optional: Set the encode quality of the jsmpeg stream (default: shown below)
# Optional: Video encoding to be used. By default the codec will be copied but # 1 is the highest quality, and 31 is the lowest. Lower quality feeds utilize less CPU resources.
# it can be switched to another or an MJPEG stream can be encoded and restreamed quality: 8
# as h264 (default: shown below)
video_encoding: "copy"
# Optional: Restream birdseye via RTSP (default: shown below)
# NOTE: Enabling this will set birdseye to run 24/7 which may increase CPU usage somewhat.
birdseye: False
# Optional: jsmpeg stream configuration for WebUI
jsmpeg:
# Optional: Set the height of the jsmpeg stream. (default: 720)
# This must be less than or equal to the height of the detect stream. Lower resolutions
# reduce bandwidth required for viewing the jsmpeg stream. Width is computed to match known aspect ratio.
height: 720
# Optional: Set the encode quality of the jsmpeg stream (default: shown below)
# 1 is the highest quality, and 31 is the lowest. Lower quality feeds utilize less CPU resources.
quality: 8
# Optional: in-feed timestamp style configuration # Optional: in-feed timestamp style configuration
# NOTE: Can be overridden at the camera level # NOTE: Can be overridden at the camera level

2
docs/docs/troubleshooting/faqs.md
View File

@ -25,7 +25,7 @@ This almost always means that the width/height defined for your camera are not c
### I can't view events or recordings in the Web UI. ### I can't view events or recordings in the Web UI.
Ensure your cameras send h264 encoded video, or [transcode them](/configuration/restream.md#changing-restream-codec). Ensure your cameras send h264 encoded video, or [transcode them](/configuration/restream.md).
### "[mov,mp4,m4a,3gp,3g2,mj2 @ 0x5639eeb6e140] moov atom not found" ### "[mov,mp4,m4a,3gp,3g2,mj2 @ 0x5639eeb6e140] moov atom not found"