Changes between Version 1 and Version 2 of GrowlPlugin


Ignore:
Timestamp:
Jun 1, 2008, 11:44:55 PM (7 years ago)
Author:
eblot
Comment:

Initial documentation

Legend:

Unmodified
Added
Removed
Modified
  • GrowlPlugin

    v1 v2  
    1 = Growl notification dispatcher on Trac events =
     1= Growl notification dispatcher for Trac events =
     2
     3[[PageOutline]]
    24
    35== Description ==
    46
    5 This plugin is highly experimental (in early development stage)
     7This 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
     11This plugin uses remote notifications, using the local network.[[br]]
     12The server may run on any OS, such as Linux, OS X, Windows or virtually any other OS that supports Trac.
     13
     14The plugin does not rely on any 3^rd^ party libraries: no Growl SDK or library is required on the Trac server.
     15
     16Currently 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
     25Trac 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 ====
     32Download the zipped source from [download:growlplugin here].
     33==== Source ====
     34You can check out GrowlPlugin from [http://trac-hacks.org/svn/growlplugin here]
     35using Subversion, or [source:growlplugin browse the source] with Trac.
     36
     37=== Build the plugin ===
     38
     39As with any other plugin:
     40{{{
     41python setup.py bdist_egg
     42}}}
     43
     44=== Installation of the plugin ===
     45
     46Copy the generated egg file (from the `dist/` directory) to your project
     47plugin directory, or in the global plugin directory if you want to use it for
     48several Trac projects
     49
     50=== Enabling the plugin ===
     51
     52From the WebAdmin plugin interface or from your `trac.ini` file, enable the
     53GrowlPlugin.
     54
     55In `trac.ini`, edit the ''components'' section to add the revtree entry as
     56follows:
     57{{{
     58[components]
     59growl.notifier = enabled
     60}}}
     61
     62=== Configuration ===
     63
     64The growl plugin can be configured with the help of the following settings:
     65{{{
     66[growl]
     67sources = wiki, ticket, attachment
     68hosts =
     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
    677
    778== Bugs/Feature Requests ==
     79
     80This plugin is highly experimental (in early development stage)
    881
    982Existing bugs and feature requests for GrowlPlugin are
     
    1386[http://trac-hacks.org/newticket?component=GrowlPlugin&owner=eblot new ticket].
    1487
    15 == Download ==
    16 
    17 Download the zipped source from [download:growlplugin here].
    18 
    19 == Source ==
    20 
    21 You can check out GrowlPlugin from [http://trac-hacks.org/svn/growlplugin here] using Subversion, or [source:growlplugin browse the source] with Trac.
    22 
    23 == Example ==
    24 
    25 See attached snapshot
    2688
    2789== Recent Changes ==
     
    3395'''Author:''' [wiki:eblot] [[BR]]
    3496'''Contributors:'''
     97