prosody-modules
ecfd7aece33b
mod_nodeinfo2/README.markdown
Software / code / prosody-modules
File
mod_nodeinfo2/README.markdown @ 5691:ecfd7aece33b
mod_measure_modules: Report module statuses via OpenMetrics
Someone in the chat asked about a health check endpoint, which reminded
me of mod_http_status, which provides access to module statuses with
full details. After that, this idea came about, which seems natural.
As noted in the README, it could be used to monitor that critical
modules are in fact loaded correctly.
As more modules use the status API, the more useful this module and
mod_http_status becomes.
| author | Kim Alvefur <zash@zash.se> |
|---|---|
| date | Fri, 06 Oct 2023 18:34:39 +0200 |
| parent | 4595:bac3dae031ee |
| child | 5923:694b62d8a82f |
line wrap: on
line source
--- description: labels: 'Stage-Alpha' --- Introduction ============ This module exposes a [nodeinfo2](https://git.feneas.org/jaywink/nodeinfo2) .well-known URL for use e.g. from [the-federation.info](https://the-federation.info). Configuration ============= Enable the `nodeinfo` module in your global `modules_enabled` section: ``` modules_enabled = { ... "nodeinfo2" ... } ``` Set the `nodeinfo2_expose_users` option to false if you don’t want to expose statistics about the amount of users you host: ``` nodeinfo2_expose_users = false ``` Set the `nodeinfo2_expose_posts` option to false if you don’t want to expose statistics about the amount of messages being exchanged by your users: ``` nodeinfo2_expose_posts = false ``` This module depends on [mod\_lastlog](https://modules.prosody.im/mod_lastlog.html) to calculate user activity, and [mod\_http](https://prosody.im/doc/http). Most of its configuration actually happens in this dependency. Compatibility ============= ------- -------------------- trunk Does not work [^1] 0.11 Should work ------- -------------------- [^1]: not after [5f15ab7c6ae5](https://hg.prosody.im/trunk/rev/5f15ab7c6ae5)
