Documents what administrators and agents need to know about web push notifications in the mobile web app. The feature itself is built in zammad/coordination-scrum#1844 and finished in zammad/coordination-scrum#1846; the documentation follows their final behaviour.
Plan
- Admin documentation, system requirements and network: the Zammad server, more precisely its background worker, needs outbound HTTPS on port 443 to the push services of the browsers, Apple (
web.push.apple.com, Safari on iPhone, iPad and Mac), Google (fcm.googleapis.com, Chrome and most Android browsers), Mozilla (*.push.services.mozilla.com, Firefox) and Microsoft (*.notify.windows.com, Edge). Firewalls that restrict outgoing traffic have to allow these hosts. Zammad only accepts device subscriptions of these push services, so a browser that uses another push service cannot enable push; take the final list from the code at merge time. The configured proxy and no-proxy list of the instance apply. There is nothing to configure: the VAPID key pair is generated once per installation and is not meant to be changed, a changed key invalidates every device subscription.
- Admin documentation, notifications: push mirrors the "online" channel of the agent notification matrix and has no channel of its own; who can enable it (agents with the notifications permission); what is shown on the lock screen (the same text as the online notification, nothing more).
- User documentation, mobile web app: enabling push per device in the account settings; on iOS and iPadOS 16.4 or later the app has to be added to the home screen first; on Android the installed app or the browser; how to turn it off, and that the browser's notification permission controls it when it was denied.
- Trap: document the limitation that notifications are delivered by the platform's push service and can be delayed by battery optimisation on some Android devices, so administrators do not report that as a Zammad bug.
Done means the admin and user documentation describe requirements, scope and the per-device setup of push notifications, reviewed against the merged behaviour.
Tests none, documentation build only.
Dependencies zammad/coordination-scrum#1844 (feature) and zammad/coordination-scrum#1846 (final placement and states of the toggle, which the user documentation describes).
Parent: zammad/coordination-private-features#204
Documents what administrators and agents need to know about web push notifications in the mobile web app. The feature itself is built in zammad/coordination-scrum#1844 and finished in zammad/coordination-scrum#1846; the documentation follows their final behaviour.
Plan
web.push.apple.com, Safari on iPhone, iPad and Mac), Google (fcm.googleapis.com, Chrome and most Android browsers), Mozilla (*.push.services.mozilla.com, Firefox) and Microsoft (*.notify.windows.com, Edge). Firewalls that restrict outgoing traffic have to allow these hosts. Zammad only accepts device subscriptions of these push services, so a browser that uses another push service cannot enable push; take the final list from the code at merge time. The configured proxy and no-proxy list of the instance apply. There is nothing to configure: the VAPID key pair is generated once per installation and is not meant to be changed, a changed key invalidates every device subscription.Done means the admin and user documentation describe requirements, scope and the per-device setup of push notifications, reviewed against the merged behaviour.
Tests none, documentation build only.
Dependencies zammad/coordination-scrum#1844 (feature) and zammad/coordination-scrum#1846 (final placement and states of the toggle, which the user documentation describes).
Parent: zammad/coordination-private-features#204