Get rid of CONF_LEAF and CONF_HUB, and follow up with code cleanups.
[ircu2.10.12-pk.git] / doc / example.conf
index c745f8a604b1fc657783b0a4bfdad890b12ad6b5..95b37da7b88401c50a71b8f6094639a7c9ae685b 100644 (file)
@@ -305,7 +305,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 +313,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 +364,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 +373,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 +385,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,59 +395,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";
@@ -555,13 +520,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 +542,7 @@ Connect {
  password = "passwd";
  port = 4400;
  class = "Servers";
+ hub;
 };
 
 # [crule]
@@ -783,6 +757,7 @@ features
 #  "RANDOM_SEED"="<you should set one explicitly>";
 #  "DEFAULT_LIST_PARAM"="TRUE";
 #  "NICKNAMEHISTORYLENGTH"="800";
+#  "NETWORK"="UnderNet";
 #  "HOST_HIDING"="FALSE";
 #  "HIDDEN_HOST"="users.undernet.org";
 #  "HIDDEN_IP"="127.0.0.1";
@@ -792,10 +767,9 @@ features
 #  "AVBANLEN"="40";
 #  "MAXBANS"="30";
 #  "MAXSILES"="15";
-#  "HANGONGOODLINK="300";
+#  "HANGONGOODLINK"="300";
 # "HANGONRETRYDELAY" = "10";
 # "CONNECTTIMEOUT" = "90";
-# "TIMESEC" = "60";
 # "MAXIMUM_LINKS" = "1";
 # "PINGFREQUENCY" = "120";
 # "CONNECTFREQUENCY" = "600";
@@ -804,20 +778,69 @@ features
 # "MPATH" = "ircd.motd";
 # "RPATH" = "remote.motd";
 # "PPATH" = "ircd.pid";
-# "VIRTUAL_HOST" = "FALSE";
 # "TOS_SERVER" = "0x08";
 # "TOS_CLIENT" = "0x08";
 # "POLLS_PER_LOOP" = "200";
-# "IRCD_RES_TIMEOUTS" = "4";
+# "IRCD_RES_TIMEOUT" = "4";
 # "IRCD_RES_RETRIES" = "2";
 # "AUTH_TIMEOUT" = "9";
 # "IPCHECK_CLONE_LIMIT" = "4";
 # "IPCHECK_CLONE_PERIOD" = "40";
 # "IPCHECK_CLONE_DELAY" = "600";
-# "CRYPT_OPER_PASSWORD" = "TRUE";
 # "CONFIG_OPERCMDS" = "FALSE";
 # "OPLEVELS" = "TRUE";
 # "LOCAL_CHANNELS" = "TRUE";
+# "ANNOUNCE_INVITES" = "FALSE";
+#  These were introduced by Undernet CFV-165 to add "Head-In-Sand" (HIS)
+#  behavior to hide most network topology from users.
+#  "HIS_SNOTICES" = "TRUE";
+#  "HIS_SNOTICES_OPER_ONLY" = "TRUE";
+#  "HIS_DEBUG_OPER_ONLY" = "TRUE";
+#  "HIS_WALLOPS" = "TRUE";
+#  "HIS_MAP" = "TRUE";
+#  "HIS_LINKS" = "TRUE";
+#  "HIS_TRACE" = "TRUE";
+#  "HIS_STATS_a" = "TRUE";
+#  "HIS_STATS_c" = "TRUE";
+#  "HIS_STATS_d" = "TRUE";
+#  "HIS_STATS_e" = "TRUE";
+#  "HIS_STATS_f" = "TRUE";
+#  "HIS_STATS_g" = "TRUE";
+#  "HIS_STATS_h" = "TRUE";
+#  "HIS_STATS_i" = "TRUE";
+#  "HIS_STATS_j" = "TRUE";
+#  "HIS_STATS_k" = "TRUE";
+#  "HIS_STATS_l" = "TRUE";
+#  "HIS_STATS_L" = "TRUE";
+#  "HIS_STATS_m" = "TRUE";
+#  "HIS_STATS_M" = "TRUE";
+#  "HIS_STATS_o" = "TRUE";
+#  "HIS_STATS_p" = "TRUE";
+#  "HIS_STATS_q" = "TRUE";
+#  "HIS_STATS_r" = "TRUE";
+#  "HIS_STATS_R" = "TRUE";
+#  "HIS_STATS_t" = "TRUE";
+#  "HIS_STATS_T" = "TRUE";
+#  "HIS_STATS_u" = "FALSE";
+#  "HIS_STATS_U" = "TRUE";
+#  "HIS_STATS_v" = "TRUE";
+#  "HIS_STATS_w" = "TRUE";
+#  "HIS_STATS_x" = "TRUE";
+#  "HIS_STATS_y" = "TRUE";
+#  "HIS_STATS_z" = "TRUE";
+#  "HIS_WHOIS_SERVERNAME" = "TRUE";
+#  "HIS_WHOIS_IDLETIME" = "TRUE";
+#  "HIS_WHOIS_LOCALCHAN" = "TRUE";
+#  "HIS_WHO_SERVERNAME" = "TRUE";
+#  "HIS_WHO_HOPCOUNT" = "TRUE";
+#  "HIS_BANWHO" = "TRUE";
+#  "HIS_KILLWHO" = "TRUE";
+#  "HIS_REWRITE" = "TRUE";
+#  "HIS_REMOTE" = "TRUE";
+#  "HIS_NETSPLIT" = "TRUE";
+#  "HIS_SERVERNAME" = "*.undernet.org";
+#  "HIS_SERVERINFO" = "The Undernet Underworld";
+#  "HIS_URLSERVERS" = "http://www.undernet.org/servers.php";
 };
 
 # Well, you have now reached the end of this sample configuration