Author: Isomer <perry@coders.net>
[ircu2.10.12-pk.git] / doc / example.conf
index bbc0e82726e6e9f57344255596c478d549f76b8a..aa29ead9a0390ad59ef5a4e50aec860a9bb51c9e 100644 (file)
@@ -69,14 +69,31 @@ A:The University of London:Undernet IRC server:IRC Admins <irc@london.ac.uk>
 # Take the following Y: lines only as a guide.
 # Y:<class>:<ping freq>:<connect freq>:<maximum links>:<sendq size>
 
+# <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).
+
+# <maximum links> has different meanings for clients and servers.
+# For clients, it is the total number of connections allowed for the class.
+# Thus, if it is set to 100, then up to 100 clients can connect in that class.
+
+# Auto-connecting
+# For servers, <maximum links> is the number of remote servers, in that class, that the
+# server will attempt to be connected to. The server will initiate auto connections
+# until it is connected to <maximum links> remote servers. This field DOES NOT limit
+# the total number of servers that can be manually connected.
+# To turn off auto connecting, <maximum links> should be set to 0.
+# Note that MAXIMUM_LINKS (defined in make config) sets a hard limit on the number
+# of servers that can be connected and still have the server attempt auto-connections.
+# It is usually set to 1, which means a server will not attempt auto connects with a server
+# already connected, regardless of how the Y:lines are set up.
+
 # Server classes: 90 = all your uplinks for who you do not wish to hub;
-# else in classes 80 and/or 70.
-# 50 = leaf servers (only used if your server is a hub)
+# 80 = leaf servers (only used if your server is a hub)
 
-Y:90:90:300:1:1700000
-Y:80:90:300:1:1700000
-Y:70:90:300:1:1700000
-Y:50:90:300:10:1700000
+Y:90:90:300:1:9000000
+Y:80:90:300:0:9000000
 
 # Client classes. 10 = locals; 2 = for all .net and .com that are not
 # in Europe; 1 = for everybody.
@@ -162,11 +179,15 @@ I:*@193.37.*::*@*.london.ac.uk::10
 # I:Resolved:1:*@*.swipnet.se::1
 # I:Resolved:2:*@dial??.*::1
 
+#
+# T:Lines
 #
 # It is possible to show a different Message of the Day to a connecting
 # client depending on its origin.
 # T:<hostmask>:<path to motd file>
-
+# or:
+# T:<classnumber>:<path to motd file>
+#
 # DPATH/net_com.motd contains a special MOTD where users are encouraged
 # to register their domains and get their own I: lines if they're in
 # Europe, or move to US.UnderNet.org if they're in the USA.
@@ -196,8 +217,8 @@ T:*.london.ac.uk:london.motd
 # it is not allowed to jupe others as well.
 
 U:Uworld.EU.undernet.org:EuWorld,E,protocol,StatServ,NoteServ,Undernet:*
-U:Uworld2.undernet.org:UWorld2,ChanSvr,ChanSaver,ChanServ,COM1,COM2,COM3,COM4:*
-U:Uworld.undernet.org:Uworld,X,W,NickSvr,NickSaver,NickServ,LPT1,LPT2,AUX:*
+U:Uworld2.undernet.org:UWorld2,W,ChanSvr,ChanSaver,ChanServ,COM1,COM2,COM3,COM4:*
+U:Uworld.undernet.org:Uworld,X,NickSvr,NickSaver,NickServ,LPT1,LPT2,AUX:*
 
 #
 # While running your server, you will most probably encounter individuals
@@ -246,8 +267,10 @@ k:192.168.*:!klines/martians:*
 # allowed to connect.
 # C:<remote hostname or IP>:<password>:<remote server name>:<port>:<class>
 #
-# If the "port" field is omitted, the server will not attempt to
-# establish a link with that server ("not autoconnecting").
+# 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 
+# server. (See Y:lines for more informationa about auto-connects).
 
 # Our primary uplink.
 C:1.2.3.4:passwd:Amsterdam.NL.Eu.UnderNet.org:4400:90
@@ -314,11 +337,24 @@ O:*@*.cs.vu.nl:VRKLKuGKn0jLs:Niels::10
 # ports;
 # Undernet uses 4400 for server listener ports.
 # These are just hints, they are in no way official IANA or IETF policies.
+# IANA says we should use port 194, but that requires us to run as root, so
+# we don't do that.
+#
+# P:<hostmask>:<interface>:<[CS][H]>:<port number>
+#
+# The hostmask 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
+# DNS in any way so you can't use it to allow *.nl or *.uk. Attempting
+# to specify anything other than numbers, dots and stars [0-9.*] will result
+# in the port allowing connections from anyone.
 #
 # The interface setting allows multiply homed hosts to specify which
 # interface to use on a port by port basis, if an interface is not specified
 # the default interface will be used. The interface MUST be the complete
 # IP address for a real hardware interface on the machine running ircd.
+# If you want to use virtual hosting *YOU* *MUST* *USE* *THIS* otherwise it
+# WILL bind to all interfaces - not what most people seem to expect.
 #
 # The [CS][H] field is an optional field to specify that a port is a
 # server port or a client port and whether it's hidden or not.
@@ -326,7 +362,7 @@ O:*@*.cs.vu.nl:VRKLKuGKn0jLs:Niels::10
 # If you want to hide a port from /stats p from non-opers follow the C
 # or S with an H
 #
-# P:<hostmask>:<interface>:<[CS][H]>:<client port number>
+# P:<hostmask>:<interface>:<[CS][H]>:<port number>
 #
 # This is a normal server port, you need to have at least one server
 # port defined if you want to connect your server to other servers.
@@ -337,7 +373,7 @@ P:::S:4400
 # The following are normal client ports
 P:::C:6667
 P::::6668
-P:*.nl:::6666
+P:192.168.*:::6666
 
 # This is a hidden client port, listening on the interface associated
 # with the IP address 168.8.21.107