author | Kim Alvefur <zash@zash.se> |
Wed, 03 Mar 2021 11:43:38 +0100 | |
changeset 4494 | cf2bdb2aaa57 |
parent 3834 | 63d8072dc864 |
child 4599 | bac3dae031ee |
permissions | -rw-r--r-- |
3789
6273705e3830
mod_nodeinfo2: Add a README
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff
changeset
|
1 |
--- |
6273705e3830
mod_nodeinfo2: Add a README
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff
changeset
|
2 |
description: |
6273705e3830
mod_nodeinfo2: Add a README
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff
changeset
|
3 |
labels: 'Stage-Alpha' |
6273705e3830
mod_nodeinfo2: Add a README
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff
changeset
|
4 |
--- |
6273705e3830
mod_nodeinfo2: Add a README
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff
changeset
|
5 |
|
6273705e3830
mod_nodeinfo2: Add a README
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff
changeset
|
6 |
Introduction |
6273705e3830
mod_nodeinfo2: Add a README
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff
changeset
|
7 |
============ |
6273705e3830
mod_nodeinfo2: Add a README
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff
changeset
|
8 |
|
6273705e3830
mod_nodeinfo2: Add a README
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff
changeset
|
9 |
This module exposes a [nodeinfo2](https://git.feneas.org/jaywink/nodeinfo2) |
6273705e3830
mod_nodeinfo2: Add a README
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff
changeset
|
10 |
.well-known URL for use e.g. from |
6273705e3830
mod_nodeinfo2: Add a README
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff
changeset
|
11 |
[the-federation.info](https://the-federation.info). |
6273705e3830
mod_nodeinfo2: Add a README
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff
changeset
|
12 |
|
6273705e3830
mod_nodeinfo2: Add a README
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff
changeset
|
13 |
Configuration |
6273705e3830
mod_nodeinfo2: Add a README
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff
changeset
|
14 |
============= |
6273705e3830
mod_nodeinfo2: Add a README
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff
changeset
|
15 |
|
6273705e3830
mod_nodeinfo2: Add a README
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff
changeset
|
16 |
Enable the `nodeinfo` module in your global `modules_enabled` section: |
6273705e3830
mod_nodeinfo2: Add a README
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff
changeset
|
17 |
``` |
6273705e3830
mod_nodeinfo2: Add a README
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff
changeset
|
18 |
modules_enabled = { |
6273705e3830
mod_nodeinfo2: Add a README
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff
changeset
|
19 |
... |
6273705e3830
mod_nodeinfo2: Add a README
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff
changeset
|
20 |
"nodeinfo2" |
6273705e3830
mod_nodeinfo2: Add a README
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff
changeset
|
21 |
... |
6273705e3830
mod_nodeinfo2: Add a README
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff
changeset
|
22 |
} |
6273705e3830
mod_nodeinfo2: Add a README
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff
changeset
|
23 |
``` |
6273705e3830
mod_nodeinfo2: Add a README
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff
changeset
|
24 |
|
3796
aec772bbd558
mod_nodeinfo2: Only expose amount of accounts if nodeinfo2_expose_users isn’t set to false
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
3793
diff
changeset
|
25 |
Set the `nodeinfo2_expose_users` option to false if you don’t want to expose |
aec772bbd558
mod_nodeinfo2: Only expose amount of accounts if nodeinfo2_expose_users isn’t set to false
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
3793
diff
changeset
|
26 |
statistics about the amount of users you host: |
aec772bbd558
mod_nodeinfo2: Only expose amount of accounts if nodeinfo2_expose_users isn’t set to false
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
3793
diff
changeset
|
27 |
``` |
aec772bbd558
mod_nodeinfo2: Only expose amount of accounts if nodeinfo2_expose_users isn’t set to false
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
3793
diff
changeset
|
28 |
nodeinfo2_expose_users = false |
aec772bbd558
mod_nodeinfo2: Only expose amount of accounts if nodeinfo2_expose_users isn’t set to false
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
3793
diff
changeset
|
29 |
``` |
aec772bbd558
mod_nodeinfo2: Only expose amount of accounts if nodeinfo2_expose_users isn’t set to false
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
3793
diff
changeset
|
30 |
|
3793
e3b673df3906
mod_nodeinfo2: Only expose message stats if nodeinfo2_expose_posts isn’t set to false
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
3789
diff
changeset
|
31 |
Set the `nodeinfo2_expose_posts` option to false if you don’t want to expose |
e3b673df3906
mod_nodeinfo2: Only expose message stats if nodeinfo2_expose_posts isn’t set to false
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
3789
diff
changeset
|
32 |
statistics about the amount of messages being exchanged by your users: |
e3b673df3906
mod_nodeinfo2: Only expose message stats if nodeinfo2_expose_posts isn’t set to false
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
3789
diff
changeset
|
33 |
``` |
e3b673df3906
mod_nodeinfo2: Only expose message stats if nodeinfo2_expose_posts isn’t set to false
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
3789
diff
changeset
|
34 |
nodeinfo2_expose_posts = false |
e3b673df3906
mod_nodeinfo2: Only expose message stats if nodeinfo2_expose_posts isn’t set to false
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
3789
diff
changeset
|
35 |
``` |
e3b673df3906
mod_nodeinfo2: Only expose message stats if nodeinfo2_expose_posts isn’t set to false
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
3789
diff
changeset
|
36 |
|
3834
63d8072dc864
mod_nodeinfo2: Mention mod_lastlog as a dep in the README
Maxime “pep” Buquet <pep@bouah.net>
parents:
3796
diff
changeset
|
37 |
This module depends on |
63d8072dc864
mod_nodeinfo2: Mention mod_lastlog as a dep in the README
Maxime “pep” Buquet <pep@bouah.net>
parents:
3796
diff
changeset
|
38 |
[mod\_lastlog](https://modules.prosody.im/mod_lastlog.html) to calculate user |
63d8072dc864
mod_nodeinfo2: Mention mod_lastlog as a dep in the README
Maxime “pep” Buquet <pep@bouah.net>
parents:
3796
diff
changeset
|
39 |
activity, and [mod\_http](https://prosody.im/doc/http). Most of its |
63d8072dc864
mod_nodeinfo2: Mention mod_lastlog as a dep in the README
Maxime “pep” Buquet <pep@bouah.net>
parents:
3796
diff
changeset
|
40 |
configuration actually happens in this dependency. |
3789
6273705e3830
mod_nodeinfo2: Add a README
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff
changeset
|
41 |
|
6273705e3830
mod_nodeinfo2: Add a README
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff
changeset
|
42 |
Compatibility |
6273705e3830
mod_nodeinfo2: Add a README
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff
changeset
|
43 |
============= |
6273705e3830
mod_nodeinfo2: Add a README
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff
changeset
|
44 |
|
6273705e3830
mod_nodeinfo2: Add a README
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff
changeset
|
45 |
----- ----------- |
6273705e3830
mod_nodeinfo2: Add a README
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff
changeset
|
46 |
trunk Works |
6273705e3830
mod_nodeinfo2: Add a README
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff
changeset
|
47 |
0.11 Should work |
6273705e3830
mod_nodeinfo2: Add a README
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff
changeset
|
48 |
----- ----------- |