Comparison

mod_server_status/README.wiki @ 1782:29f3d6b7ad16

Import wiki pages
author Kim Alvefur <zash@zash.se>
date Mon, 24 Aug 2015 16:43:56 +0200
comparison
equal deleted inserted replaced
1781:12ac88940fe3 1782:29f3d6b7ad16
1 #summary Server status plugin
2 #labels Stage-Stable
3
4 = Introduction =
5
6 This module fetches the current status of configured hosts and/or stanza statistics from [http://code.google.com/p/prosody-modules/wiki/mod_stanza_counter# mod_stanza_counter].
7 And outputs it in either XML or JSON format.
8
9 = Usage =
10
11 Copy the file into prosody's module directory and place it into your global's enabled modules.
12
13 Configuration example:
14 {{{
15 server_status_basepath = "/server-info/"
16 server_status_show_hosts = { "iwanttoshowifthishostisonline.com", "iwanttoshowifthishostisonline2.com" }
17 server_status_show_comps = { "muc.iwanttoshowifthishostisonline.com", "transport.iwanttoshowifthishostisonline.com" }
18 server_status_json = true
19 }}}
20
21 By default the plugin's output is in XML, setting server_status_json to "true" will turn it into JSON instead.
22 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.
23
24 = Info =
25
26 * This is only compatible with 0.9 for older versions please look at the 0.8-diverge branch.