Mercurial > prosody-wiki
annotate mod_server_status.wiki @ 335:225827f3940e
Created wiki page through web user interface. Phew.
author | MWild1@gmail.com |
---|---|
date | Fri, 05 Apr 2013 12:00:12 +0000 |
parents | 7a597092e71f |
children |
rev | line source |
---|---|
255
3bd927d2ac33
renamed mod_xml_status to mod_server_status, changing wiki to reflect that.
Marco Cirillo <maranda@lightwitch.org>
parents:
253
diff
changeset
|
1 #summary Server status plugin |
277 | 2 #labels Stage-Stable |
252 | 3 |
4 = Introduction = | |
5 | |
253 | 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]. |
255
3bd927d2ac33
renamed mod_xml_status to mod_server_status, changing wiki to reflect that.
Marco Cirillo <maranda@lightwitch.org>
parents:
253
diff
changeset
|
7 And outputs it in either XML or JSON format. |
252 | 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 {{{ | |
277 | 15 server_status_basepath = "/server-info/" |
255
3bd927d2ac33
renamed mod_xml_status to mod_server_status, changing wiki to reflect that.
Marco Cirillo <maranda@lightwitch.org>
parents:
253
diff
changeset
|
16 server_status_show_hosts = { "iwanttoshowifthishostisonline.com", "iwanttoshowifthishostisonline2.com" } |
3bd927d2ac33
renamed mod_xml_status to mod_server_status, changing wiki to reflect that.
Marco Cirillo <maranda@lightwitch.org>
parents:
253
diff
changeset
|
17 server_status_show_comps = { "muc.iwanttoshowifthishostisonline.com", "transport.iwanttoshowifthishostisonline.com" } |
3bd927d2ac33
renamed mod_xml_status to mod_server_status, changing wiki to reflect that.
Marco Cirillo <maranda@lightwitch.org>
parents:
253
diff
changeset
|
18 server_status_json = true |
252 | 19 }}} |
20 | |
255
3bd927d2ac33
renamed mod_xml_status to mod_server_status, changing wiki to reflect that.
Marco Cirillo <maranda@lightwitch.org>
parents:
253
diff
changeset
|
21 By default the plugin's output is in XML, setting server_status_json to "true" will turn it into JSON instead. |
3bd927d2ac33
renamed mod_xml_status to mod_server_status, changing wiki to reflect that.
Marco Cirillo <maranda@lightwitch.org>
parents:
253
diff
changeset
|
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. |
252 | 23 |
277 | 24 = Info = |
252 | 25 |
277 | 26 * This is only compatible with 0.9 for older versions please look at the 0.8-diverge branch. |