mod_server_status/README.markdown

   1 ---
   2 labels:
   3 - 'Stage-Stable'
   4 summary: Server status plugin
   5 ...
   6
   7 Introduction
   8 ============
   9
  10 This module fetches the current status of configured hosts and/or stanza
  11 statistics from
  12 [mod\_stanza\_counter](http://code.google.com/p/prosody-modules/wiki/mod_stanza_counter#).
  13 And outputs it in either XML or JSON format.
  14
  15 Usage
  16 =====
  17
  18 Copy the file into prosody's module directory and place it into your
  19 global's enabled modules.
  20
  21 Configuration example:
  22
  23     server_status_basepath = "/server-info/"
  24     server_status_show_hosts = { "iwanttoshowifthishostisonline.com", "iwanttoshowifthishostisonline2.com" }
  25     server_status_show_comps = { "muc.iwanttoshowifthishostisonline.com", "transport.iwanttoshowifthishostisonline.com" }
  26     server_status_json = true
  27
  28 By default the plugin's output is in XML, setting server\_status\_json
  29 to "true" will turn it into JSON instead. if mod\_stanza\_counter isn't
  30 loaded the plugin will require at least either
  31 server\_status\_show\_hosts or server\_status\_show\_comps to be set.
  32
  33 Info
  34 ====
  35
  36 -   This is only compatible with 0.9 for older versions please look at
  37     the 0.8-diverge branch.