Pushover notification plugin for Rundeck
Java Makefile
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
src/main/java/org/rundeck/plugins/notification
.gitignore
LICENSE
Makefile
README.md
build.gradle

README.md

Pushover Notification Plugin for Rundeck

This plugin provides the ability to send Rundeck start/stop/failure notifications to mobile devices using the Pushover app.

Installation

Copy the pushover-notification-plugin.jar to the libext/ directory for Rundeck.

Configuration

Configuration for this plugin is relatively straightforward.

  1. First, login to pushover and copy your user token.
  2. From the pushover application builder, create a new application for the plugin and copy the application API key once complete.
  3. Update the project.properties file for each project you wish to allow Pushover notifications from. To configure notifications for all projects, update framework.properties file.

TIP: The new rundeck logo works well as the icon when creating the app in Pushover.

project.properties

project.plugin.Notification.Pushover.appApiToken=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
project.plugin.Notification.Pushover.userIdToken=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

framework.properties

framework.plugin.Notification.Pushover.appApiToken=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
framework.plugin.Notification.Pushover.userIdToken=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Notification Groups

If you wish to send job notifications to more than one user at a time, Pushover allows you to create notification groups. To use, simply specify the group token in the *.properties file for userIdToken.

Usage

Check the Pushover box when specifying notifications for a job.

Limitations

Currently, Pushover user ID tokens can only be set at the project or framework level. I may end up modifying the plugin to allow it to be defined at the instance (job) as well, but don't currently have a need for it.

Credits

The pushover4j library was used to interact with the Pushover API.