Mercurial > prosody-modules

diff mod_http_xep227/README.md @ 4865:bd0a1f917d98

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_http_xep227: New module providing HTTP API for account data import/export
author Matthew Wild <mwild1@gmail.com>
date Wed, 12 Jan 2022 16:42:08 +0000
parents
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_http_xep227/README.md	Wed Jan 12 16:42:08 2022 +0000
@@ -0,0 +1,26 @@
+---
+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).