diff options
| author | Craig Andrews <candrews@integralblue.com> | 2010-01-23 01:25:27 -0500 |
|---|---|---|
| committer | Craig Andrews <candrews@integralblue.com> | 2010-01-27 13:48:35 -0500 |
| commit | e9995b0f6ab0788162e22c996e5ee0af416dd519 (patch) | |
| tree | 10b6eda02028c3320d0c7aaef88570f3ac862041 /plugins/Xmpp/README | |
| parent | 5224c7d6c263f078c3628650ff2b4b706862307c (diff) | |
Create IM plugin, Pluginize XMPP, Create AIM plugin
Diffstat (limited to 'plugins/Xmpp/README')
| -rw-r--r-- | plugins/Xmpp/README | 35 |
1 files changed, 35 insertions, 0 deletions
diff --git a/plugins/Xmpp/README b/plugins/Xmpp/README new file mode 100644 index 000000000..9bd71e980 --- /dev/null +++ b/plugins/Xmpp/README @@ -0,0 +1,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') +)); + |