Software / code / prosody-modules
Annotate
mod_pubsub_stats/README.markdown @ 5931:d194d1012fd3
Updating dox for mod_rest. Ideas expressed / clarified:
1) Making clear that mod_rest isn't to be installed under VirtualHosts AND as a component.
2) Understanding some of the implications of this choice:
A) Changes to user authentication
B) How it affects subdomains
3) More consistent use of domain names for clarity.
4) Using different heading sizes to show scope of section.
Essentially, I added all the tidbits I had to clarify in getting this to work in my
own example.
| author | Ben Smith <bens@effortlessis.com> |
|---|---|
| date | Mon, 13 May 2024 13:25:13 -0700 |
| parent | 4451:f1a63271dcfc |
| rev | line source |
|---|---|
|
4451
f1a63271dcfc
Add tag 'Statistics' to some modules to ease discoverability
Kim Alvefur <zash@zash.se>
parents:
3409
diff
changeset
|
1 --- |
|
f1a63271dcfc
Add tag 'Statistics' to some modules to ease discoverability
Kim Alvefur <zash@zash.se>
parents:
3409
diff
changeset
|
2 labels: |
|
f1a63271dcfc
Add tag 'Statistics' to some modules to ease discoverability
Kim Alvefur <zash@zash.se>
parents:
3409
diff
changeset
|
3 - 'Statistics' |
|
f1a63271dcfc
Add tag 'Statistics' to some modules to ease discoverability
Kim Alvefur <zash@zash.se>
parents:
3409
diff
changeset
|
4 ... |
|
f1a63271dcfc
Add tag 'Statistics' to some modules to ease discoverability
Kim Alvefur <zash@zash.se>
parents:
3409
diff
changeset
|
5 |
|
3409
1900280e2a90
mod_pubsub_stats/README: Link to docs for Prosodys statistics
Kim Alvefur <zash@zash.se>
parents:
3156
diff
changeset
|
6 This module publishes data from [Prosody's `internal` statistics][doc:statistics] |
|
1900280e2a90
mod_pubsub_stats/README: Link to docs for Prosodys statistics
Kim Alvefur <zash@zash.se>
parents:
3156
diff
changeset
|
7 into a PubSub node in [XEP-0039] format. |
|
3156
50618747e00e
mod_pubsub_stats: Add a brief README
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
8 |
|
50618747e00e
mod_pubsub_stats: Add a brief README
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
9 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
|
10 `pubsub_stats_node`. |
|
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 ``` lua |
|
50618747e00e
mod_pubsub_stats: Add a brief README
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
13 Component "pubsub.example.com" "pubsub" |
|
50618747e00e
mod_pubsub_stats: Add a brief README
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
14 modules_enabled = { |
|
50618747e00e
mod_pubsub_stats: Add a brief README
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
15 "pubsub_stats"; |
|
50618747e00e
mod_pubsub_stats: Add a brief README
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
16 } |
|
50618747e00e
mod_pubsub_stats: Add a brief README
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
17 pubsub_stats_node = "statistics" |
|
50618747e00e
mod_pubsub_stats: Add a brief README
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
18 ``` |
