mod_nodeinfo2/README.markdown
author Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
Sun, 29 Dec 2019 22:09:58 +0100
changeset 3789 6273705e3830
child 3793 e3b673df3906
permissions -rw-r--r--
mod_nodeinfo2: Add a README
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
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
6273705e3830 mod_nodeinfo2: Add a README
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
    25
This module depends on [mod\_http](https://prosody.im/doc/http), all of its
6273705e3830 mod_nodeinfo2: Add a README
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
    26
configuration actually happens in this module.
6273705e3830 mod_nodeinfo2: Add a README
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
    27
6273705e3830 mod_nodeinfo2: Add a README
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
    28
Compatibility
6273705e3830 mod_nodeinfo2: Add a README
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
    29
=============
6273705e3830 mod_nodeinfo2: Add a README
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
    30
6273705e3830 mod_nodeinfo2: Add a README
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
    31
  ----- -----------
6273705e3830 mod_nodeinfo2: Add a README
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
    32
  trunk Works
6273705e3830 mod_nodeinfo2: Add a README
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
    33
  0.11  Should work
6273705e3830 mod_nodeinfo2: Add a README
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
    34
  ----- -----------