Mercurial > prosody-modules
view mod_nodeinfo2/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 | 694b62d8a82f |
children |
line wrap: on
line source
--- 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)