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

Update docs to reflect webRTC configuration.

Browse Source
This commit is contained in:
Nick Mowen 2022-10-26 10:51:12 -06:00
parent 75b6efef21
commit 0debe485e3
1 changed files with 26 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
docs/docs/configuration/live.md
View File

@ -9,12 +9,31 @@ Frigate has different live view options, some of which require [restream](restre
Live view options can be selected while viewing the live stream. The options are:
| Source | Latency | Frame Rate | Resolution | Audio | Requires Restream | Other Limitations |
| ------ | ------- | -------------------------------------- | -------------- | --------------------------- | ----------------- | ------------------ |
| jsmpeg | low | same as `detect -> fps`, capped at 10 | same as detect | no | no | none |
| mp4 | high | native | native | not yet | yes | none |
| webrtc | low | native | native | yes (depends on browser) | yes | requires host mode |
| Source | Latency | Frame Rate | Resolution | Audio | Requires Restream | Other Limitations |
| ------ | ------- | -------------------------------------- | -------------- | --------------------------- | ----------------- | --------------------- |
| jsmpeg | low | same as `detect -> fps`, capped at 10 | same as detect | no | no | none |
| mp4 | high | native | native | not yet | yes | none |
| webrtc | low | native | native | yes (depends on browser) | yes | requires extra config |
### webRTC host mode
### webRTC extra configuration
webRTC works by creating a websocket connection on 2 random UDP ports (1 for video, 1 for audio). This means that frigate must be run with `network_mode: host` to support the webRTC live view mode.
webRTC works by creating a websocket connection on extra ports. Requirements for webRTC to work:
* A viable port must be accessible, so one of the following must be true:
* Frigate is run with `network_mode: host` to support automatic UDP port pass through.
* Port `8555` is port forwarded to port `8555` on the frigate device.
* For local webRTC, you will need to create your own go2rtc config:
```yaml
webrtc:
listen: ":8555"
candidates:
- ip.ad.dr.ess:8555
- stun:8555
```
and pass that config to frigate via docker or `frigate-go2rtc.yaml` for addon users:
```yaml
volumes:
- /path/to/your/go2rtc.yml:/config/frigate-go2rtc.yml:ro
```