Mercurial > prosody-wiki
comparison mod_websocket.wiki @ 312:e6cc6bf08560
Update to reflect current status
author | florob@babelmonkeys.de |
---|---|
date | Sat, 10 Nov 2012 23:43:15 +0000 |
parents | a61452a7f698 |
children | 18ecfc47bc83 |
comparison
equal
deleted
inserted
replaced
311:aaa07aaf3308 | 312:e6cc6bf08560 |
---|---|
1 #summary Simple XMPP-over-websocket support | 1 #summary Simple XMPP-over-websocket support |
2 #labels Stage-Alpha | 2 #labels Stage-Alpha |
3 | 3 |
4 = Introduction = | 4 = Introduction = |
5 | 5 |
6 [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. | 6 [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. |
7 | 7 |
8 In our case it is interesting to tunnel XMPP over web sockets, as an alternative to e.g. BOSH, web sockets having less overhead. | 8 In our case it is interesting to tunnel XMPP over WebSockets, as an alternative to e.g. BOSH, WebSockets having less overhead. |
9 | 9 |
10 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]. | 10 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: |
11 * [https://github.com/sonnyp/lightstring Lightstring] | |
12 * Strophe.js branches: | |
13 * [https://github.com/Gordin/strophejs Gordin's branch] | |
14 * [https://github.com/superfeedr/strophejs/tree/protocol-ed Superfeedr's branch] | |
11 | 15 |
12 = Usage = | 16 = Usage = |
13 | 17 |
14 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). | 18 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. |
19 | |
20 A cross_domain_websocket option is supported. | |
21 Set it to true to enable cross-domain requests from all websites, | |
22 or specify a list like | |
23 {{{ | |
24 cross_domain_websocket = { "http://jabber.org", "http://prosody.im" }; | |
25 }}} | |
15 | 26 |
16 = Compatibility = | 27 = Compatibility = |
17 ||0.7||Works|| | 28 ||0.9||Works|| |
18 ||0.6||Not supported|| | 29 ||< 0.9||Not supported|| |