ntfy/docs/subscribe/web.md

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

60 lines
3.6 KiB
Markdown
Raw Normal View History

2021-12-04 14:38:21 +13:00
# Subscribe from the Web UI
2023-05-30 03:57:21 +12:00
You can use the Web UI to subscribe to topics as well. Simply type in the topic name and click the *Subscribe* button.
2023-06-03 00:45:05 +12:00
While subscribing, you have the option to enable background notifications on supported browsers.
2023-05-30 03:57:21 +12:00
2023-06-03 00:45:05 +12:00
- If background notifications are off:
2023-05-30 03:57:21 +12:00
2023-05-30 08:09:40 +12:00
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 is allowed to show notifications
(for example in System Settings on macOS).
2023-05-30 03:57:21 +12:00
2023-05-30 08:09:40 +12:00
If you don't want to enable background notifications, pinning the ntfy tab on your browser is a good solution to leave
it running.
2023-05-30 03:57:21 +12:00
2023-06-03 00:45:05 +12:00
- If background notifications are on:
2023-05-30 03:57:21 +12:00
2023-05-30 08:09:40 +12:00
This uses the [Web Push API](https://caniuse.com/push-api). You don't need an active ntfy tab open, but in some
cases you may need to keep your browser open.
Background notifications are only supported on the same server hosting the web app. You cannot use another server,
but can instead subscribe on the other server itself.
2023-06-03 00:45:05 +12:00
If the ntfy app is not opened for more than a week, background notifications will be paused. You can resume them
by opening the app again, and will get a warning notification before they are paused.
2023-05-30 08:09:40 +12:00
| Browser | Platform | Browser Running | Browser Not Running | Restrictions |
| ------- | -------- | --------------- | ------------------- | ------------------------------------------------------- |
| Chrome | Desktop | ✅ | ❌ | |
| Firefox | Desktop | ✅ | ❌ | |
| Edge | Desktop | ✅ | ❌ | |
| Opera | Desktop | ✅ | ❌ | |
| Safari | Desktop | ✅ | ✅ | requires Safari 16.1, macOS 13 Ventura |
| Chrome | Android | ✅ | ✅ | |
| Safari | iOS | ⚠️ | ⚠️ | requires iOS 16.4, only when app is added to homescreen |
(Browsers below 1% usage not shown, look at the [Push API](https://caniuse.com/push-api) for more info)
2021-12-04 14:38:21 +13:00
2021-12-05 17:37:50 +13:00
To learn how to send messages, check out the [publishing page](../publish.md).
<div id="web-screenshots" class="screenshots">
<a href="../../static/img/web-detail.png"><img src="../../static/img/web-detail.png"/></a>
2022-03-12 04:43:18 +13:00
<a href="../../static/img/web-notification.png"><img src="../../static/img/web-notification.png"/></a>
<a href="../../static/img/web-subscribe.png"><img src="../../static/img/web-subscribe.png"/></a>
2021-12-05 17:37:50 +13:00
</div>
2023-02-16 09:39:01 +13:00
If topic reservations are enabled, you can claim ownership over topics and define access to it:
<div id="reserve-screenshots" class="screenshots">
<a href="../../static/img/web-reserve-topic.png"><img src="../../static/img/web-reserve-topic.png"/></a>
<a href="../../static/img/web-reserve-topic-dialog.png"><img src="../../static/img/web-reserve-topic-dialog.png"/></a>
</div>
2023-05-30 03:57:21 +12:00
You can set your default choice for new subscriptions (for example synced account subscriptions and the default toggle state)
in the settings page:
<div id="push-settings-screenshots" class="screenshots">
<a href="../../static/img/web-push-settings.png"><img src="../../static/img/web-push-settings.png"/></a>
</div>