welcome: please sign in

The following 296 words could not be found in the dictionary of 7 words (including 7 LocalSpellingWords) and are highlighted below:
about   accessible   account   add   Add   added   all   allows   along   also   an   and   any   applied   archive   are   as   As   attachments   author   available   Band   based   basic   be   become   before   being   better   block   bot   both   boxes   build   by   can   change   changed   changes   check   checkout   choose   client   communicate   communication   condition   config   configuration   consider   contains   content   contents   Contents   copy   Copy   correctly   Create   created   Currently   Data   data   date   delete   deletion   described   detailed   details   directly   directory   distributed   distribution   doesn   Edit   Either   email   environment   events   exactly   example   extend   extensions   Features   file   find   first   For   for   formatted   Forms   from   full   further   generates   get   getting   had   have   here   html   http   i18n   if   If   in   includes   information   Install   install   installation   installing   instructions   interactive   interactively   interested   Internationalization   invoke   is   issues   it   its   itself   Jabber   jabber   jabberbot   jajcus   just   Known   large   last   Launch   let   limits   list   lives   lot   main   Make   make   many   may   might   more   multi   must   need   net   new   not   notification   Notification   notifications   notified   occuring   occurs   Of   of   old   older   on   only   operations   option   options   or   order   org   Out   own   package   packages   page   pages   particular   perform   performing   place   possibly   post   preferences   present   process   protocol   Py   py   python   pyxmpp   querying   rate   rather   raw   re   received   recent   register   relaxed   rename   repository   response   restart   resulting   reverts   revision   running   same   samples   searches   secret   See   select   selection   send   sent   separate   server   servers   set   Setting   setup   should   simple   site   sites   snapshot   snippet   so   solution   some   specify   started   step   string   subdirectory   subscribed   subscribing   such   suitable   super   Supplemental   supported   sure   svn   system   Table   that   The   the   These   they   things   This   this   tight   to   To   Traffic   traffic   trunk   try   two   uninstall   unstable   unusable   up   uri   use   used   user   Users   users   uses   using   usually   variable   various   version   via   visible   waiting   want   ways   When   when   which   wiki   Wiki   wikiconfig   will   with   within   won   work   www   xmpp   You   you   your  

Clear message
Page Locked

HelpOnNotification

Contents

  1. The notification system
    1. Features
    2. Known main issues with the Jabber bot
      1. You need a recent version of pyxmpp, 1.0 won't work
      2. Traffic limits
      3. Internationalization
    3. Setting up a Jabber bot
    4. Notification options

1. The notification system

MoinMoin 1.7 includes a notification system. Supplemental to the basic email based notification you can use a separate process running a Jabber/XMPP notification bot. See http://www.jabber.org/ and http://www.xmpp.org/ for more information on this protocol.

The bot can be used to send notifications about various events occuring in your Wiki, or to work with the Wiki interactively.

As it's a separate process, it doesn't block waiting for all notifications to be sent, so this solution should be suitable for large sites that have many users subscribed to particular changes.

1.1. Features

1.2. Known main issues with the Jabber bot

1.2.1. You need a recent version of pyxmpp, 1.0 won't work

Either use a recent snapshot or get it directly from svn repository with: 

           svn checkout http://pyxmpp.jajcus.net/svn/pyxmpp/trunk pyxmpp

Add the resulting pyxmpp directory to your PYTHONPATH or perform a "full installation" as described here: 

           To build the package just invoke:
           python setup.py build

           To install it:
           python setup.py install

If you had some older version of PyXMPP it is better to uninstall it first (delete pyxmpp subdirectory of your site-packages directory) before installing the new version or things might not work correctly. 

           You may also try:
           make

           and:
           make install

1.2.2. Traffic limits

Jabber servers usually have rather tight data rate limits, so if your site generates a lot of traffic, the notification bot may become unstable and/or unusable. If such a condition occurs, you should consider running your own Jabber/XMPP server with relaxed limits.

1.2.3. Internationalization

For the i18n to work, your wiki must be accessible when the notification bot is being started.

1.3. Setting up a Jabber bot

These are step-by-step instructions you have to perform in order to get the Jabber notification bot up and running:

  1. Install a post-1.0 version of pyxmpp.

  2. The Jabber bot lives in a jabberbot/ directory in MoinMoin's distribution archive. Copy it to a suitable place. Make sure that PYTHONPATH environment variable contains the directory that contains the jabberbot package.

  3. Create an account for the bot to use using any Jabber/XMPP client. Currently it can't register the account by itself.

  4. Edit the bot's configuration file, config.py, and set its account details and a secret used to communicate with the wiki.

  5. Edit your wikiconfig and add notification_bot_uri and secret options to it. You will find an example in file wiki/config/more_samples/jabber_wikiconfig_snippet, distributed along with MoinMoin. Make sure to set the secret to exactly the same string as you used in the bot's configuration!

  6. Launch / restart your wiki.

  7. Launch the bot: python main.py

1.4. Notification options

When the notification_bot_uri option is present in your wiki's config, new options become available in your user preferences.

Make sure to set your JID in your user preferences.

A multi-selection list allows you to select which events you want to be notified about, and two new check-boxes let you specify if notifications should be sent via email, jabber or both.