From b309287087e194403c096b345dc91ab6991cf726 Mon Sep 17 00:00:00 2001 From: Nicolas Mowen Date: Mon, 12 Aug 2024 07:21:02 -0600 Subject: [PATCH] Add docs for installing Frigate as PWA (#12995) * Add docs for installing Frigate as PWA * Add to sidebar --- docs/docs/configuration/pwa.md | 24 ++++++++++++++++++++++++ docs/sidebars.js | 1 + 2 files changed, 25 insertions(+) create mode 100644 docs/docs/configuration/pwa.md diff --git a/docs/docs/configuration/pwa.md b/docs/docs/configuration/pwa.md new file mode 100644 index 000000000..abe8d6934 --- /dev/null +++ b/docs/docs/configuration/pwa.md @@ -0,0 +1,24 @@ +--- +id: pwa +title: Installing Frigate App +--- + +Frigate supports being installed as a [Progressive Web App](https://web.dev/explore/progressive-web-apps) on Desktop, Android, and iOS. + +This adds features including the ability to deep link directly into the app. + +## Requirements + +In order to install Frigate as a PWA, the following requirements must be met: + +- Frigate must be accessed via a secure context (localhost, secure https, etc.) +- On Android, Firefox, Chrome, Edge, Opera, and Samsung Internet Browser all support installing PWAs. +- On iOS 16.4 and later, PWAs can be installed from the Share menu in Safari, Chrome, Edge, Firefox, and Orion. + +## Installation + +Installation varies slightly based on the device that is being used: + +- Desktop: Use the install button typically found in right edge of the address bar +- Android: Use the `Install as App` button in the more options menu +- iOS: Use the `Add to Homescreen` button in the share menu \ No newline at end of file diff --git a/docs/sidebars.js b/docs/sidebars.js index da41564ca..cd3306c2d 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -52,6 +52,7 @@ module.exports = { "configuration/authentication", "configuration/hardware_acceleration", "configuration/ffmpeg_presets", + "configuration/pwa", "configuration/tls", "configuration/advanced", ],