parra/ntfy
parra/ntfy
1
0
Fork 0
mirror of https://github.com/binwiederhier/ntfy.git synced 2024-12-26 19:52:30 +01:00
Code Releases Activity

Improve web push docs

Browse source
This commit is contained in:
nimbleghost 2023-06-24 20:35:38 +02:00
parent 32a110b601
commit be4c80e201
2 changed files with 24 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
docs/subscribe/desktop.md → docs/subscribe/installed-web-app.md
View file

@ -1,10 +1,24 @@
# Using the web app as an installed web app # Using the web app as an installed web app
While ntfy doesn't have a native desktop app, it is built as a [progressive web app](https://developer.mozilla.org/en-US/docs/Web/Progressive_web_apps) (PWA) While ntfy doesn't have a native desktop app, it is built as a [progressive web app](https://developer.mozilla.org/en-US/docs/Web/Progressive_web_apps) (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 and thus can be installed on both desktop and mobile devices.
macOS, launcher shortcut on Linux), own window, push notifications, and an app badge with the unread notification count.
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.
To install and register the web app in your operating system, click the "install app" icon in your browser (usually next to the To install and register the web app in your operating system, click the "install app" icon in your browser (usually next to the
address bar). To receive background notifications, **either the browser or the installed web app must be open**. address bar). On iOS Safari, tap on the Share menu > "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](./web.md#background-notifications)
for a detailed breakdown.
## Compatibility
<!-- TODO: (Q4 2023) Safari 17 / macOS 14 Sonoma supports installable PWAs too --> <!-- TODO: (Q4 2023) Safari 17 / macOS 14 Sonoma supports installable PWAs too -->

9
docs/subscribe/web.md
View file

@ -23,10 +23,15 @@ If topic reservations are enabled, you can claim ownership over topics and defin
<a href="../../static/img/web-reserve-topic-dialog.png"><img src="../../static/img/web-reserve-topic-dialog.png"/></a> <a href="../../static/img/web-reserve-topic-dialog.png"><img src="../../static/img/web-reserve-topic-dialog.png"/></a>
</div> </div>
## Background notifications ## Background Notifications
While subscribing, you have the option to enable background notifications on supported browsers (see "Settings" tab). While subscribing, you have the option to enable background notifications on supported browsers (see "Settings" tab).
**If background notifications are off (default):** This requires an active ntfy tab to be open to receive notifications. Note: If you add the web app to your homescreen (as a progressive web app, more info in the [installed web app](./installed-web-app.md)
docs), you cannot turn these off, as notifications would not be delivered reliably otherwise. You can mute topics you don't want to receive
notifications for.
**If background notifications are off:** This requires an active ntfy tab to be open to receive notifications.
These are typically instantaneous, and will appear as a system notification. If you don't see these, check that your browser These are typically instantaneous, and will appear as a system notification. If you don't see these, check that your browser
is allowed to show notifications (for example in System Settings on macOS). If you don't want to enable background notifications, is allowed to show notifications (for example in System Settings on macOS). If you don't want to enable background notifications,
**pinning the ntfy tab on your browser** is a good solution to leave it running. **pinning the ntfy tab on your browser** is a good solution to leave it running.