Push Notification Plugin Readme

Overview

The Push Notification plugin adds support for sending push notifications to client software, as described in XEP-0357: "Push Notifications".

Installation

Copy pushnotification.jar into the plugins directory of your Openfire installation. The plugin will then be automatically deployed. To upgrade to a new version, copy the new pushnotification.jar file over the existing file.

Configuration

The plugin can be configured through the admin console, using the "Push Notification Settings" page, and by using these Openfire system properties:

• pushnotifications.max-per-second (default 5) - The maximum amount of messages per second that can generate push notifications (note that each message can generate a push notification through more than one registered service).
• pushnotifications.summary.enable (default true) - Add a summary of the message for which the push notification is triggered. This helps some devices to wake up the XMPP client.
• pushnotifications.summary.include-last-sender (default false) - Adds the sender of the message for which the push notification is sent to the summary (if enabled).
• pushnotifications.summary.include-last-message-body (default false) - Adds the body of the message for which the push notification is sent to the summary (if enabled).

Note that push notifications are processed by remote servers that are not part of Openfire. Out of privacy concerns, the inclusion of the author and body of the message for which the push notification is sent is switched off by default.

Attribution