Mercurial > prosodywiki
annotate mod_json_streams.wiki @ 173:e613d82d097a
mod_json_streams: Some documentation.
author  Waqas Hussain <waqas20@gmail.com> 

date  Sat, 02 Apr 2011 04:52:38 +0500 
parents  
children  c87bea8ab41a 
rev  line source 

173
e613d82d097a
mod_json_streams: Some documentation.
Waqas Hussain <waqas20@gmail.com>
parents:
diff
changeset

1 #summary JSON Encodings for XMPP 
e613d82d097a
mod_json_streams: Some documentation.
Waqas Hussain <waqas20@gmail.com>
parents:
diff
changeset

2 #labels StageBeta 
e613d82d097a
mod_json_streams: Some documentation.
Waqas Hussain <waqas20@gmail.com>
parents:
diff
changeset

3 
e613d82d097a
mod_json_streams: Some documentation.
Waqas Hussain <waqas20@gmail.com>
parents:
diff
changeset

4 = Introduction = 
e613d82d097a
mod_json_streams: Some documentation.
Waqas Hussain <waqas20@gmail.com>
parents:
diff
changeset

5 
e613d82d097a
mod_json_streams: Some documentation.
Waqas Hussain <waqas20@gmail.com>
parents:
diff
changeset

6 This plugin encodes XMPP as JSON. This is an implementation of [http://xmpp.org/extensions/xep0295.html XEP0295: JSON Encodings for XMPP]. 
e613d82d097a
mod_json_streams: Some documentation.
Waqas Hussain <waqas20@gmail.com>
parents:
diff
changeset

7 
e613d82d097a
mod_json_streams: Some documentation.
Waqas Hussain <waqas20@gmail.com>
parents:
diff
changeset

8 Simply loading this modules makes Prosody accept JSON for C2S streams (legacy XML clients are still supported). 
e613d82d097a
mod_json_streams: Some documentation.
Waqas Hussain <waqas20@gmail.com>
parents:
diff
changeset

9 
e613d82d097a
mod_json_streams: Some documentation.
Waqas Hussain <waqas20@gmail.com>
parents:
diff
changeset

10 For BOSH, it requires mod_bosh be loaded, and JSON should be directed to the '/jsonstreams' HTTP path. 
e613d82d097a
mod_json_streams: Some documentation.
Waqas Hussain <waqas20@gmail.com>
parents:
diff
changeset

11 
e613d82d097a
mod_json_streams: Some documentation.
Waqas Hussain <waqas20@gmail.com>
parents:
diff
changeset

12 JSON for S2S isn't supported due to the lack of a discovery mechanism, so we have left that disabled to stay compatible with legacy XML servers). 
e613d82d097a
mod_json_streams: Some documentation.
Waqas Hussain <waqas20@gmail.com>
parents:
diff
changeset

13 
e613d82d097a
mod_json_streams: Some documentation.
Waqas Hussain <waqas20@gmail.com>
parents:
diff
changeset

14 = Configuration = 
e613d82d097a
mod_json_streams: Some documentation.
Waqas Hussain <waqas20@gmail.com>
parents:
diff
changeset

15 Just add json_streams in your global modules_enabled list, for example: 
e613d82d097a
mod_json_streams: Some documentation.
Waqas Hussain <waqas20@gmail.com>
parents:
diff
changeset

16 
e613d82d097a
mod_json_streams: Some documentation.
Waqas Hussain <waqas20@gmail.com>
parents:
diff
changeset

17 {{{ 
e613d82d097a
mod_json_streams: Some documentation.
Waqas Hussain <waqas20@gmail.com>
parents:
diff
changeset

18 modules_enabled = { 
e613d82d097a
mod_json_streams: Some documentation.
Waqas Hussain <waqas20@gmail.com>
parents:
diff
changeset

19 ... 
e613d82d097a
mod_json_streams: Some documentation.
Waqas Hussain <waqas20@gmail.com>
parents:
diff
changeset

20 "json_streams"; 
e613d82d097a
mod_json_streams: Some documentation.
Waqas Hussain <waqas20@gmail.com>
parents:
diff
changeset

21 } 
e613d82d097a
mod_json_streams: Some documentation.
Waqas Hussain <waqas20@gmail.com>
parents:
diff
changeset

22 }}} 
e613d82d097a
mod_json_streams: Some documentation.
Waqas Hussain <waqas20@gmail.com>
parents:
diff
changeset

23 
e613d82d097a
mod_json_streams: Some documentation.
Waqas Hussain <waqas20@gmail.com>
parents:
diff
changeset

24 = Compatibility = 
e613d82d097a
mod_json_streams: Some documentation.
Waqas Hussain <waqas20@gmail.com>
parents:
diff
changeset

25 0.8Works 
e613d82d097a
mod_json_streams: Some documentation.
Waqas Hussain <waqas20@gmail.com>
parents:
diff
changeset

26 trunkWorks 
e613d82d097a
mod_json_streams: Some documentation.
Waqas Hussain <waqas20@gmail.com>
parents:
diff
changeset

27 
e613d82d097a
mod_json_streams: Some documentation.
Waqas Hussain <waqas20@gmail.com>
parents:
diff
changeset

28 = Quirks = 
e613d82d097a
mod_json_streams: Some documentation.
Waqas Hussain <waqas20@gmail.com>
parents:
diff
changeset

29 * This plugin does not work with TCP port multiplexing. 