From fd0a9b3e5dbc5ac084a712757c9a8927bf1cfc5c Mon Sep 17 00:00:00 2001 From: Nicolas Mowen Date: Mon, 22 Jul 2024 07:42:41 -0600 Subject: [PATCH] Cleanup docs --- docs/docs/configuration/notifications.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/docs/docs/configuration/notifications.md b/docs/docs/configuration/notifications.md index 265e2b0a3..9225ea6e8 100644 --- a/docs/docs/configuration/notifications.md +++ b/docs/docs/configuration/notifications.md @@ -7,17 +7,19 @@ title: Notifications Frigate offers native notifications using the [WebPush Protocol](https://web.dev/articles/push-notifications-web-push-protocol) which uses the [VAPID spec](https://tools.ietf.org/html/draft-thomson-webpush-vapid) to deliver notifications to web apps using encryption. +## Setting up Notifications + In order to use notifications the following requirements must be met: - Frigate must be accessed via a secure https connection - A supported browser must be used. Currently Chrome, Firefox, and Safari are known to be supported. - In order for notifications to be usable externally, Frigate must be accessible externally -## Configuration +### Configuration To configure notifications, go to the Frigate WebUI -> Settings -> Notifications and enable, then fill out the fields and save. -## Registration +### Registration Once notifications are enabled, press the `Register for Notifications` button on all devices that you would like to receive notifications on. This will register the background worker. After this Frigate must be restarted and then notifications will begin to be sent. @@ -27,7 +29,7 @@ Currently notifications are only supported for review alerts. More notifications :::note -Currently, only Chrome supports images in notifications. Safari and FireFox will only show a title and message in the notification. +Currently, only Chrome supports images in notifications. Safari and Firefox will only show a title and message in the notification. ::: @@ -37,4 +39,4 @@ Different platforms handle notifications differently, some settings changes may ### Android -Most Android phones have battery optimization settings. To get reliable Notification delivery the browser (Chrome, FireFox) should have battery optimizations disabled. If Frigate is running as a PWA then the Frigate app should have battery optimizations disabled as well. \ No newline at end of file +Most Android phones have battery optimization settings. To get reliable Notification delivery the browser (Chrome, Firefox) should have battery optimizations disabled. If Frigate is running as a PWA then the Frigate app should have battery optimizations disabled as well. \ No newline at end of file