Commit Graph

650 Commits

Author SHA1 Message Date
Blake Blackshear
e0078f388e package updates for docs 2022-02-18 21:18:26 -06:00
Blake Blackshear
34fa53afcc make motion the default retain mode 2022-02-18 21:18:26 -06:00
Blake Blackshear
663bf05fd7 update stationary interval docs 2022-02-18 21:18:26 -06:00
Blake Blackshear
f512af2563 make expire interval configurable for users wanting to minimize i/o 2022-02-18 21:18:26 -06:00
Blake Blackshear
985bd6d9bd update docs 2022-02-18 21:18:26 -06:00
Blake Blackshear
b2ce1edd5a fix default motion comment 2022-02-18 21:18:26 -06:00
Blake Blackshear
6218791708 clarify shm in docs 2022-02-18 21:18:26 -06:00
Blake Blackshear
294c79a271 no longer make motion settings dynamic 2022-02-18 21:18:26 -06:00
Blake Blackshear
eb16de7395 config option for stationary detection interval 2022-02-18 21:18:26 -06:00
DataBitz
32878bd016
Another missing slash (#2803)
2nd attempt to fix link to full configuration
2022-02-14 07:33:29 -06:00
DataBitz
12d13988c4
Missing slash in url (#2797)
Missing slash in url to full-configuration-reference
2022-02-13 07:38:24 -06:00
atinsley
9e4d921488
Update advanced.md (#2794)
Add details about how to specify a custom database location in config.yml
2022-02-12 06:28:56 -06:00
Blake Blackshear
edc1884c4e add warning to storage docs 2022-02-11 06:15:15 -06:00
Alex Yao
a2d1bd2c67
Document JPEG streams (#2586)
* Document JPEG streams

* Update camera_specific.md
2022-02-02 07:27:22 -06:00
Felipe Santos
bb68a2405b
Improve audio conversion tip (#2140)
* Improve audio convert guide

* Mention faq in RTMP configuration

* Add example for audio conversion tip

* Change comma to period

* Explain why this is needed
2021-12-29 08:57:32 -06:00
MrNorm
42ac4172ff
Add passthrough information for PCIe Coral TPU (#2200) 2021-12-12 09:31:52 -06:00
hcooper
998921ae63 Update objects.mdx
Mention that `person` is the only tracked object by default. Minor reformat.
2021-12-01 07:33:16 -06:00
Blake Blackshear
5e692acfbb add links in docs to other sites 2021-10-23 09:41:32 -05:00
Blake Blackshear
4cf55ad8e2 Revert switch to mpegts format and audio default 2021-10-23 08:21:15 -05:00
Blake Blackshear
d6104f2eb2 add storage info to docs 2021-10-23 08:21:15 -05:00
Lindsay Ward
0bd3be94ec Clarify environment variables
Based on issue #1976 - specify explicitly that these fields can include environment variables to avoid interpretation that environment variables could be used anywhere.
I am participating in #hacktoberfest, so I would appreciate if you could add the 'hacktoberfest-accepted' label (or add #hacktoberfest topic to your repo). Thanks!
2021-10-23 06:42:53 -05:00
Blake Blackshear
9494bb7f5f frontend dependency updates 2021-10-16 07:57:59 -05:00
Blake Blackshear
e297e02800 store audio by default 2021-10-16 06:06:49 -05:00
Blake Blackshear
05fc35fc3d update hardware docs 2021-10-15 21:29:36 -05:00
Blake Blackshear
d150f01a2c update hassos warning 2021-10-10 07:32:55 -05:00
FM-17
381b00157e
warning for dev board incompatibility post-0.9.x
Hoped to investigate this with my dev board at some point. In the meantime, added a warning for others who may experience it when upgrading to the new stable release.
2021-10-09 11:23:51 -03:00
Blake Blackshear
8e881b60f0 update hardware recommendations 2021-10-05 07:13:13 -05:00
Blake Blackshear
0260d824a6 further doc clarifications 2021-10-05 06:57:17 -05:00
Blake Blackshear
4c7919ad69 updated links 2021-10-04 08:54:35 -05:00
Blake Blackshear
4e997124b3 update latest recommendations for reolink 2021-10-04 07:18:53 -05:00
Blake Blackshear
8b040f5c95 optimize images for web 2021-10-04 07:00:30 -05:00
Blake Blackshear
1daffd92fd docs updates 2021-10-01 07:37:47 -05:00
Blake Blackshear
aa807d25ed add affiliate links 2021-09-26 13:37:42 -05:00
Blake Blackshear
cd28869649 fix path 2021-09-26 12:32:41 -05:00
Blake Blackshear
ae97692883 docs config update for netlify 2021-09-26 12:27:01 -05:00
Blake Blackshear
e6cdb6a7a2 install docs clarification 2021-09-24 06:45:15 -05:00
Blake Blackshear
96319e795c docs clarification for masks 2021-09-17 19:21:03 -05:00
Blake Blackshear
c793500ad2 add udp camera example to docs 2021-09-15 07:33:50 -05:00
Blake Blackshear
1b2134c49e remove clip_ready event type
this doesnt really mean anything more than "end" anymore. new has_clip property added
2021-09-15 07:16:52 -05:00
Blake Blackshear
86a5b46c68 more docs updates 2021-09-14 08:07:36 -05:00
Blake Blackshear
a5f241d5bd cleanup ha notification docs 2021-09-13 22:02:12 -05:00
Blake Blackshear
7b063a19dc remove fps arg for mjpeg 2021-09-12 14:51:59 -05:00
Blake Blackshear
0320d94ea6 docs updates 2021-09-12 14:48:21 -05:00
Blake Blackshear
5a209caed3 Merge remote-tracking branch 'origin/master' into release-0.9.0 2021-09-08 09:03:14 -04:00
Dermot Duffy
d35b09b18f Refresh the HA installation instructions. 2021-09-05 11:14:28 -05:00
Blake Blackshear
f63a7cb6c0 remove font_scale in timestamp_style and calculate dynamically again 2021-09-04 16:34:48 -05:00
Peter Campion-Bye
faf103152a Update optimizing.md
Need note about increasing GPU memory on Pi - otherwise ffmpeg hwaccel won't work
2021-09-03 07:04:21 -05:00
drinfernoo
65855e23d9
Add RTMP and timestamp style to global config (#1674)
* 📝🔧 - Make RTMP config global

Fixes #1671

* 📝🔧 - Make timestamp style config global

Fixes #1656

* fix test function names

* formatter

Co-authored-by: Blake Blackshear <blakeb@blakeshome.com>
2021-09-03 07:03:36 -05:00
Blake Blackshear
fbea51372f sync global snapshot options (fixes #1621) 2021-08-28 09:14:00 -05:00
Blake Blackshear
fa5ec8d019 cleanup global and camera detect config (fixes #1615) 2021-08-28 08:51:51 -05:00
Blake Blackshear
45798d6d14 clean house on clips 2021-08-15 08:30:27 -05:00
Blake Blackshear
f6d5e96dbf update FAQ 2021-08-14 14:23:18 -05:00
Blake Blackshear
e18aa56427 Merge remote-tracking branch 'origin/master' into release-0.9.0 2021-08-14 14:19:10 -05:00
Blake Blackshear
f3a1c1de0a move width/height/fps under detect and make required
also resizes the output from ffmpeg to specified size
2021-08-14 14:18:35 -05:00
Charles Munger
58c0d97b5f Include timestamps for notification examples
In the homeassistant app, the notification timestamp is generated when the push message is received by the app. Delays caused by servers, device load, or network latency/availability will delay those pushes - so in the following case:

1:00 - A dog is detected in the front
1:02 - It stops moving around or leaves view, last notification push sent
1:05 - The phone connects to the network

The user, seeing the alert at 1:05, will see that the notification occurred "a few seconds ago", since the timestamp the app sends to the OS was at 1:05. By adding the `when` parameter, it will instead correctly show that the event was triggered at 1:00.

This is exacerbated by the fact that the default behavior of android pushes won't wake the device from deep sleep - in order to receive it as a high priority notification, the additional parameters

```
data:
  priority: high
  ttl: 0
```
have to be added.
2021-08-14 07:35:52 -05:00
shred86
abef002af8
Add FAQ section (#1459)
* Add FAQ section

Add FAQ section and verbiage about a finding with camera motion sensors in HomeKit.

* Changes made based on inputs

* Fix markdown

Co-authored-by: Blake Blackshear <blakeb@blakeshome.com>
2021-08-14 07:27:43 -05:00
Craig Dennis
adf2bc078c Include details about stream passthrough
Refs #1440

Indicate that width and height are only used for the detect role and so other streams for with other roles are passed through and resolution is not needed.
2021-08-14 07:23:32 -05:00
Jason Hunter
c527b1ca5d change MQTT to toggle recordings instead of clips 2021-08-07 15:51:16 -05:00
Jason Hunter
dcfe26c9c0 update docs 2021-08-07 15:51:16 -05:00
Dermot Duffy
3bc75ae931 Refresh the HA integration documentation. 2021-08-05 06:41:55 -04:00
Blake Blackshear
e51021c573 switch default live resolution to 720 2021-07-21 07:47:11 -05:00
Blake Blackshear
92aa16c556 add labelmap customization to the config (fixes #507) 2021-07-07 22:58:18 -05:00
Blake Blackshear
f26f7b8d3f make default motion a little more sensitive 2021-07-07 07:33:14 -05:00
Blake Blackshear
f4aa02cc19 allow specific objects to be listed for a zone (fixes #1123) 2021-07-07 07:33:14 -05:00
Blake Blackshear
b1dfee2cf5 update docs 2021-07-06 07:36:37 -05:00
Blake Blackshear
98d8118fb2 add options to define jpeg quality 2021-07-02 07:52:02 -05:00
Blake Blackshear
3e1b680e4c update motion docs (fixes #1176) 2021-07-01 07:54:09 -05:00
Blake Blackshear
762afb8f43 add config for camera live stream 2021-06-23 08:15:15 -05:00
Blake Blackshear
515d8c04ad Update cameras.md 2021-06-22 06:33:04 -05:00
Sebastian Englbrecht
49c65cf9c6 Add doc about timestamp styles 2021-06-22 06:33:04 -05:00
Blake Blackshear
8e0c2b256e update docs 2021-06-19 08:49:06 -05:00
Blake Blackshear
fd9c8c1f0d add snapshot time to event data 2021-06-19 08:49:06 -05:00
zacho112
03e756dd27 Update detectors.md 2021-06-17 07:28:00 -05:00
zacho112
5d0984998d Update detectors.md
Include how to use the native Coral on the Coral Dev Board
2021-06-17 07:28:00 -05:00
Blake Blackshear
3b695040d1 send clip_ready mqtt to event topic 2021-06-14 18:20:12 -05:00
Blake Blackshear
89c2ae2208 functioning birdseye view 2021-06-13 12:35:39 -05:00
Blake Blackshear
0df35379ef updating docs 2021-06-12 07:25:13 -05:00
Mingkwan Burckhardt
8dfff83447 Added support for authentication with client certificate with MQTT broker 2021-06-06 07:57:46 -05:00
Blake Blackshear
0bb998c465 Merge branch 'master' into release-0.9.0 2021-06-05 07:59:07 -05:00
highaltidude
8ea75e6748 Documentation Update-CPU Fall back corrected. 2021-06-05 07:27:58 -05:00
Jon Gilmore
09a4d6d030
docs(typo): fix configuration typo (#1148) 2021-05-26 07:39:42 -07:00
Jason Hunter
f4bc68d396 update HTTP API docs 2021-05-22 07:48:44 -05:00
digiblur
e16dbcb671
docs(howto): Combined links, add authors, and cleaned up (#1124) 2021-05-20 07:01:25 -07:00
Jason Hunter
e89697fab0 update Home Assistant brand identity references 2021-05-19 06:48:50 -05:00
Chris Helming
c52782aa3f Add record to configuration docs
Record was missing from the configuration docs. Added it in based on the other options show and the info under 24/7 recordings in the cameras docs.
2021-05-18 20:45:10 -05:00
Chris Helming
7060f22024
docs: Update advanced.md to move type: to its own line (#1101)
Type was stuck on the comment line. Added a line break to move it onto its own line so it's visible.
2021-05-14 09:23:02 -07:00
Blake Blackshear
d1931f249c
Update cameras.md 2021-05-14 07:15:01 -05:00
Blake Blackshear
bf1a542afb
Update howtos.md 2021-05-13 07:41:10 -05:00
Mitch Ross
ebb6d348a3
feat(web): Delete events from Event page and API (#991)
Co-authored-by: Scott Roach <scott@thinkpivot.io>
Co-authored-by: Paul Armstrong <paul@spaceyak.com>
2021-05-12 08:19:02 -07:00
Blake Blackshear
f667bd9066
Update howtos.md 2021-05-12 06:55:33 -05:00
peyanski
ff2eba5b9f Create howtos.md
Community guides and How-To's section. 

Feel free to approve, move, edit or reject the changes. 

Either way keep up the good work,
Kiril
2021-05-12 06:47:12 -05:00
digiblur
3eb0021207 Update detectors.md
Add example for dual PCIe
2021-05-12 06:45:34 -05:00
Colin McCambridge
6379f5cd5e Update nvdec.md
`covid` --> `cuvid` in example arguments.
2021-05-12 06:44:44 -05:00
Blake Blackshear
ad85beea91 Update cameras.md 2021-05-11 06:48:28 -05:00
Blake Blackshear
d7a237677a Update cameras.md 2021-05-11 06:48:28 -05:00
Whytey
16effa3938 Update cameras.md 2021-05-11 06:48:28 -05:00
Whytey
33a04c425b Add MJPEG example 2021-05-11 06:48:28 -05:00
Manuel
20a52bc4e6 Update installation.md
Added missing \ in line 70
2021-05-07 07:22:13 -05:00
Jason Hunter
3a171d19e3 update contributing docs 2021-05-04 17:29:23 -05:00
Ron Schaeffer
42410a260c Update index.md
Corrected
2021-04-07 13:50:07 -05:00
Ron Schaeffer
00c6a8f577 Update index.md
Remove outdated (?) info that Addon users define their configs in the GUI. Corrected outdated (?) config,yml to frigate.yml.
2021-04-07 13:50:07 -05:00
Ron Schaeffer
9d2469549f Update installation.md
It is not possible--unless I'm totally overlooking something--to define the add-on's configuration in the GUI. The user must define the configuration in a frigate.yml file,
2021-04-07 13:27:10 -05:00
John
d2bc2c20c1 Update api.md
Fixed example URL for the viewing higher resolution mjpeg stream.
2021-03-19 09:30:21 -05:00
Paul Armstrong
10c37a3036 docs: include available objects in documentation 2021-03-09 06:23:37 -06:00
Mitch Ross
00d14fa49f Update Unraid Install Instructions 2021-03-02 06:42:42 -06:00
Blake Blackshear
0f1bc40f00 docs for core development 2021-02-25 07:01:59 -06:00
Blake Blackshear
4252857e19 remove tmpfs_cache_size option 2021-02-25 07:01:59 -06:00
Paul Armstrong
2f3339ba85 docs: add contributing docs 2021-02-23 07:37:19 -06:00
Blake Blackshear
1e7b53dc0e clarify h264 in docs 2021-02-22 07:20:32 -06:00
Blake Blackshear
bc94748f2a clips not playable 2021-02-22 07:10:56 -06:00
Blake Blackshear
4a74f295e7 docs updates 2021-02-20 08:20:17 -06:00
Blake Blackshear
20c65b9a31 fix link and clarify audio encoding (fixes #800) 2021-02-20 08:20:17 -06:00
Blake Blackshear
69cab1e6bb update docker commands to avoid privileged mode 2021-02-20 08:20:17 -06:00
Blake Blackshear
ce90ae343c add global object mask 2021-02-20 08:20:17 -06:00
Blake Blackshear
d51e9446ff add camera level ffmpeg params 2021-02-20 08:20:17 -06:00
Blake Blackshear
121ea37825 allow defining required zones for snapshots/clips/mqtt 2021-02-20 08:20:17 -06:00
Blake Blackshear
d6faa18adb increase default max_disappeared to 5x FPS 2021-02-20 08:20:17 -06:00
jaburges
54671fc522 Added the base urls for image and video 2021-02-10 20:59:00 -06:00
jaburges
53e3e6545d Added Unraid and M2 coral edge tpu
Recommended hardware docs
2021-02-10 20:58:11 -06:00
Blake Blackshear
c065cb48f2 fix notification examples 2021-02-03 06:56:14 -06:00
Blake Blackshear
40d5a9f890 change default log level 2021-01-31 06:18:35 -06:00
Blake Blackshear
b55bd1e027 add param to reduce response sizes by excluding thumbnails in api response 2021-01-31 06:18:35 -06:00
Jeff Billimek
9a96df0319 update docs to reflect new chart home
Signed-off-by: Jeff Billimek <jeff@billimek.com>
2021-01-30 22:15:20 -06:00
Blake Blackshear
e9b1618364 add note about protection mode for tmpfs fixes #658 2021-01-29 06:42:55 -06:00
Blake Blackshear
6dc6ed1e94 more detailed reolink args 2021-01-29 06:40:32 -06:00
Blake Blackshear
1943a49274 add audio info to docs 2021-01-29 06:35:54 -06:00
Blake Blackshear
faa8abb2b9 docs updates 2021-01-28 08:21:04 -06:00
Blake Blackshear
f6cd2fc68e clarifying addon docs 2021-01-28 07:45:09 -06:00
Justin Goette
dcf7209706 Fix camera.md links 2021-01-28 06:43:43 -06:00
Blake Blackshear
15b5ffddd4 updating for docusaurus2 docs 2021-01-26 21:40:33 -06:00
Blake Blackshear
2beb44b591 add search to docs 2021-01-26 21:40:33 -06:00
Blake Blackshear
27b659dde1 tweaking the docs 2021-01-26 21:40:33 -06:00
Blake Blackshear
ff99a01423 fix table in docs 2021-01-26 21:40:33 -06:00
Blake Blackshear
ea6e311318 readme update 2021-01-26 21:40:33 -06:00
Paul Armstrong
6790467bbc docs: move docs to docusaurus 2021-01-26 21:40:33 -06:00
Blake Blackshear
8615f14407 update notification example 2021-01-26 21:40:33 -06:00
Blake Blackshear
d84b75168c docs updates for notification changes 2021-01-26 21:40:33 -06:00
Leonardo Merza
ec256f7130 add notes for Blue Iris RTSP support 2021-01-26 21:40:33 -06:00
Blake Blackshear
f20b1d75e6 add telegram example 2021-01-26 21:40:33 -06:00
tubalainen
8b9c8a2e80 Updated file
ref: https://github.com/blakeblackshear/frigate/issues/373
2021-01-26 21:40:33 -06:00
Blake Blackshear
a6aa9bdd59 readme updates 2021-01-26 21:40:33 -06:00
Blake Blackshear
5ea86d636c doc updates 2021-01-26 21:40:33 -06:00
Michael Wei
893e6b40a7 nvidia ffmpeg support 2020-11-08 16:42:17 -06:00
Blake Blackshear
5a081e4f00 docs rewrite 2020-10-24 08:23:16 -05:00
tubalainen
c4cccf44a5 poly example image 2020-10-23 06:38:41 -05:00
Blake Blackshear
3e146de0a2 update docs 2020-10-18 13:47:13 -05:00
Blake Blackshear
f3db69d975 update docs 2020-08-08 07:40:48 -05:00
walthowd
941434b8d8 Added mask overlay example 2020-07-01 07:49:01 -05:00
walthowd
f1afaf641a Mask example images 2020-07-01 07:49:01 -05:00
Blake Blackshear
3a3afe14bf change the ffmpeg config for global defaults and overrides 2019-12-08 16:03:23 -06:00