Changes between Version 8 and Version 9 of GrowlPlugin


Ignore:
Timestamp:
Jun 12, 2015, 10:27:45 AM (9 years ago)
Author:
figaro
Comment:

Cosmetic changes, tagged with license

Legend:

Unmodified
Added
Removed
Modified

  • GrowlPlugin

    v8 v9  
    1 = Growl notification dispatcher for Trac events =
     1[[PageOutline(2-5,Contents,pullout)]]
    22
    3 [[PageOutline]]
     3= Growl notification dispatcher for Trac events
    44
    5 == Description ==
     5== Description
    66
    7 This plugin dispatches change events that occur in a Trac project to
    8 Growl-enabled clients.
     7This plugin dispatches change events that occur in a Trac project to Growl-enabled clients.
    98
    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.
     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.
    1210
    13 This plugin uses remote notifications, using the local network.[[br]]
    14 The server may run on any OS, such as Linux, OS X, Windows or virtually any
    15 other OS that supports Trac.
     11This plugin uses remote notifications, using the local network. The server may run on any OS, such as Linux, OS X, Windows or virtually any other OS that supports Trac.
    1612
    17 The plugin does not rely on any 3^rd^ party libraries: no Growl SDK or library
    18 is required on the Trac server.
     13The plugin does not rely on any third party libraries: no Growl SDK or library is required on the Trac server.
    1914
    2015Currently supported event sources:
    21  * Ticket creation, deletion, and update
    22  * Wiki page creation, deletion, and edition
    23  * Attachment creation and deletion
    24  * [http://bitten.edgewall.org Bitten] build startup, abortion and completion
    25 
    26 === Examples ===
     16 * Ticket creation, deletion, and update.
     17 * Wiki page creation, deletion, and edition.
     18 * Attachment creation and deletion.
     19 * [http://bitten.edgewall.org Bitten] build startup, abortion and completion.
    2720
    2821[[Image(growl-ticket.png)]]
    2922
    30 == Installation ==
     23== Bugs/Feature Requests
    3124
    32 Trac requirement:
    33  * Please read the version requirement defined in
    34   [browser:growlplugin/0.11/setup.py setup.py] file, search for ''install_requires''
    35  
    36 === Get the plugin source code ===
     25Existing bugs and feature requests for GrowlPlugin are
     26[report:9?COMPONENT=GrowlPlugin here].
    3727
    38 ==== Download ====
     28If you have any issues, create a
     29[/newticket?component=GrowlPlugin new ticket].
     30
     31[[TicketQuery(component=GrowlPlugin&group=type,format=progress)]]
     32
     33== Download
     34
    3935Download the zipped source from [download:growlplugin here].
    40 ==== Source ====
     36
     37== Source
     38
    4139You can check out GrowlPlugin from [http://trac-hacks.org/svn/growlplugin here]
    4240using Subversion, or [source:growlplugin browse the source] with Trac.
    4341
    44 === Build the plugin ===
     42== Installation
     43
     44For the prerequisites see the version requirement defined in [browser:growlplugin/0.11/setup.py setup.py] file, and search for ''install_requires''.
    4545
    4646As with any other plugin:
    47 {{{
     47{{{#!sh
    4848python setup.py bdist_egg
    4949}}}
    5050
    51 === Installation of the plugin ===
     51Copy the generated egg file (from the `dist/` directory) to your project's plugins directory, or in the global plugin directory if you want to use it for more than one Trac project.
    5252
    53 Copy the generated egg file (from the `dist/` directory) to your project
    54 plugin directory, or in the global plugin directory if you want to use it for
    55 several Trac projects
    56 
    57 === Enabling the plugin ===
    58 
    59 From the WebAdmin plugin interface or from your `trac.ini` file, enable the
    60 GrowlPlugin.
    61 
    62 In `trac.ini`, edit the ''components'' section to add the revtree entry as
    63 follows:
    64 {{{
     53From the WebAdmin plugin interface or from your `trac.ini` file, enable the GrowlPlugin:
     54{{{#!ini
    6555[components]
    6656growl.notifier.* = enabled
    6757}}}
    6858
    69 === Configuration ===
     59== Configuration
    7060
    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.
    73 {{{
     61The growl plugin can be configured with the help of the following settings:
     62{{{#!ini
    7463[growl]
    7564sources = wiki, ticket, attachment, bitten
    … …  
    7766userprefs = false
    7867}}}
     68
     69Settings:
    7970 * `sources` is a comma-separated list of source events.
    80    * `wiki` for wiki events,
    81    * `ticket` for ticket events,
     71   * `wiki` for wiki events
     72   * `ticket` for ticket events
    8273   * `attachment` for attachment events
    83    * `bitten` for [http://bitten.edgewall.org bitten] build events, only
    84 available if bitten plugin is installed and enabled
     74   * `bitten` for [http://bitten.edgewall.org Bitten] build events, only available if the Bitten plugin is installed and enabled
    8575 * `hosts` is a comma-separated list of network hosts to send notification to
    86    * if `hosts` is not defined, the notifications are broadcasted onto the LAN,
    87      which could be a security risks in some environments. You'll be warned
     76   * if `hosts` is not defined, then the notifications are broadcast onto the LAN, which could pose a security risk in some environments.
    8877 * `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.
    9278
    93 === Permissions ===
     79When enabled, any user who's been granted the `GROWL_MODIFY` permission may select which notifications he wishes to receive, and the destination host which the notifications should be sent to.
     80
     81=== Permissions
    9482
    9583The 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.
     84 * `GROWL_MODIFY` permission allows a user to change the notification settings through the Growl plugin perference panel, and choose the destination host for the notifications.
     85 * `GROWL_ADMIN` gives the same priviledges as `GROWL_MODIFY`, and allows the administrator to broadcast notfications to a sub network. To broadcast notifications, the administrator should use the special '<broadcast>` host.
    10286
    103 === Warnings ===
     87=== Warnings
    10488
    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.
     89==== Notification overload
    11190
    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.
     91Note that there is no restriction on the number of plugin users, which might overload a Trac installation if too many hosts are set to receive various Growl notifications. This plugin is mainly oriented to small teams of users. Please also consider the use of the broadcast feature to reduce the number of notifications sent on every Trac event.
    11692
    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'') .
     93==== Security considerations
    12094
    121 You've been warned.
     95Your Trac-managed information may be at risk if you enable user preferences (see `userprefs` setting) and some random user chooses a host that is located outside your LAN. Only give `GROWL_MODIFY` permission to trusted user.
    12296
    123 == Preferences ==
     97Moreover, an untrusted user might set up his preferences to notify a foreign, remote host. Please ensure that Growl notifications are not routed
     98outside your own network (''UDP:9887'').
    12499
    125 When a user is granted the `GROWL_MODIFY` permission, the Growl plugin
    126 preference panel appears under the user preferences view:
     100=== Preferences
     101
     102When a user is granted the `GROWL_MODIFY` permission, the Growl plugin preference panel appears under the user preferences view:
    127103
    128104[[Image(growl-userpref-panel.png)]]
    129105
    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.
     106A user which is granted the `GROWL_ADMIN` permission may select the `<broadcast>` special host address to broadcast notifications to all the hosts on the subnet.
    133107
    134 == Client configuration ==
     108=== Client configuration
    135109
    136 === Growl installation ===
     110==== Growl installation
    137111
    138 Follow growl
    139 [http://growl.info/documentation/growl-package-install.php installation instructions]
     112Follow the Growl [http://growl.info/documentation/growl-package-install.php installation instructions].
    140113
    141 === Growl configuration ===
     114==== Growl configuration
    142115
    143 Growl should be configured to accept incoming notifications and remote
    144 application registration.
    145   1. Open Mac OS X system preferences
    146   1. Select the Growl icon in the "''Other''" section
    147   1. Select the "''Network''" pane
    148   1. Enable the following check boxes
     116Growl should be configured to accept incoming notifications and remote application registration.
     117  1. Open Mac OS X system preferences.
     118  1. Select the Growl icon in the "''Other''" section.
     119  1. Select the "''Network''" pane.
     120  1. Enable the following check boxes:
    149121     * ''Listen for incoming notifications''
    150122     * ''Allow remote application registration''
    151   1. Leave the "''Server password''" field empty
     123  1. Leave the "''Server password''" field empty.
    152124
    153125[[Image(growl-configuration.png)]]
    154126
    155 ==== Notes ====
     127'''Note:''' Growl server passwords are currently not supported.
    156128
    157 Growl server passwords are not currently supported.
    158 
    159 == Bugs/Feature Requests ==
    160 
    161 This plugin is highly experimental (in early development stage)
    162 
    163 Existing bugs and feature requests for GrowlPlugin are
    164 [report:9?COMPONENT=GrowlPlugin here].
    165 
    166 If you have any issues, create a
    167 [http://trac-hacks.org/newticket?component=GrowlPlugin&owner=eblot new ticket].
    168 
    169 
    170 == Recent Changes ==
     129== Recent Changes
    171130
    172131[[ChangeLog(growlplugin, 3)]]
    173132
    174 == Author/Contributors ==
     133== Author/Contributors
    175134
    176135'''Author:''' [wiki:eblot] [[BR]]
     136'''Maintainer:''' [[Maintainer]][[BR]]
    177137'''Contributors:'''
    178138