| 5 | | This plugin is highly experimental (in early development stage) |
| | 7 | This plugin dispatches change events that occur in a Trac project to Growl-enabled clients. |
| | 8 | |
| | 9 | [http://growl.info/about.php Growl] is a notification system for Mac OS X: it allows applications that support Growl to send you notifications. |
| | 10 | |
| | 11 | This plugin uses remote notifications, using the local network.[[br]] |
| | 12 | The server may run on any OS, such as Linux, OS X, Windows or virtually any other OS that supports Trac. |
| | 13 | |
| | 14 | The plugin does not rely on any 3^rd^ party libraries: no Growl SDK or library is required on the Trac server. |
| | 15 | |
| | 16 | Currently supported event sources: |
| | 17 | * Ticket creation, deletion, and update |
| | 18 | * Wiki page creation, deletion, and edition |
| | 19 | * Attachment creation and deletion |
| | 20 | |
| | 21 | === Examples === |
| | 22 | |
| | 23 | == Installation == |
| | 24 | |
| | 25 | Trac requirement: |
| | 26 | * Please read the version requirement defined in |
| | 27 | [browser:growlplugin/0.11/setup.py setup.py] file, search for ''install_requires'' |
| | 28 | |
| | 29 | === Get the plugin source code === |
| | 30 | |
| | 31 | ==== Download ==== |
| | 32 | Download the zipped source from [download:growlplugin here]. |
| | 33 | ==== Source ==== |
| | 34 | You can check out GrowlPlugin from [http://trac-hacks.org/svn/growlplugin here] |
| | 35 | using Subversion, or [source:growlplugin browse the source] with Trac. |
| | 36 | |
| | 37 | === Build the plugin === |
| | 38 | |
| | 39 | As with any other plugin: |
| | 40 | {{{ |
| | 41 | python setup.py bdist_egg |
| | 42 | }}} |
| | 43 | |
| | 44 | === Installation of the plugin === |
| | 45 | |
| | 46 | Copy the generated egg file (from the `dist/` directory) to your project |
| | 47 | plugin directory, or in the global plugin directory if you want to use it for |
| | 48 | several Trac projects |
| | 49 | |
| | 50 | === Enabling the plugin === |
| | 51 | |
| | 52 | From the WebAdmin plugin interface or from your `trac.ini` file, enable the |
| | 53 | GrowlPlugin. |
| | 54 | |
| | 55 | In `trac.ini`, edit the ''components'' section to add the revtree entry as |
| | 56 | follows: |
| | 57 | {{{ |
| | 58 | [components] |
| | 59 | growl.notifier = enabled |
| | 60 | }}} |
| | 61 | |
| | 62 | === Configuration === |
| | 63 | |
| | 64 | The growl plugin can be configured with the help of the following settings: |
| | 65 | {{{ |
| | 66 | [growl] |
| | 67 | sources = wiki, ticket, attachment |
| | 68 | hosts = |
| | 69 | }}} |
| | 70 | * `sources` is a comma-separated list of source events. |
| | 71 | * `wiki` for wiki events, |
| | 72 | * `ticket` for ticket events, |
| | 73 | * `attachment` for attachment events |
| | 74 | * `hosts` is a comma-separated list of network hosts to send notification to |
| | 75 | * if `hosts` is not defined, the notifications are broadcasted onto the LAN, |
| | 76 | which could be a security risks in some environments. You'll be warned |
