annotate mod_xml_status.wiki @ 252:ec2b94f02b31

added wiki.
author Marco Cirillo <maranda@lightwitch.org>
date Fri, 06 Jan 2012 23:29:04 +0000
parents
children 97f27542295a
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
252
ec2b94f02b31 added wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
1 #summary XML server status plugin
ec2b94f02b31 added wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
2 #labels Stage-Beta
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
ec2b94f02b31 added wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
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].
ec2b94f02b31 added wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
7
ec2b94f02b31 added wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
8 = Usage =
ec2b94f02b31 added wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
9
ec2b94f02b31 added wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
10 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
11
ec2b94f02b31 added wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
12 Configuration example:
ec2b94f02b31 added wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
13 {{{
ec2b94f02b31 added wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
14 xml_status_http_ports = {{ port = 5280, path = "mystatsbasepath" }}
ec2b94f02b31 added wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
15 xml_status_show_hosts = { "iwanttoshowifthishostisonline.com", "iwanttoshowifthishostisonline2.com" }
ec2b94f02b31 added wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
16 xml_status_show_comps = { "muc.iwanttoshowifthishostisonline.com", "transport.iwanttoshowifthishostisonline.com" }
ec2b94f02b31 added wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
17 }}}
ec2b94f02b31 added wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
18
ec2b94f02b31 added wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
19 if mod_stanza_counter isn't loaded the plugin will require at least either xml_status_show_hosts or xml_status_show_comps to be set
ec2b94f02b31 added wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
20
ec2b94f02b31 added wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
21 = Compatibility =
ec2b94f02b31 added wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
22
ec2b94f02b31 added wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
23 * 0.8+ Works.