Improved plugins/Xmpp/README

Added the relevant section in INSTALL about queues and daemons to get the plugin runnig. Made resource required, as otherwise XMPPHP will send invalid from JIDs in it's stanzas. For example when my configuration didn't had the resource part, outbound stanzas looked like this: <message from="gnusocial@example.de/" to="flow@example.de" type='chat'> <body> User "flow" on GNU Social has said that your XMPP/Jabber/GTalk screenname belongs to them. … </body> </message> Note the '/' at the end of the from attribute, without an actual XMPP resource. But according to RFC6122 2.1 "every allowable portion of a JID MUST NOT be zero bytes in length". Causing a jid-malformed response from the server. Also, it's nice to know that debug=true will print out all sent and received stanzas, which helped me to debug the problem. Furthermore I add a note that if the XMPP services uses DNS SRV records, 'host' has to be configured (in cases where service host != xmpp domain).

Improved plugins/Xmpp/README
Added the relevant section in INSTALL about queues and daemons to get the plugin runnig. Made resource required, as otherwise XMPPHP will send invalid from JIDs in it's stanzas. For example when my configuration didn't had the resource part, outbound stanzas looked like this: <message from="gnusocial@example.de/" to="flow@example.de" type='chat'> <body> User "flow" on GNU Social has said that your XMPP/Jabber/GTalk screenname belongs to them. … </body> </message> Note the '/' at the end of the from attribute, without an actual XMPP resource. But according to RFC6122 2.1 "every allowable portion of a JID MUST NOT be zero bytes in length". Causing a jid-malformed response from the server. Also, it's nice to know that debug=true will print out all sent and received stanzas, which helped me to debug the problem. Furthermore I add a note that if the XMPP services uses DNS SRV records, 'host' has to be configured (in cases where service host != xmpp domain).
b7d45e17 · Florian Schmaus · mmn · 53b8412a · b7d45e17
Commit b7d45e17 authored Oct 19, 2013 by Florian Schmaus Committed by mmn Oct 20, 2013
Hide whitespace changes
Inline Side-by-side

Showing with 11 additions and 4 deletions

plugins/Xmpp/README plugins/Xmpp/README +11 -4

No files found.
--- a/plugins/Xmpp/README
+++ b/plugins/Xmpp/README
@@ -9,27 +9,34 @@ 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.
+scripts/startdaemons.sh. See the section "Queues and daemons" in
+INSTALL 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
+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
+debug (false): log extra debug info (e.g. sent/recv XMPP stanzas)
 public: list of jid's that should get the public feed (firehose)

 * required
 default values are in (parenthesis)

+Note that setting 'host' is required if the XMPP service is configured
+with DNS SRV records, since the XMPPHP does currently not support SRV
+lookups.
+
+
 Example
 =======
 addPlugin('xmpp', array(
    'user'=>'update',
+    'resource'=>'social,
    'server'=>'identi.ca',
    'password'=>'...',
    'public'=>array('bob@aol.com', 'sue@google.com')