Clarify semantics of vhost/vhostv6

progval · Dec 14, 2024 · 7386ea6 · 7386ea6
1 parent 941d312
commit 7386ea6
Showing 1 changed file with 18 additions and 4 deletions.
diff --git a/src/conf.py b/src/conf.py
@@ -422,11 +422,17 @@ def registerNetwork(name, password='', ssl=True, sasl_username='',
     registerGlobalValue(network, 'vhost',
         registry.String('', _("""Determines what vhost the bot will bind to before
         connecting a server (IRC, HTTP, ...) via IPv4. If empty, defaults to
-        supybot.protocols.irc.vhost""")))
+        supybot.protocols.irc.vhost. It must be (or resolve to) an IP address
+        assigned to one of the network interfaces (see 'ip addr' on Linux).
+        This may differ from the hostname visible on IRC, which is based on the
+        outgoing IP address or the reverse-DNS of that IP address.""")))
     registerGlobalValue(network, 'vhostv6',
         registry.String('', _("""Determines what vhost the bot will bind to before
         connecting a server (IRC, HTTP, ...) via IPv6. If empty, defaults to
-        supybot.protocols.irc.vhostv6""")))
+        supybot.protocols.irc.vhostv6. It must be (or resolve to) an IP address
+        assigned to one of the network interfaces (see 'ip addr' on Linux).
+        This may differ from the hostname visible on IRC, which is based on the
+        outgoing IP address or the reverse-DNS of that IP address.""")))
 
     sasl = registerGroup(network, 'sasl')
     registerGlobalValue(sasl, 'username', registry.String(sasl_username,
@@ -1363,11 +1369,19 @@ def makeExtBanmasks(self, hostmask, options=None, channel=None, *, network):
 
 registerGlobalValue(supybot.protocols.irc, 'vhost',
     registry.String('', _("""Determines what vhost the bot will bind to before
-    connecting a server (IRC, HTTP, ...) via IPv4.""")))
+    connecting a server (IRC, HTTP, ...) via IPv4. It must be (or resolve to)
+    an IP address assigned to one of the network interfaces (see 'ip addr' on
+    Linux).
+    This may differ from the hostname visible on IRC, which is based on the
+    outgoing IP address or the reverse-DNS of that IP address.""")))
 
 registerGlobalValue(supybot.protocols.irc, 'vhostv6',
     registry.String('', _("""Determines what vhost the bot will bind to before
-    connecting a server (IRC, HTTP, ...) via IPv6.""")))
+    connecting a server (IRC, HTTP, ...) via IPv6. It must be (or resolve to)
+    an IP address assigned to one of the network interfaces (see 'ip -6 addr' on
+    Linux).
+    This may differ from the hostname visible on IRC, which is based on the
+    outgoing IP address or the reverse-DNS of that IP address.""")))
 
 registerGlobalValue(supybot.protocols.irc, 'maxHistoryLength',
     registry.Integer(1000, _("""Determines how many old messages the bot will