= Growl notification dispatcher for Trac events = [[PageOutline]] == Description == This plugin dispatches change events that occur in a Trac project to Growl-enabled clients. [http://growl.info/about.php 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.[[br]] 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 3^rd^ 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 * [http://bitten.edgewall.org Bitten] build startup, abortion and completion === Examples === [[Image(growl-ticket.png)]] == Installation == Trac requirement: * Please read the version requirement defined in [browser:growlplugin/0.11/setup.py setup.py] file, search for ''install_requires'' === Get the plugin source code === ==== Download ==== Download the zipped source from [download:growlplugin here]. ==== Source ==== You can check out GrowlPlugin from [http://trac-hacks.org/svn/growlplugin here] using Subversion, or [source:growlplugin 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, bitten hosts = }}} * `sources` is a comma-separated list of source events. * `wiki` for wiki events, * `ticket` for ticket events, * `attachment` for attachment events * `bitten` for [http://bitten.edgewall.org bitten] build 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 [report:9?COMPONENT=GrowlPlugin here]. If you have any issues, create a [http://trac-hacks.org/newticket?component=GrowlPlugin&owner=eblot new ticket]. == Recent Changes == [[ChangeLog(growlplugin, 3)]] == Author/Contributors == '''Author:''' [wiki:eblot] [[BR]] '''Contributors:'''