1
0
Fork 0
mirror of https://github.com/binwiederhier/ntfy.git synced 2024-12-14 11:47:33 +00:00
binwiederhier-ntfy/docs/subscribe/pwa.md
binwiederhier 88eb728fe3 Changelog
2023-06-30 21:51:03 -04:00

3.8 KiB

Using the progressive web app (PWA)

While ntfy doesn't have a native desktop app, it is built as a progressive web app (PWA) and thus can be installed on both desktop and mobile devices.

This gives it its own launcher (e.g. shortcut on Windows, app on macOS, launcher shortcut on Linux, home screen icon on iOS, and launcher icon on Android), a standalone window, push notifications, and an app badge with the unread notification count.

Web app installation is supported on (see compatibility table for details):

  • Chrome: Android, Windows, Linux, macOS
  • Safari: iOS 16.4+, macOS 14+
  • Firefox: Android, as well as on Windows/Linux via an extension
  • Edge: Windows

Note that for self-hosted servers, Web Push must be configured for the PWA to work.

Installation

Chrome on Desktop

To install and register the web app via Chrome, click the "install app" icon. After installation, you can find the app in your app drawer:

Chrome/Firefox on Android

For Chrome on Android, either click the "Add to Home Screen" banner at the bottom of the screen, or select "Install app" in the menu, and then click "Install" in the popup menu. After installation, you can find the app in your app drawer, and on your home screen.

For Firefox, select "Install" in the menu, and then click "Add" to add an icon to your home screen:

Safari on iOS

On iOS Safari, tap on the Share menu, then tap "Add to Home Screen":

Background notifications

Background notifications via web push are enabled by default and cannot be turned off when the app is installed, as notifications would not be delivered reliably otherwise. You can mute topics you don't want to receive notifications for.

On desktop, you generally need either your browser or the web app open to receive notifications, though the ntfy tab doesn't need to be open. On mobile, you don't need to have the web app open to receive notifications. Look at the web docs for a detailed breakdown.