Mercurial > prosody-modules

view mod_json_streams/README.markdown @ 5264:d3ebaef1ea7a

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_http_oauth2: Correctly verify OAuth client credentials on revocation Makes no sense to validate against username and password here, or using a token to revoke another token, or itself? In fact, upon further discussion, why do you need credentials to revoke a token? If you are not supposed to have the token, revoking it seems the most responsible thing to do with it, so it should be allowed, while if you are supposed to have it, you should be allowed to revoke it.
author Kim Alvefur <zash@zash.se>
date Tue, 21 Mar 2023 21:57:18 +0100
parents 4d73a1a6ba68
children
line wrap: on
line source

---
labels:
- 'Stage-Beta'
summary: JSON Encodings for XMPP
...

Introduction
============

This plugin encodes XMPP as JSON. This is an implementation of
[XEP-0295: JSON Encodings for
XMPP](http://xmpp.org/extensions/xep-0295.html).

Simply loading this module makes Prosody accept JSON on C2S streams
(legacy XML clients are still supported).

For BOSH, it requires mod\_bosh be loaded, and JSON should be directed
at the `/jsonstreams` HTTP path.

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.

Configuration
=============

Just add `"json_streams"` in your config's global `modules_enabled`
list, for example:

    modules_enabled = {
        ...
        "json_streams";
    }

Strophe.js plugin
=================

We also developed a [JSON streams
plugin](http://prosody-modules.googlecode.com/hg/mod_json_streams/strophe.jsonstreams.js)
for the popular [strophe.js](http://code.stanziq.com/strophe) library.

Just include it like this after including the strophe library, and your
strophe-based client will be speaking JSON:

    <script type="text/javascript" src="strophe.jsonstreams.js"></script>

Be sure to set the HTTP path to `/jsonstreams`. No other changes are
required.

Compatibility
=============

  ------- -------
  0.8     Works
  trunk   Works
  ------- -------

Quirks
======

-   This plugin does not currently work with Prosody's [port
    multiplexing](http://prosody.im/doc/port_multiplexing) feature