annotate mod_pubsub_stats/README.markdown @ 3291:4c3230c22c18

mod_register_json: Update README
author Matthew Wild <mwild1@gmail.com>
date Wed, 29 Aug 2018 21:57:59 +0100
parents 50618747e00e
children 1900280e2a90
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3156
50618747e00e mod_pubsub_stats: Add a brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
1 This module publishes data from internal statistics into a PubSub node
50618747e00e mod_pubsub_stats: Add a brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
2 in [XEP-0039] format.
50618747e00e mod_pubsub_stats: Add a brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
3
50618747e00e mod_pubsub_stats: Add a brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
4 The node defaults to `stats` but can be changed with the option
50618747e00e mod_pubsub_stats: Add a brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
5 `pubsub_stats_node`.
50618747e00e mod_pubsub_stats: Add a brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
6
50618747e00e mod_pubsub_stats: Add a brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
7 ``` lua
50618747e00e mod_pubsub_stats: Add a brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
8 Component "pubsub.example.com" "pubsub"
50618747e00e mod_pubsub_stats: Add a brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
9 modules_enabled = {
50618747e00e mod_pubsub_stats: Add a brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
10 "pubsub_stats";
50618747e00e mod_pubsub_stats: Add a brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
11 }
50618747e00e mod_pubsub_stats: Add a brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
12 pubsub_stats_node = "statistics"
50618747e00e mod_pubsub_stats: Add a brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
13 ```