mod_stanza_counter/README.markdown

   1 ---
   2 labels:
   3 - 'Stage-Stable'
   4 summary: Simple incoming and outgoing stanza counter
   5 ...
   6
   7 Introduction
   8 ============
   9
  10 This module counts incoming and outgoing stanzas from when the instance
  11 started, and makes the data available to other modules by creating a
  12 global prosody. object
  13
  14 Details
  15 =======
  16
  17 The counter module is "stanza\_counter", the example output module is
  18 stanza\_counter\_http.
  19
  20 Usage
  21 =====
  22
  23 Copy both files into prosody's module directory and place 'em into your
  24 enabled modules (stanza\_counter\_http requires to be loaded into the
  25 global section!)
  26
  27 Config for stanza\_counter\_http:
  28
  29 ``` {.lua}
  30
  31 stanza_counter_basepath = "/counter-path-custom/"
  32 ```
  33
  34 Info
  35 ====
  36
  37 -   As of now to count components stanzas, it needs to be manually
  38     loaded (inserted into modules\_enabled of the components' sections)
  39     on these.
  40 -   This version isn't compatible with previous versions of prosody
  41     (looks at 0.8-diverge branch for olders).