annotate mod_stanza_counter.wiki @ 254:83603b9ad5dd

little more informative annotation on the configuration.
author maranda@lightwitch.org
date Sun, 08 Jan 2012 17:30:52 +0000
parents 97f27542295a
children b5563fb582aa
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
219
d71a16f557cb mod_stanza_counter: added wiki page.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
1 #summary Simple incoming and outgoing stanza counter
d71a16f557cb mod_stanza_counter: added wiki page.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
2 #labels Stage-Beta
d71a16f557cb mod_stanza_counter: added wiki page.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
3
d71a16f557cb mod_stanza_counter: added wiki page.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
4 = Introduction =
d71a16f557cb mod_stanza_counter: added wiki page.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
5
d71a16f557cb mod_stanza_counter: added wiki page.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
6 This module counts incoming and outgoing stanzas from when the instance started,
d71a16f557cb mod_stanza_counter: added wiki page.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
7 and makes the data available to other modules by creating a global prosody. object
d71a16f557cb mod_stanza_counter: added wiki page.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
8
d71a16f557cb mod_stanza_counter: added wiki page.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
9 = Details =
d71a16f557cb mod_stanza_counter: added wiki page.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
10
d71a16f557cb mod_stanza_counter: added wiki page.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
11 The counter module is "stanza_counter", the example output module is stanza_counter_http.
d71a16f557cb mod_stanza_counter: added wiki page.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
12
d71a16f557cb mod_stanza_counter: added wiki page.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
13 = Usage =
d71a16f557cb mod_stanza_counter: added wiki page.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
14
d71a16f557cb mod_stanza_counter: added wiki page.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
15 Copy both files into prosody's module directory and place 'em into your enabled modules (stanza_counter_http requires to be loaded into the global section!)
d71a16f557cb mod_stanza_counter: added wiki page.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
16
221
8c19cbb8a6be correction, tweak.
Marco Cirillo <maranda@lightwitch.org>
parents: 220
diff changeset
17 Optional parameters example for stanza_counter_http:
219
d71a16f557cb mod_stanza_counter: added wiki page.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
18 {{{
221
8c19cbb8a6be correction, tweak.
Marco Cirillo <maranda@lightwitch.org>
parents: 220
diff changeset
19 stanza_counter_http_ports = {{ port = 5280, path = "mycounterpath" }}
219
d71a16f557cb mod_stanza_counter: added wiki page.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
20 }}}
d71a16f557cb mod_stanza_counter: added wiki page.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
21
253
97f27542295a corrected syntax.
Marco Cirillo <maranda@lightwitch.org>
parents: 221
diff changeset
22 stanza_counter_http_ports uses prosody's bosh ports format, [http://prosody.im/doc/setting_up_bosh# see here].
221
8c19cbb8a6be correction, tweak.
Marco Cirillo <maranda@lightwitch.org>
parents: 220
diff changeset
23
219
d71a16f557cb mod_stanza_counter: added wiki page.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
24 = Compatibility =
d71a16f557cb mod_stanza_counter: added wiki page.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
25
d71a16f557cb mod_stanza_counter: added wiki page.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
26 * 0.8 works
d71a16f557cb mod_stanza_counter: added wiki page.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
27 * 0.7 should work
d71a16f557cb mod_stanza_counter: added wiki page.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
28 * 0.6 won't work
d71a16f557cb mod_stanza_counter: added wiki page.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
29 * 0.5 won't work