view mod_http_xep227/README.md @ 5907:d194d1012fd3

Updating dox for mod_rest. Ideas expressed / clarified: 1) Making clear that mod_rest isn't to be installed under VirtualHosts AND as a component. 2) Understanding some of the implications of this choice: A) Changes to user authentication B) How it affects subdomains 3) More consistent use of domain names for clarity. 4) Using different heading sizes to show scope of section. Essentially, I added all the tidbits I had to clarify in getting this to work in my own example.
author Ben Smith <bens@effortlessis.com>
date Mon, 13 May 2024 13:25:13 -0700
parents bd0a1f917d98
children
line wrap: on
line source

---
labels:
- 'Stage-Alpha'
summary: 'HTTP-based account data import/export using XEP-0227'
...

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

This module allows a user to import or export account data using a simple
HTTP API. The data is expected to be in the format described by [XEP-0227:
Portable Import/Export Format for XMPP-IM Servers](https://xmpp.org/extensions/xep-0227.html).

Note that this module does not provide any UI for direct interaction from
users - it is expected that any UI will be provided elsewhere. For example,
this module is used by the [Snikket web portal](https://github.com/snikket-im/snikket-web-portal/).

For Developers
==========

TBD.

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

Requires Prosody trunk (270047afa6af).