Mercurial > prosody-wiki

annotate mod_websocket.wiki @ 406:30cf284e5680

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Created wiki page through web user interface.
author MWild1@gmail.com
date Mon, 02 Dec 2013 01:58:57 +0000
parents 421d0865f89d
children 6c4444345eea
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]
402
421d0865f89d Update library state
florob@babelmonkeys.de
parents: 320
diff changeset
12 * [https://github.com/strophe/strophejs strophe.js master]
421d0865f89d Update library state
florob@babelmonkeys.de
parents: 320
diff changeset
13 * [https://github.com/legastero/stanza.io stanza.io]
118
a61452a7f698 Created wiki page through web user interface.
MWild1
parents:
diff changeset
14
a61452a7f698 Created wiki page through web user interface.
MWild1
parents:
diff changeset
15 = Usage =
a61452a7f698 Created wiki page through web user interface.
MWild1
parents:
diff changeset
16
312
e6cc6bf08560 Update to reflect current status
florob@babelmonkeys.de
parents: 118
diff changeset
17 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
18
e6cc6bf08560 Update to reflect current status
florob@babelmonkeys.de
parents: 118
diff changeset
19 A cross_domain_websocket option is supported.
e6cc6bf08560 Update to reflect current status
florob@babelmonkeys.de
parents: 118
diff changeset
20 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
21 or specify a list like
e6cc6bf08560 Update to reflect current status
florob@babelmonkeys.de
parents: 118
diff changeset
22 {{{
e6cc6bf08560 Update to reflect current status
florob@babelmonkeys.de
parents: 118
diff changeset
23 cross_domain_websocket = { "http://jabber.org", "http://prosody.im" };
e6cc6bf08560 Update to reflect current status
florob@babelmonkeys.de
parents: 118
diff changeset
24 }}}
118
a61452a7f698 Created wiki page through web user interface.
MWild1
parents:
diff changeset
25
a61452a7f698 Created wiki page through web user interface.
MWild1
parents:
diff changeset
26 = Compatibility =
312
e6cc6bf08560 Update to reflect current status
florob@babelmonkeys.de
parents: 118
diff changeset
27 ||0.9||Works||
402
421d0865f89d Update library state
florob@babelmonkeys.de
parents: 320
diff changeset
28 ||< 0.9||Not supported||