Mercurial > prosody-wiki

annotate mod_websocket.wiki @ 340:ecf8bfe998ec

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add documentation on DAY, TIME, RATE and LIMIT firewall conditions
author MWild1@gmail.com
date Sat, 06 Apr 2013 23:28:14 +0000
parents 188ff73d261e
children 421d0865f89d
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
118
a61452a7f698 Created wiki page through web user interface.
MWild1
parents:
diff changeset
1 #summary Simple XMPP-over-websocket support
a61452a7f698 Created wiki page through web user interface.
MWild1
parents:
diff changeset
2 #labels Stage-Alpha
a61452a7f698 Created wiki page through web user interface.
MWild1
parents:
diff changeset
3
a61452a7f698 Created wiki page through web user interface.
MWild1
parents:
diff changeset
4 = Introduction =
a61452a7f698 Created wiki page through web user interface.
MWild1
parents:
diff changeset
5
320
188ff73d261e mod_websocket: Remove duplicate http:// (thanks Link Mauve)
Kim Alvefur <zash@zash.se>
parents: 313
diff changeset
6 [http://en.wikipedia.org/wiki/WebSocket WebSockets] is a new protocol for providing web pages with simple two-way communication with a web server.
312
e6cc6bf08560 Update to reflect current status
florob@babelmonkeys.de
parents: 118
diff changeset
7
313
18ecfc47bc83 Prevent autolinking
florob@babelmonkeys.de
parents: 312
diff changeset
8 In our case it is interesting to tunnel XMPP over !WebSockets, as an alternative to e.g. BOSH, !WebSockets having less overhead.
118
a61452a7f698 Created wiki page through web user interface.
MWild1
parents:
diff changeset
9
313
18ecfc47bc83 Prevent autolinking
florob@babelmonkeys.de
parents: 312
diff changeset
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:
312
e6cc6bf08560 Update to reflect current status
florob@babelmonkeys.de
parents: 118
diff changeset
11 * [https://github.com/sonnyp/lightstring Lightstring]
e6cc6bf08560 Update to reflect current status
florob@babelmonkeys.de
parents: 118
diff changeset
12 * Strophe.js branches:
e6cc6bf08560 Update to reflect current status
florob@babelmonkeys.de
parents: 118
diff changeset
13 * [https://github.com/Gordin/strophejs Gordin's branch]
e6cc6bf08560 Update to reflect current status
florob@babelmonkeys.de
parents: 118
diff changeset
14 * [https://github.com/superfeedr/strophejs/tree/protocol-ed Superfeedr's branch]
118
a61452a7f698 Created wiki page through web user interface.
MWild1
parents:
diff changeset
15
a61452a7f698 Created wiki page through web user interface.
MWild1
parents:
diff changeset
16 = Usage =
a61452a7f698 Created wiki page through web user interface.
MWild1
parents:
diff changeset
17
312
e6cc6bf08560 Update to reflect current status
florob@babelmonkeys.de
parents: 118
diff changeset
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.
e6cc6bf08560 Update to reflect current status
florob@babelmonkeys.de
parents: 118
diff changeset
19
e6cc6bf08560 Update to reflect current status
florob@babelmonkeys.de
parents: 118
diff changeset
20 A cross_domain_websocket option is supported.
e6cc6bf08560 Update to reflect current status
florob@babelmonkeys.de
parents: 118
diff changeset
21 Set it to true to enable cross-domain requests from all websites,
e6cc6bf08560 Update to reflect current status
florob@babelmonkeys.de
parents: 118
diff changeset
22 or specify a list like
e6cc6bf08560 Update to reflect current status
florob@babelmonkeys.de
parents: 118
diff changeset
23 {{{
e6cc6bf08560 Update to reflect current status
florob@babelmonkeys.de
parents: 118
diff changeset
24 cross_domain_websocket = { "http://jabber.org", "http://prosody.im" };
e6cc6bf08560 Update to reflect current status
florob@babelmonkeys.de
parents: 118
diff changeset
25 }}}
118
a61452a7f698 Created wiki page through web user interface.
MWild1
parents:
diff changeset
26
a61452a7f698 Created wiki page through web user interface.
MWild1
parents:
diff changeset
27 = Compatibility =
312
e6cc6bf08560 Update to reflect current status
florob@babelmonkeys.de
parents: 118
diff changeset
28 ||0.9||Works||
320
188ff73d261e mod_websocket: Remove duplicate http:// (thanks Link Mauve)
Kim Alvefur <zash@zash.se>
parents: 313
diff changeset
29 ||< 0.9||Not supported||