view mod_http_xep227/README.md @ 5668:ecfd7aece33b

mod_measure_modules: Report module statuses via OpenMetrics Someone in the chat asked about a health check endpoint, which reminded me of mod_http_status, which provides access to module statuses with full details. After that, this idea came about, which seems natural. As noted in the README, it could be used to monitor that critical modules are in fact loaded correctly. As more modules use the status API, the more useful this module and mod_http_status becomes.
author Kim Alvefur <zash@zash.se>
date Fri, 06 Oct 2023 18:34:39 +0200
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).