Mercurial > prosody-modules
view mod_server_status/README.markdown @ 5907: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 |
| parents | 4d73a1a6ba68 |
| children |
line wrap: on
line source
--- labels: - 'Stage-Stable' summary: Server status plugin ... Introduction ============ This module fetches the current status of configured hosts and/or stanza statistics from [mod\_stanza\_counter](http://code.google.com/p/prosody-modules/wiki/mod_stanza_counter#). And outputs it in either XML or JSON format. Usage ===== Copy the file into prosody's module directory and place it into your global's enabled modules. Configuration example: server_status_basepath = "/server-info/" server_status_show_hosts = { "iwanttoshowifthishostisonline.com", "iwanttoshowifthishostisonline2.com" } server_status_show_comps = { "muc.iwanttoshowifthishostisonline.com", "transport.iwanttoshowifthishostisonline.com" } server_status_json = true By default the plugin's output is in XML, setting server\_status\_json to "true" will turn it into JSON instead. if mod\_stanza\_counter isn't loaded the plugin will require at least either server\_status\_show\_hosts or server\_status\_show\_comps to be set. Info ==== - This is only compatible with 0.9 for older versions please look at the 0.8-diverge branch.