Mercurial > prosody-modules

comparison mod_pubsub_serverinfo/README.md @ 6355:77d565a6df4e

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_pubsub_serverinfo: add 'common configuration issues' to readme
author Guus der Kinderen <guus.der.kinderen@gmail.com>
date Wed, 14 Jan 2026 13:59:01 +0100
parents 25b091cbb471
children 1d48c75c8200
comparison
equal deleted inserted replaced
6354:7bca4f5935d6 6355:77d565a6df4e
65 ==================== 65 ====================
66 66
67 The reported data does not contain the optional 'connection' child elements. These can be used to describe the direction of a connection. 67 The reported data does not contain the optional 'connection' child elements. These can be used to describe the direction of a connection.
68 68
69 More generic server information (eg: user counts, software version) should be included in the data that is published. 69 More generic server information (eg: user counts, software version) should be included in the data that is published.
70
71 Common Configuration Issues
72 ===========================
73
74 **Domain must be an admin of the PubSub service**
75
76 The XMPP domain itself (for example, `example.org`) must be an admin of the PubSub service. Many users mistakenly assume a user JID (e.g., `admin@example.org`) should be an admin. Configure the PubSub module to accept the global domain as an admin:
77
78 admins = { "example.org" }
79
80 **Module installation location**
81
82 `mod_pubsub_serverinfo` must be enabled globally or within a virtual host, **not inside the PubSub component**. You are instructing the global domain to publish data to the PubSub service, not extending the PubSub service itself.
83
84 **Conditional dependency on `mod_measure_active_users`**
85
86 Publishing user counts requires `mod_measure_active_users`. This module will be loaded automatically if user count publication is enabled, but it must be installed on the system for this to succeed.
87
88 **DNS records for the PubSub service**
89
90 External servers must be able to connect to the PubSub service. Ensure the hostname of the PubSub service has appropriate A/AAAA and SRV records so remote servers can discover and reach the service.