view mod_server_status/README.markdown @ 3953:2c6d5734ae04

mod_rest: Add JSON mapping of XEP-0128: Service Discovery Extensions Example XEP-0157 payload: { "disco" : { "extensions" : { "http://jabber.org/network/serverinfo" : { "abuse-addresses" : [ "mailto:abuse@shakespeare.lit", "xmpp:abuse@shakespeare.lit" ], "admin-addresses" : [ "mailto:admin@shakespeare.lit", "xmpp:admin@shakespeare.lit" ], "feedback-addresses" : [ "http://shakespeare.lit/feedback.php", "mailto:feedback@shakespeare.lit", "xmpp:feedback@shakespeare.lit" ], "sales-addresses" : [ "xmpp:bard@shakespeare.lit" ], "security-addresses" : [ "xmpp:security@shakespeare.lit" ], "support-addresses" : [ "http://shakespeare.lit/support.php", "xmpp:support@shakespeare.lit" ] } } } }
author Kim Alvefur <zash@zash.se>
date Mon, 23 Mar 2020 19:03:04 +0100
parents 4d73a1a6ba68
children
line wrap: on
line source

---
labels:
- 'Stage-Stable'
summary: Server status plugin
...

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

This module fetches the current status of configured hosts and/or stanza
statistics from
[mod\_stanza\_counter](http://code.google.com/p/prosody-modules/wiki/mod_stanza_counter#).
And outputs it in either XML or JSON format.

Usage
=====

Copy the file into prosody's module directory and place it into your
global's enabled modules.

Configuration example:

    server_status_basepath = "/server-info/"
    server_status_show_hosts = { "iwanttoshowifthishostisonline.com", "iwanttoshowifthishostisonline2.com" }
    server_status_show_comps = { "muc.iwanttoshowifthishostisonline.com", "transport.iwanttoshowifthishostisonline.com" }
    server_status_json = true

By default the plugin's output is in XML, setting server\_status\_json
to "true" will turn it into JSON instead. if mod\_stanza\_counter isn't
loaded the plugin will require at least either
server\_status\_show\_hosts or server\_status\_show\_comps to be set.

Info
====

-   This is only compatible with 0.9 for older versions please look at
    the 0.8-diverge branch.