2011-06-15 12:20:23 +01:00
|
|
|
The XMPP plugin allows users to send and receive notices over the
|
|
|
|
XMPP/Jabber/GTalk network.
|
2010-01-23 06:25:27 +00:00
|
|
|
|
|
|
|
Installation
|
|
|
|
============
|
|
|
|
add "addPlugin('xmpp',
|
|
|
|
array('setting'=>'value', 'setting2'=>'value2', ...);"
|
|
|
|
to the bottom of your config.php
|
|
|
|
|
2011-06-15 12:20:23 +01:00
|
|
|
The daemon included with this plugin must be running. It will be
|
|
|
|
started by the plugin along with their other daemons when you run
|
2013-10-19 11:19:00 +01:00
|
|
|
scripts/startdaemons.sh. See the section "Queues and daemons" in
|
|
|
|
INSTALL for more about queuing and daemons.
|
|
|
|
|
2010-01-23 06:25:27 +00:00
|
|
|
|
|
|
|
Settings
|
|
|
|
========
|
|
|
|
user*: user part of the jid
|
|
|
|
server*: server part of the jid
|
2013-10-19 11:19:00 +01:00
|
|
|
resource*: resource part of the jid
|
2010-01-23 06:25:27 +00:00
|
|
|
port (5222): port on which to connect to the server
|
|
|
|
encryption (true): use encryption on the connection
|
|
|
|
host (same as server): host to connect to. Usually, you won't set this.
|
2013-10-19 11:19:00 +01:00
|
|
|
debug (false): log extra debug info (e.g. sent/recv XMPP stanzas)
|
2010-01-23 06:25:27 +00:00
|
|
|
public: list of jid's that should get the public feed (firehose)
|
|
|
|
|
|
|
|
* required
|
|
|
|
default values are in (parenthesis)
|
|
|
|
|
2013-10-19 11:19:00 +01:00
|
|
|
Note that setting 'host' is required if the XMPP service is configured
|
2013-10-19 17:48:37 +01:00
|
|
|
with DNS SRV records, since XMPPHP does currently not support SRV
|
2013-10-19 11:19:00 +01:00
|
|
|
lookups.
|
|
|
|
|
|
|
|
|
2010-01-23 06:25:27 +00:00
|
|
|
Example
|
|
|
|
=======
|
|
|
|
addPlugin('xmpp', array(
|
2013-08-28 17:00:23 +01:00
|
|
|
'user'=>'update',
|
2013-10-19 17:48:37 +01:00
|
|
|
'resource'=>'social',
|
2013-08-28 17:00:23 +01:00
|
|
|
'server'=>'identi.ca',
|
2010-01-23 06:25:27 +00:00
|
|
|
'password'=>'...',
|
|
|
|
'public'=>array('bob@aol.com', 'sue@google.com')
|
|
|
|
));
|