Improve support for IPv4 vs IPv6 virtual hosts (fixes SF bugs #1087699, #1087668).
[ircu2.10.12-pk.git] / doc / example.conf
index e5073920df2dd841eeeaa36f8ce953d83be53775..bbd61b9f102d0cb1f52fa23034a4aed7bee0bbf9 100644 (file)
 # First some information about the server.
 # General {
 #         name = "servername";
-#         vhost = "virtualhost";
+#         vhost = "ipv4vhost";
+#         vhost = "ipv6vhost";
 #         description = "description";
 #         numeric = numericnumber;
 # };
 #
-# <virtual host> must contain either a * or a valid IPv4 address in
-# dotted quad notation. (127.0.0.1) The address MUST be the address
-# of a physical interface on the host. This address is used for outgoing
-# connections only, see Port{} for listener virtual hosting.
-# If in doubt put a * or the IP of your primary interface here.
-# The server must be compiled with virtual hosting turned on to get this
-# to work correctly.
+# If present, <virtual host> must contain a valid address in dotted
+# quad or IPv6 numeric notation (127.0.0.1 or ::1).  The address MUST
+# be the address of a physical interface on the host.  This address is
+# used for outgoing connections if the Connect{} block does not
+# override it.  See Port{} for listener virtual hosting.  If in doubt,
+# leave it out.
+#
+# You may specify both an IPv4 virtual host and an IPv6 virtual host,
+# to indicate which address should be used for outbound connections
+# of the respective type.
 #
 # 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.
@@ -101,20 +105,14 @@ Admin {
 #  usermode = "+i";
 # };
 #
+# maxlinks should be set at either 0 or 1.
+#
 # <connect freq> applies only to servers, and specifies the frequency 
 # that the server tries to autoconnect. setting this to 0 will cause
 # the server to attempt to connect repeatedly with no delay until the 
 # <maximum links> condition is satisfied. This is a Bad Thing(tm).
 # Note that times can be specified as a number, or by giving something
 # like: 1 minutes 20 seconds, or 1*60+20.
-# Client {
-#  host = "user@host";
-#  ip = "ip@host";
-#  password = "password";
-#  class = "classname";
-# };
-#
-# <maximum links> should be set at either 0 or 1.
 #
 # Recommended server classes:
 # All your server uplinks you are not a hub for.
@@ -134,6 +132,23 @@ Class {
  sendq = 9000000;
 };
 
+# Client {
+#  username = "ident";
+#  host = "host";
+#  ip = "127.0.0.0/8";
+#  password = "password";
+#  class = "classname";
+#  maxlinks = 3;
+# };
+#
+# Everything in a Client block is optional.  If a username mask is
+# given, it must match the client's username from the IDENT protocol.
+# If a host mask is given, the client's hostname must resolve and
+# match the host mask.  If a CIDR-style IP mask is given, the client
+# must have an IP matching that range.  If maxlinks is given, it is
+# limits the number of matching clients allowed from a particular IP
+# address.
+#
 # Recommended client classes:
 # Client classes. 10 = locals; 2 = for all .net and .com that are not
 # in Europe; 1 = for everybody.
@@ -147,7 +162,7 @@ Class {
 Client
 {
  class = "Other";
host = "*@*";
username = "*";
 };
 Class {
  name = "America";
@@ -305,7 +320,7 @@ Client
  class = "Local";
 };
 
-# You can put a digit (0..9) in the password value, which will make ircd
+# You can put an expression in the maxlinks value, which will make ircd
 # only accept a client when the total number of connections to the network
 # from the same IP number doesn't exceed this number.
 # The following example would accept at most one connection per IP number
@@ -313,12 +328,12 @@ Client
 # that have "dial??.*" as host mask:
 # Client {
 #  host = "*@*.swipnet.se";
-#  password = "1";
+#  maxlinks = 1;
 #  class = "Other";
 # };
 # Client {
 #  host = "*@dial??.*";
-#  password = "2";
+#  maxlinks = 2;
 #  class = "Other";
 # };
 #
@@ -364,7 +379,7 @@ motd {
  file = "london.motd";
 };
 
-# [Server]
+# [UWorld]
 #
 # One of the many nice features of Undernet is "Uworld", a program
 # connected to the net as a server. This allows it to broadcast any mode
@@ -373,17 +388,9 @@ motd {
 # There is only one slight problem: the TimeStamp protocol prevents this.
 # So there is a configuration option to allow them anyway from a certain
 # server.
-# Server {
+# UWorld {
 #  # The servername or wildcard mask for it that this applies to.
 #  name = "relservername";
-#  # The mask of servers they are allowed to introduce(for hub=yes;) or
-#  # not allowed to introduce(for leaf=yes).
-#  mask = "servermask";
-#  # No is assumed for these unless you set it to yes.
-#  uworld = no;
-#  hub = no;
-#  # Yes is assumed for "leaf" unless you set it to no.
-#  leaf = yes;
 # };
 #
 # Note: (1) These lines are agreed on by every server admin on Undernet;
@@ -393,7 +400,7 @@ motd {
 # If you're on Undernet, you MUST have these lines. I cannnot stress
 # this enough.  If all of the servers don't have the same lines, the
 # servers will try to undo the mode hacks that Uworld does.  Make SURE that
-# all of the servers have the EXACT same Ulines.
+# all of the servers have the EXACT same UWorld blocks.
 #
 # If your server starts on a bit larger network, you'll probably get
 # assigned one or two uplinks to which your server can connect.
@@ -403,70 +410,32 @@ motd {
 # You can also force a server(even one that doesn't connect to you)
 # to be a leaf with "leaf = yes;"
 
-Server {
+UWorld {
  name = "uworld.eu.undernet.org";
- mask = "*";
- uworld = yes;
- hub = yes;
 };
-Server {
+UWorld {
  name = "uworld2.undernet.org";
- mask = "*";
- uworld = yes;
- hub = yes;
 };
-Server {
+UWorld {
  name = "uworld.undernet.org";
- mask = "*";
- uworld = yes;
- hub = yes;
 };
-Server {
+UWorld {
  name = "channels.undernet.org";
- mask = "*";
- uworld = yes;
- hub = yes;
 };
-Server {
+UWorld {
  name = "channels2.undernet.org";
- mask = "*";
- uworld = yes;
- hub = yes;
 };
-Server {
+UWorld {
  name = "channels3.undernet.org";
- mask = "*";
- uworld = yes;
- hub = yes;
 };
-Server {
+UWorld {
  name = "channels4.undernet.org";
- mask = "*";
- uworld = yes;
- hub = yes;
 };
-Server {
+UWorld {
  name = "channels5.undernet.org";
- mask = "*";
- uworld = yes;
- hub = yes;
 };
-Server {
+UWorld {
  name = "channels6.undernet.org";
- mask = "*";
- uworld = yes;
- hub = yes;
-};
-Server {
- name = "Amsterdam.NL.Eu.UnderNet.org";
- mask = "*";
- hub = yes;
-};
-# An example just to make sure IRCnet doesn't get on undernet...
-Server {
- name = "*";
- mask = "eris.berkeley.edu";
- hub = yes;
 };
 
 # As of ircu2.10.05 is it possible to Jupe nicks. As per CFV-0095, the
@@ -555,13 +524,21 @@ Kill
 #  password = "passwd";
 #  port = portno;
 #  class = "classname";
+#  maxhops = 2;
+#  hub = "*.eu.undernet.org";
 # };
 #
 # The "port" field defines the default port the server tries to connect
 # to if an operator uses /connect without specifying a port. This is also
-# the port used when the server attempts to auto-connect to the remote 
+# the port used when the server attempts to auto-connect to the remote
 # server. (See Class blocks for more informationa about auto-connects).
 #
+# The maxhops field causes an SQUIT if a hub tries to introduce
+# servers farther away than that; the element 'leaf;' is an alias for
+# 'maxhops = 0;'.  The hub field limits the names of servers that may
+# be introduced by a hub; the element 'hub;' is an alias for
+# 'hub = "*";'.
+#
 # Our primary uplink.
 Connect {
  name = "Amsterdam.NL.Eu.UnderNet.org";
@@ -569,6 +546,7 @@ Connect {
  password = "passwd";
  port = 4400;
  class = "Servers";
+ hub;
 };
 
 # [crule]