changeset 6355:77d565a6df4e

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 7bca4f5935d6
children a115f6a68d33
files mod_pubsub_serverinfo/README.md
diffstat 1 files changed, 21 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/mod_pubsub_serverinfo/README.md	Sat Jan 10 17:41:53 2026 +0100
+++ b/mod_pubsub_serverinfo/README.md	Wed Jan 14 13:59:01 2026 +0100
@@ -67,3 +67,24 @@
 The reported data does not contain the optional 'connection' child elements. These can be used to describe the direction of a connection.
 
 More generic server information (eg: user counts, software version) should be included in the data that is published.
+
+Common Configuration Issues
+===========================
+
+**Domain must be an admin of the PubSub service** 
+
+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:
+
+    admins = { "example.org" }
+
+**Module installation location** 
+
+`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.
+
+**Conditional dependency on `mod_measure_active_users`**
+
+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.
+
+**DNS records for the PubSub service**
+
+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.