Mercurial > prosody-modules

view mod_json_streams/README.markdown @ 5646:d67980d9e12d

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_http_oauth2: Apply refresh token ttl to refresh token instead of grant The intent in 59d5fc50f602 was for refresh tokens to extend the lifetime of the grant, but the refresh token ttl was applied to the grant and mod_tokenauth does not change it, leading to the grant expiring regardless of refresh token usage. This makes grant lifetimes unlimited, which seems to be standard practice in the wild.
author Kim Alvefur <zash@zash.se>
date Mon, 11 Sep 2023 10:48:31 +0200
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