plugins/Xmpp/README

   1 The XMPP plugin allows users to send and receive notices over the
   2 XMPP/Jabber/GTalk network.
   3
   4 Installation
   5 ============
   6 add "addPlugin('xmpp',
   7     array('setting'=>'value', 'setting2'=>'value2', ...);"
   8 to the bottom of your config.php
   9
  10 The daemon included with this plugin must be running. It will be
  11 started by the plugin along with their other daemons when you run
  12 scripts/startdaemons.sh. See the section "Queues and daemons" in
  13 INSTALL for more about queuing and daemons.
  14
  15
  16 Settings
  17 ========
  18 user*: user part of the jid
  19 server*: server part of the jid
  20 resource*: resource part of the jid
  21 port (5222): port on which to connect to the server
  22 encryption (true): use encryption on the connection
  23 host (same as server): host to connect to. Usually, you won't set this.
  24 debug (false): log extra debug info (e.g. sent/recv XMPP stanzas)
  25 public: list of jid's that should get the public feed (firehose)
  26
  27 * required
  28 default values are in (parenthesis)
  29
  30 Note that setting 'host' is required if the XMPP service is configured
  31 with DNS SRV records, since the XMPPHP does currently not support SRV
  32 lookups.
  33
  34
  35 Example
  36 =======
  37 addPlugin('xmpp', array(
  38     'user'=>'update',
  39     'resource'=>'social,
  40     'server'=>'identi.ca',
  41     'password'=>'...',
  42     'public'=>array('bob@aol.com', 'sue@google.com')
  43 ));