Allow specification of DNS vhost and server in ircd.conf.

[ircu2.10.12-pk.git] / doc / example.conf

diff --git a/doc/example.conf b/doc/example.conf
index cbb4d7e4539d4353cd3b9a299cfc3a11776f4397..5e20dcb98cb365aee0f562684c2c26666c414035 100644 (file)
--- a/doc/example.conf
+++ b/doc/example.conf
@@ -56,6 +56,10 @@
 #         vhost = "ipv6vhost";
 #         description = "description";
 #         numeric = numericnumber;
+#         dns vhost = "ipv4vhost";
+#         dns vhost = "ipv6vhost";
+#         dns server = "ipaddress";
+#         dns server = "ipaddress2";
 # };
 #
 # If present, <virtual host> must contain a valid address in dotted
@@ -71,6 +75,15 @@
 #
 # Note that <server numeric> has to be unique on the network your server
 # is running on, must be between 0 and 4095, and is not updated on a rehash.
+#
+# The two DNS lines allow you to specify the local IP address to use
+# for DNS lookups ("dns vhost") and one or more DNS server addresses
+# to use.  If the vhost is ambiguous for some reason, you may list
+# IPV4 and/or IPV6 between the equals sign and the address string.
+# The default DNS vhost is to let the operating system assign the
+# address, and the default DNS servers are read from /etc/resolv.conf.
+# In most cases, you do not need to specify either the dns vhost or
+# the dns server.
 General {
          name = "London.UK.Eu.UnderNet.org";
          description = "University of London, England";
@@ -237,7 +250,7 @@ Class {
 # Kill block".
 # Client {
 #  host = "user@host";
-#  ip = "ip@host";
+#  ip = "user@ip";
 #  password = "password";
 #  class = "classname";
 # };
@@ -650,16 +663,20 @@ Operator {
 # so we don't do that.
 #
 # Port {
-#  port = number;
+#  port = [ipv4] [ipv6] number;
 #  mask = "ipmask";
 #  # Use this to control the interface you bind to.
-#  vhost = "virtualhostip";
+#  vhost = [ipv4] [ipv6] "virtualhostip";
 #  # Setting to yes makes this server only.
 #  server = yes;
 #  # Setting to yes makes the port "hidden" from stats.
 #  hidden = yes;
 # };
 #
+# The port and vhost lines allow you to specify one or both of "ipv4"
+# and "ipv6" as address families to use for the port.  The default is
+# to listen on both IPv4 and IPv6.
+#
 # The mask setting allows you to specify a range of IP addresses that
 # you will allow connections from. This should only contain IP addresses
 # and '*' if used. This field only uses IP addresses. This does not use
@@ -679,11 +696,11 @@ Port {
  port = 4400;
 };
 
-# This is a Server port that is Hidden
+# This is an IPv4-only Server port that is Hidden
 Port {
  server = yes;
  hidden = yes;
- port = 4401;
+ port = ipv4 4401;
 };
 
 # The following are normal client ports
@@ -862,6 +879,7 @@ features
 #  "HIS_SERVERNAME" = "*.undernet.org";
 #  "HIS_SERVERINFO" = "The Undernet Underworld";
 #  "HIS_URLSERVERS" = "http://www.undernet.org/servers.php";
+#  "URLREG" = "http://cservice.undernet.org/live/";
 };
 
 # Well, you have now reached the end of this sample configuration