prosody-modules
f55e65315ba0
mod_pubsub_serverinfo/README.markdown

Find changesets by keywords by author, files, the commit message, revision number or hash, or revset expression.

Software / code / prosody-modules

Comparison

mod_pubsub_serverinfo/README.markdown @ 5826:f55e65315ba0

mod_pubsub_serverinfo: implemented all basic features This commit replaces the earlier proof-of-concept to a solution that: - reports on remotely-connected domains - uses disco/info to detect if those domains opt-in - publishes domain names for remote domains that do so - caches the disco/info response
author Guus der Kinderen <guus.der.kinderen@gmail.com>
date Wed, 03 Jan 2024 23:05:14 +0100
parent 5824:73887dcb2129
child 5828:55b99f593c3a
comparison
equal deleted inserted replaced
5825:f6a2602129c8 5826:f55e65315ba0
3 - 'Statistics' 3 - 'Statistics'
4 ... 4 ...
5 5
6 Exposes server information over Pub/Sub per ProtoXEP: PubSub Server Information. 6 Exposes server information over Pub/Sub per ProtoXEP: PubSub Server Information.
7 7
8 This initial version only announces support (used to 'opt-in', per the XEP). It does not publish any data. This is intended to be a future addition to this mod. 8 This version, announces support (used to 'opt-in', per the XEP) and publishes the name of the local domain via a Pub/Sub node. The published data
9 will contain an unnamed 'remote-domain' element for each inbound or outgoing s2s connection.
10
11 Features yet to be implemented:
12 - For 'remote-domain' elements, add domain name _only if_ through service discovery that domain advertises the 'urn:xmpp:serverinfo:0' feature.
13
14 Installation
15 ============
16
17 Enable this module in the global or a virtual host.
18
19 The default configuration requires the existence of a Pub/Sub component that uses the 'pubsub' subdomain of the host in which the module is enabled:
20
21 Component "pubsub.example.org" "pubsub"
22
23 The module will create a node and publish data, using a JID that matches the XMPP domain name of the host. Ensure that this actor is an admin of the
24 Pub/Sub service:
25
26 admins = { "example.org" }
27
28 Configuration
29 =============
30
31 The Pub/Sub service on which data is published, by default, is a component addressed as the `pubsub` subdomain of the domain of the virtual host that
32 the module is loaded under. To change this, apply this configuration setting:
33
34 pubsub_serverinfo_service = "anotherpubsub.example.org"
35
36 The Pub/Sub node on which data is published is, by default, a leaf-node named `serverinfo`. To change this, apply this configuration setting:
37
38 pubsub_serverinfo_node = "foobar"
39
40 To prevent a surplus of event notifications, this module will only publish new data after a certain period of time has expired. The default duration
41 is 300 seconds (5 minutes). To change this simply put in the config:
42
43 pubsub_serverinfo_publication_interval = 180 -- or any other number of seconds