summaryrefslogtreecommitdiff
path: root/plugins/Xmpp/README
blob: 9bd71e98072083b1e21f1d3dfcdfc12b255c8c62 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
The XMPP plugin allows users to send and receive notices over the XMPP/Jabber/GTalk network.

Installation
============
add "addPlugin('xmpp',
    array('setting'=>'value', 'setting2'=>'value2', ...);"
to the bottom of your config.php

The daemon included with this plugin must be running. It will be started by
the plugin along with their other daemons when you run scripts/startdaemons.sh.
See the StatusNet README for more about queuing and daemons.

Settings
========
user*: user part of the jid
server*: server part of the jid
resource: resource part of the jid
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.
debug (false): log extra debug info
public: list of jid's that should get the public feed (firehose)

* required
default values are in (parenthesis)

Example
=======
addPlugin('xmpp', array(
    'user=>'update',
    'server=>'identi.ca',
    'password'=>'...',
    'public'=>array('bob@aol.com', 'sue@google.com')
));