Changes between Version 7 and Version 8 of GrowlPlugin


Ignore:
Timestamp:
Jun 8, 2008 12:56:31 AM (6 years ago)
Author:
eblot
Comment:

Update documentation for plugin v0.2.0 (user preferences)

Legend:

Unmodified
Added
Removed
Modified
  • GrowlPlugin

    v7 v8  
    55== Description == 
    66 
    7 This plugin dispatches change events that occur in a Trac project to Growl-enabled clients. 
     7This plugin dispatches change events that occur in a Trac project to  
     8Growl-enabled clients. 
    89 
    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[http://growl.info/about.php Growl] is a notification system for Mac OS X:  
     11it allows applications that support Growl to send you notifications. 
    1012 
    1113This 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. 
     14The server may run on any OS, such as Linux, OS X, Windows or virtually any  
     15other OS that supports Trac. 
    1316 
    14 The plugin does not rely on any 3^rd^ party libraries: no Growl SDK or library is required on the Trac server. 
     17The plugin does not rely on any 3^rd^ party libraries: no Growl SDK or library 
     18is required on the Trac server. 
    1519 
    1620Currently supported event sources: 
     
    6569=== Configuration === 
    6670 
    67 The growl plugin can be configured with the help of the following settings: 
     71The growl plugin can be configured with the help of the following settings. 
     72The values defined in the following example represent the default values. 
    6873{{{ 
    6974[growl] 
    7075sources = wiki, ticket, attachment, bitten 
    71 hosts =  
     76hosts = 
     77userprefs = false 
    7278}}} 
    7379 * `sources` is a comma-separated list of source events. 
     
    7581   * `ticket` for ticket events, 
    7682   * `attachment` for attachment events 
    77    * `bitten` for [http://bitten.edgewall.org bitten] build events 
     83   * `bitten` for [http://bitten.edgewall.org bitten] build events, only  
     84available if bitten plugin is installed and enabled 
    7885 * `hosts` is a comma-separated list of network hosts to send notification to 
    7986   * if `hosts` is not defined, the notifications are broadcasted onto the LAN, 
    8087     which could be a security risks in some environments. You'll be warned 
     88 * `userprefs` is a boolean option to allow per-user notification settings. 
     89When enabled, any user who's been granted the `GROWL_MODIFY` permission may 
     90select which notifications he wishes to receive, and the destination host 
     91which the notifications should be sent to. 
     92 
     93=== Permissions === 
     94 
     95The plugin defines two new permissions: 
     96 * `GROWL_MODIFY` permission allows a user to change the notification settings 
     97   through the Growl plugin perference panel, and choose the destination host  
     98   for the notifications 
     99 * `GROWL_ADMIN` gives the same priviledges as `GROWL_MODIFY`, and allows the 
     100   administrator to broadcast notfications to a sub network. To broadcast  
     101   notifications, the administrator should use the special '<broadcast>` host. 
     102 
     103=== Warnings === 
     104 
     105==== Notification overload ==== 
     106Be warned that there is no restriction on the number of plugin users, which 
     107might end up overloading a Trac installation if too many hosts are set to  
     108receive various Growl notifications. This plugin is mainly dedicated to small 
     109team of users. Please also consider the use of the broadcast feature to  
     110reduce the number of notifications sent on every Trac event. 
     111 
     112==== Security considerations ==== 
     113Your Trac-managed information may be at risk if you enable user preferences 
     114(see `userprefs` setting) and some random user chooses a host that is located  
     115outside your LAN. Only give `GROWL_MODIFY` permission to trusted user.  
     116 
     117Moreover, an untrusted user might set up his preferences to notify a foreign, 
     118remote host. Please ensure that Growl notifications are not routed 
     119outside your own network (''UDP:9887'') . 
     120 
     121You've been warned. 
     122 
     123== Preferences == 
     124 
     125When a user is granted the `GROWL_MODIFY` permission, the Growl plugin  
     126preference panel appears under the user preferences view: 
     127 
     128[[Image(growl-userpref-panel.png)]] 
     129 
     130A user which is granted the `GROWL_ADMIN` permission may select the `<broadcast>`  
     131special host address to broadcast notifications to all the hosts 
     132on the subnet. 
    81133 
    82134== Client configuration == 
     
    84136=== Growl installation === 
    85137 
    86 Follow growl [http://growl.info/documentation/growl-package-install.php installation instructions] 
     138Follow growl  
     139[http://growl.info/documentation/growl-package-install.php installation instructions] 
    87140 
    88141=== Growl configuration === 
    89142 
    90 Growl should be configured to accept incoming notifications and remote application registration. 
     143Growl should be configured to accept incoming notifications and remote  
     144application registration. 
    91145  1. Open Mac OS X system preferences 
    92146  1. Select the Growl icon in the "''Other''" section 
     
    98152 
    99153[[Image(growl-configuration.png)]] 
     154 
     155==== Notes ==== 
     156 
     157Growl server passwords are not currently supported. 
    100158 
    101159== Bugs/Feature Requests ==