changeset 312:e6cc6bf08560

Update to reflect current status
author florob@babelmonkeys.de
date Sat, 10 Nov 2012 23:43:15 +0000
parents aaa07aaf3308
children 18ecfc47bc83
files mod_websocket.wiki
diffstat 1 files changed, 18 insertions(+), 7 deletions(-) [+]
line wrap: on
line diff
--- a/mod_websocket.wiki	Sat Nov 10 20:33:37 2012 +0000
+++ b/mod_websocket.wiki	Sat Nov 10 23:43:15 2012 +0000
@@ -3,16 +3,27 @@
 
 = Introduction =
 
-[http://en.wikipedia.org/wiki/Web_Sockets Web Sockets] is a new protocol for providing web pages with simple two-way communication with a web server.
+[http://http://en.wikipedia.org/wiki/WebSocket WebSockets] is a new protocol for providing web pages with simple two-way communication with a web server.
+
+In our case it is interesting to tunnel XMPP over WebSockets, as an alternative to e.g. BOSH, WebSockets having less overhead.
 
-In our case it is interesting to tunnel XMPP over web sockets, as an alternative to e.g. BOSH, web sockets having less overhead.
-
-Note that the Web Socket specification has not been finalized, and is still evolving. There are currently no XMPP libraries capable of Web Sockets, but a good candidate for initial support is [http://code.stanziq.com/strophe/ Strophe.js].
+Note that the XMPP over WebSocket specification has not been finalized, and is still evolving. There are few XMPP libraries capable of WebSockets, among them:
+  * [https://github.com/sonnyp/lightstring Lightstring]
+  * Strophe.js branches:
+    * [https://github.com/Gordin/strophejs Gordin's branch]
+    * [https://github.com/superfeedr/strophejs/tree/protocol-ed Superfeedr's branch]
 
 = Usage =
 
-Simply add mod_websocket to your modules_enabled list, as you would any other module. The repository includes a demo websocket.html file to show connecting to the socket. It doesn't yet perform any XMPP (see above comment about Strophe).
+Simply add mod_websocket to your modules_enabled list, as you would any other module. The repository includes a demo websocket.html file to show connecting to the socket. It doesn't perform any XMPP.
+
+A cross_domain_websocket option is supported.
+Set it to true to enable cross-domain requests from all websites,
+or specify a list like
+{{{
+cross_domain_websocket = { "http://jabber.org", "http://prosody.im" };
+}}}
 
 = Compatibility =
-||0.7||Works||
-||0.6||Not supported||
\ No newline at end of file
+||0.9||Works||
+||< 0.9||Not supported||
\ No newline at end of file