comparison mod_server_status.wiki @ 255:3bd927d2ac33

renamed mod_xml_status to mod_server_status, changing wiki to reflect that.
author Marco Cirillo <maranda@lightwitch.org>
date Tue, 10 Jan 2012 19:43:51 +0000
parents mod_xml_status.wiki@97f27542295a
children c44f0864b33c
comparison
equal deleted inserted replaced
254:83603b9ad5dd 255:3bd927d2ac33
1 #summary Server status plugin
2 #labels Stage-Beta
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_http_ports = {{ port = 5280, path = "mystatsbasepath" }}
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 = Compatibility =
25
26 * 0.8+ Works.