Mercurial > prosody-modules

comparison mod_nodeinfo2/README.md @ 5975:fe081789f7b5

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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
parents mod_nodeinfo2/README.markdown@694b62d8a82f
children
comparison
equal deleted inserted replaced
5974:5a65a632d5b9 5975:fe081789f7b5
1 ---
2 labels:
3 - Stage-Alpha
4 ---
5
6 Introduction
7 ============
8
9 This module exposes a [nodeinfo2](https://git.feneas.org/jaywink/nodeinfo2)
10 .well-known URL for use e.g. from
11 [the-federation.info](https://the-federation.info).
12
13 Configuration
14 =============
15
16 Enable the `nodeinfo` module in your global `modules_enabled` section:
17 ```
18 modules_enabled = {
19 ...
20 "nodeinfo2"
21 ...
22 }
23 ```
24
25 Set the `nodeinfo2_expose_users` option to false if you don’t want to expose
26 statistics about the amount of users you host:
27 ```
28 nodeinfo2_expose_users = false
29 ```
30
31 Set the `nodeinfo2_expose_posts` option to false if you don’t want to expose
32 statistics about the amount of messages being exchanged by your users:
33 ```
34 nodeinfo2_expose_posts = false
35 ```
36
37 This module depends on
38 [mod\_lastlog](https://modules.prosody.im/mod_lastlog.html) to calculate user
39 activity, and [mod\_http](https://prosody.im/doc/http). Most of its
40 configuration actually happens in this dependency.
41
42 Compatibility
43 =============
44
45 ------- --------------------
46 trunk Does not work [^1]
47 0.11 Should work
48 ------- --------------------
49
50 [^1]: not after
51 [5f15ab7c6ae5](https://hg.prosody.im/trunk/rev/5f15ab7c6ae5)