File

mod_admin_message/README.markdown @ 5691: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
parent 5007:34fb3d239ac1
line wrap: on
line source

---
labels:
- 'Stage-Beta'
summary: 'IM-based administration console'
...

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

This module provides a console over XMPP. All the commands of the
mod\_admin\_telnet module are available from an XMPP client.

Only the Prosody admins (see the *admins* list in the Prosody
configuration file) can use this console.

Installation
============

Copy the mod\_admin\_message directory into a directory Prosody will
check for plugins (cf. [Installing
modules](http://prosody.im/doc/installing_modules)) and set up a
component:

    Component "console@example.com" "admin_message"

"console@example.com" is the identifier of the XMPP console.

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

  --------- ---------------
  trunk     Doesn't work (uses is_admin)
  0.9       Works
  \<= 0.8   Not supported
  --------- ---------------