Software /
code /
prosody-modules
Diff
mod_nodeinfo2/README.md @ 6003:fe081789f7b5
All community modules: Unify file extention of Markdown files to .md
author | Menel <menel@snikket.de> |
---|---|
date | Tue, 22 Oct 2024 10:26:01 +0200 |
parent | 5923:694b62d8a82f |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/mod_nodeinfo2/README.md Tue Oct 22 10:26:01 2024 +0200 @@ -0,0 +1,51 @@ +--- +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)