Growl notification dispatcher for Trac events
- Growl notification dispatcher for Trac events
- Client configuration
- Bugs/Feature Requests
- Recent Changes
This plugin dispatches change events that occur in a Trac project to Growl-enabled clients.
Growl is a notification system for Mac OS X: it allows applications that support Growl to send you notifications.
This plugin uses remote notifications, using the local network.
The server may run on any OS, such as Linux, OS X, Windows or virtually any other OS that supports Trac.
The plugin does not rely on any 3rd party libraries: no Growl SDK or library is required on the Trac server.
Currently supported event sources:
- Ticket creation, deletion, and update
- Wiki page creation, deletion, and edition
- Attachment creation and deletion
- Bitten build startup, abortion and completion
- Please read the version requirement defined in setup.py file, search for install_requires
Get the plugin source code
Download the zipped source from here.
Build the plugin
As with any other plugin:
python setup.py bdist_egg
Installation of the plugin
Copy the generated egg file (from the dist/ directory) to your project plugin directory, or in the global plugin directory if you want to use it for several Trac projects
Enabling the plugin
In trac.ini, edit the components section to add the revtree entry as follows:
[components] growl.notifier.* = enabled
The growl plugin can be configured with the help of the following settings. The values defined in the following example represent the default values.
[growl] sources = wiki, ticket, attachment, bitten hosts = userprefs = false
- sources is a comma-separated list of source events.
- wiki for wiki events,
- ticket for ticket events,
- attachment for attachment events
- bitten for bitten build events, only
available if bitten plugin is installed and enabled
- hosts is a comma-separated list of network hosts to send notification to
- if hosts is not defined, the notifications are broadcasted onto the LAN, which could be a security risks in some environments. You'll be warned
- userprefs is a boolean option to allow per-user notification settings.
When enabled, any user who's been granted the GROWL_MODIFY permission may select which notifications he wishes to receive, and the destination host which the notifications should be sent to.
The plugin defines two new permissions:
- GROWL_MODIFY permission allows a user to change the notification settings through the Growl plugin perference panel, and choose the destination host for the notifications
- GROWL_ADMIN gives the same priviledges as GROWL_MODIFY, and allows the administrator to broadcast notfications to a sub network. To broadcast notifications, the administrator should use the special '<broadcast>` host.
Be warned that there is no restriction on the number of plugin users, which might end up overloading a Trac installation if too many hosts are set to receive various Growl notifications. This plugin is mainly dedicated to small team of users. Please also consider the use of the broadcast feature to reduce the number of notifications sent on every Trac event.
Your Trac-managed information may be at risk if you enable user preferences (see userprefs setting) and some random user chooses a host that is located outside your LAN. Only give GROWL_MODIFY permission to trusted user.
Moreover, an untrusted user might set up his preferences to notify a foreign, remote host. Please ensure that Growl notifications are not routed outside your own network (UDP:9887) .
You've been warned.
When a user is granted the GROWL_MODIFY permission, the Growl plugin preference panel appears under the user preferences view:
A user which is granted the GROWL_ADMIN permission may select the <broadcast> special host address to broadcast notifications to all the hosts on the subnet.
Follow growl installation instructions
Growl should be configured to accept incoming notifications and remote application registration.
- Open Mac OS X system preferences
- Select the Growl icon in the "Other" section
- Select the "Network" pane
- Enable the following check boxes
- Listen for incoming notifications
- Allow remote application registration
- Leave the "Server password" field empty
Growl server passwords are not currently supported.
This plugin is highly experimental (in early development stage)
If you have any issues, create a new ticket.
Fixes #3325 setup file was invalid, and enable growl image background
Closes #3122. Implements user settings and user preference panel.
Refs #3122. User-configurable Growl settings: work in progress...
Add user preference panel for Growl notification
The user preference panel does nothing for now: the UI management implementation is not complete, and user settings are safely ignored ;-)
Pref. panel should be explicitly enabled:
[growl] userprefs = enabled
- growl-ticket.png (24.7 kB) -
Growl notification sample on ticket creation, added by eblot on 06/02/08 01:44:34.
- growl-configuration.png (62.4 kB) -
Grown configuration pane (Mac OS X system preferences), added by eblot on 06/02/08 01:48:40.
- growl-userpref-panel.png (53.5 kB) -
Growl plugin user preference panel, added by eblot on 06/08/08 00:58:06.