wiki:GrowlPlugin

Version 3 (modified by eblot, 6 years ago) (diff)

Fix up "enabling the plugin" section

Growl notification dispatcher for Trac events

Description

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

Examples

Installation

Trac requirement:

  • Please read the version requirement defined in setup.py file, search for install_requires

Get the plugin source code

Download

Download the zipped source from here.

Source

You can check out GrowlPlugin from here using Subversion, or browse the source with Trac.

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

From the WebAdmin plugin interface or from your trac.ini file, enable the GrowlPlugin.

In trac.ini, edit the components section to add the revtree entry as follows:

[components]
growl.notifier.* = enabled

Configuration

The growl plugin can be configured with the help of the following settings:

[growl]
sources = wiki, ticket, attachment
hosts = 
  • sources is a comma-separated list of source events.
    • wiki for wiki events,
    • ticket for ticket events,
    • attachment for attachment events
  • 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

Bugs/Feature Requests

This plugin is highly experimental (in early development stage)

Existing bugs and feature requests for GrowlPlugin are here.

If you have any issues, create a new ticket.

Recent Changes

[3950] by eblot on 2008-07-04 00:48:45
Fixes #3325 setup file was invalid, and enable growl image background
[3798] by eblot on 2008-06-08 00:22:33
Closes #3122. Implements user settings and user preference panel.
[3794] by eblot on 2008-06-05 02:10:02
Refs #3122. User-configurable Growl settings: work in progress...

Author/Contributors

Author: eblot
Contributors:

Attachments (3)

Download all attachments as: .zip