Mercurial > prosody-wiki

annotate mod_server_status.wiki @ 400:c5d049266555

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_auth_ldap: Document ldap_filter option
author Kim Alvefur <zash@zash.se>
date Mon, 09 Sep 2013 15:50:24 +0200
parents 7a597092e71f
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
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
7a597092e71f updated wikis.
Marco Cirillo <maranda@lightwitch.org>
parents: 256
diff changeset
2 #labels Stage-Stable
252
ec2b94f02b31 added wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
3
ec2b94f02b31 added wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
4 = Introduction =
ec2b94f02b31 added wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
5
253
97f27542295a corrected syntax.
Marco Cirillo <maranda@lightwitch.org>
parents: 252
diff changeset
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
ec2b94f02b31 added wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
8
ec2b94f02b31 added wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
9 = Usage =
ec2b94f02b31 added wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
10
ec2b94f02b31 added wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
11 Copy the file into prosody's module directory and place it into your global's enabled modules.
ec2b94f02b31 added wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
12
ec2b94f02b31 added wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
13 Configuration example:
ec2b94f02b31 added wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
14 {{{
277
7a597092e71f updated wikis.
Marco Cirillo <maranda@lightwitch.org>
parents: 256
diff changeset
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
ec2b94f02b31 added wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
19 }}}
ec2b94f02b31 added wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
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
ec2b94f02b31 added wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
23
277
7a597092e71f updated wikis.
Marco Cirillo <maranda@lightwitch.org>
parents: 256
diff changeset
24 = Info =
252
ec2b94f02b31 added wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
25
277
7a597092e71f updated wikis.
Marco Cirillo <maranda@lightwitch.org>
parents: 256
diff changeset
26 * This is only compatible with 0.9 for older versions please look at the 0.8-diverge branch.