readme update

docs/docs/configuration/cameras.md

@@ -40,10 +40,13 @@ cameras:
 
 ## Masks & Zones
 
-### Motion masks
+### Masks
-
 Masks are used to ignore initial detection in areas of your camera's field of view.
 
+There are two types of masks available:
+- **Motion masks**: Motion masks are used to prevent unwanted types of motion from triggering detection. Try watching the video feed with `Motion Boxes` enabled to see what may be regularly detected as motion. For example, you want to mask out your timestamp, the sky, rooftops, etc. Keep in mind that this mask only prevents motion from being detected and does not prevent objects from being detected if object detection was started due to motion in unmasked areas. Motion is also used during object tracking to refine the object detection area in the next frame. Over masking will make it more difficult for objects to be tracked. To see this effect, create a mask, and then watch the video feed with `Motion Boxes` enabled again.
+- **Object filter masks**: Object filter masks are used to filter out false positives for a given object type. These should be used to filter any areas where it is not possible for an object of that type to be. The bottom center of the detected object's bounding box is evaluated against the mask. If it is in a masked area, it is assumed to be a false positive. For example, you may want to mask out rooftops, walls, the sky, treetops for people. For cars, masking locations other than the street or your driveway will tell frigate that anything in your yard is a false positive.
+
 To create a poly mask:
 
 1. Visit the [web UI](/usage/web)

docs/docs/troubleshooting.md

@@ -3,6 +3,12 @@ id: troubleshooting
 title: Troubleshooting
 ---
 
+### My mjpeg stream or snapshots look green and crazy
+This almost always means that the width/height defined for your camera are not correct. Double check the resolution with vlc or another player. Also make sure you don't have the width and height values backwards.
+
+Example:
+![mismatched-resolution](/img/mismatched-resolution.jpg)
+
 ## "[mov,mp4,m4a,3gp,3g2,mj2 @ 0x5639eeb6e140] moov atom not found"
 
 These messages in the logs are expected in certain situations. Frigate checks the integrity of the video cache before assembling clips. Occasionally these cached files will be invalid and cleaned up automatically.

docs/docs/usage/api.md

@@ -158,6 +158,17 @@ Returns data for a single event.
 
 Returns a thumbnail for the event id optimized for notifications. Works while the event is in progress and after completion. Passing `?format=android` will convert the thumbnail to 2:1 aspect ratio.
 
+### `/api/events/<id>/snapshot.jpg`
+Returns the snapshot image for the event id. Works while the event is in progress and after completion.
+
+Accepts the following query string parameters, but they are only applied when an event is in progress. After the event is completed, the saved snapshot is returned from disk without modification:
+|param|Type|Description|
+|----|-----|--|
+|`h`|int|Height in pixels|
+|`bbox`|int|Show bounding boxes for detected objects (0 or 1)|
+|`timestamp`|int|Print the timestamp in the upper left (0 or 1)|
+|`crop`|int|Crop the snapshot to the  (0 or 1)|
+
 ### `/clips/<camera>-<id>.mp4`
 
 Video clip for the given camera and event id.

docs/docusaurus.config.js

@@ -1,8 +1,8 @@
 module.exports = {
   title: 'Frigate',
   tagline: 'NVR With Realtime Object Detection for IP Cameras',
-  url: 'https://blakeblackshear.github.io/frigate',
+  url: 'https://blakeblackshear.github.io',
-  baseUrl: '/',
+  baseUrl: '/frigate/',
   onBrokenLinks: 'throw',
   onBrokenMarkdownLinks: 'warn',
   favicon: 'img/favicon.ico',