Changes between Version 7 and Version 8 of GrowlPlugin
- Timestamp:
- Jun 7, 2008, 10:56:31 PM (16 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
GrowlPlugin
v7 v8 5 5 == Description == 6 6 7 This plugin dispatches change events that occur in a Trac project to Growl-enabled clients. 7 This plugin dispatches change events that occur in a Trac project to 8 Growl-enabled clients. 8 9 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: 11 it allows applications that support Growl to send you notifications. 10 12 11 13 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. 14 The server may run on any OS, such as Linux, OS X, Windows or virtually any 15 other OS that supports Trac. 13 16 14 The plugin does not rely on any 3^rd^ party libraries: no Growl SDK or library is required on the Trac server. 17 The plugin does not rely on any 3^rd^ party libraries: no Growl SDK or library 18 is required on the Trac server. 15 19 16 20 Currently supported event sources: … … 65 69 === Configuration === 66 70 67 The growl plugin can be configured with the help of the following settings: 71 The growl plugin can be configured with the help of the following settings. 72 The values defined in the following example represent the default values. 68 73 {{{ 69 74 [growl] 70 75 sources = wiki, ticket, attachment, bitten 71 hosts = 76 hosts = 77 userprefs = false 72 78 }}} 73 79 * `sources` is a comma-separated list of source events. … … 75 81 * `ticket` for ticket events, 76 82 * `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 84 available if bitten plugin is installed and enabled 78 85 * `hosts` is a comma-separated list of network hosts to send notification to 79 86 * if `hosts` is not defined, the notifications are broadcasted onto the LAN, 80 87 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. 89 When enabled, any user who's been granted the `GROWL_MODIFY` permission may 90 select which notifications he wishes to receive, and the destination host 91 which the notifications should be sent to. 92 93 === Permissions === 94 95 The 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 ==== 106 Be warned that there is no restriction on the number of plugin users, which 107 might end up overloading a Trac installation if too many hosts are set to 108 receive various Growl notifications. This plugin is mainly dedicated to small 109 team of users. Please also consider the use of the broadcast feature to 110 reduce the number of notifications sent on every Trac event. 111 112 ==== Security considerations ==== 113 Your 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 115 outside your LAN. Only give `GROWL_MODIFY` permission to trusted user. 116 117 Moreover, an untrusted user might set up his preferences to notify a foreign, 118 remote host. Please ensure that Growl notifications are not routed 119 outside your own network (''UDP:9887'') . 120 121 You've been warned. 122 123 == Preferences == 124 125 When a user is granted the `GROWL_MODIFY` permission, the Growl plugin 126 preference panel appears under the user preferences view: 127 128 [[Image(growl-userpref-panel.png)]] 129 130 A user which is granted the `GROWL_ADMIN` permission may select the `<broadcast>` 131 special host address to broadcast notifications to all the hosts 132 on the subnet. 81 133 82 134 == Client configuration == … … 84 136 === Growl installation === 85 137 86 Follow growl [http://growl.info/documentation/growl-package-install.php installation instructions] 138 Follow growl 139 [http://growl.info/documentation/growl-package-install.php installation instructions] 87 140 88 141 === Growl configuration === 89 142 90 Growl should be configured to accept incoming notifications and remote application registration. 143 Growl should be configured to accept incoming notifications and remote 144 application registration. 91 145 1. Open Mac OS X system preferences 92 146 1. Select the Growl icon in the "''Other''" section … … 98 152 99 153 [[Image(growl-configuration.png)]] 154 155 ==== Notes ==== 156 157 Growl server passwords are not currently supported. 100 158 101 159 == Bugs/Feature Requests ==