Author: Braden <dbtem@yahoo.com>
[ircu2.10.12-pk.git] / doc / example.conf
index bbc0e82726e6e9f57344255596c478d549f76b8a..049b7c8b642241672fa7be0a64c1543fe226dc94 100644 (file)
@@ -1,13 +1,17 @@
 # ircd.conf  configuration file for ircd version ircu2.9.mu and ircu2.10
 #
+# Last Updated:  26, June 2001.
+#
 # Written by Niels <niels@undernet.org>, based on the original example.conf,
 # server code and some real-life (ahem) experience.
 #
+# Updated and heavily modified by Braden <dbtem@yahoo.com>.
+#
 # Thanks and credits to: Run, Trillian, Cym, Morrissey, Chaos, Flynn,
 #                        Xorath, WildThang, Mmmm, SeKs, Ghostwolf and
 #                        all other Undernet IRC Admins and Operators,
 #                        and programmers working on the Undernet ircd.
-
+#
 # This is an example of the configuration file used by the Undernet ircd.
 #
 # This document is based on a (fictious) server in Europe with a
 # to one in the US by itself.
 #
 # All configuration options start with a letter identifying the option,
-# and a colon separated list of options. An asterisk indicates an
-# unused field.
+# and a colon separated list of options. Unused fields should be left
+# blank.
 #
 # Please note that when ircd puts the configuration lines into practice,
 # it parses them exactly the other way round than they are listed here.
+# It reads the lines in reverse order.
+#
 # This means that you should start your I: lines with the "fall through",
 # most vanilla one and end with the most detailed.
 #
-# There is a difference between the ``hostname'' and the ``server name''
+# There is a difference between the "hostname" and the "server name"
 # of the machine that the server is run on. For example, the host can
-# have ``veer.cs.vu.nl'' as FQDN, and ``Amsterdam.NL.EU.undernet.org'' as
+# have "veer.cs.vu.nl" as FQDN, and "Amsterdam.NL.EU.undernet.org" as
 # server name.
-# A ``server mask'' is something like '*.EU.UnderNet.org'', which is
-# matched by 'Amsterdam.NL.EU.undernet.org' but not by
-# 'Manhattan.KS.US.undernet.org'.
+# A "server mask" is something like "*.EU.UnderNet.org", which is
+# matched by "Amsterdam.NL.EU.undernet.org" but not by
+# "Manhattan.KS.US.undernet.org".
+#
+# Please do NOT just rename the example.conf to ircd.conf and expect
+# it to work.
+
 
+# [M:line]
 #
 # First some information about the server.
-# M:<server name>:<virtual host>:<description>:<server port>:<server numeric>
+# M:<server name>:<virtual host>:<description>:<not used>:<server numeric>
 #
 # <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
 # The server must be compiled with virtual hosting turned on to get this
 # to work correctly.
 #
-# The <server port> is no longer used.
-# Ports need to be specified with a P: line, see below.
-# At some point in the future we may want to use the port value for
-# server capacity. --Bleep
-#
 # Note that <server numeric> has to be unique on the network your server
-# is running on, must be between 1 and 64, and is not updated on a rehash.
+# is running on, must be between 0 and 4095, and is not updated on a rehash.
+M:London.UK.Eu.UnderNet.org::University of London, England::1
 
-M:London.UK.Eu.UnderNet.org:*:University of London, England:0:1
 
+# [A:line]
 #
 # This sets information that can be retrieved with the /ADMIN command.
 # It should contain at least an admin Email contact address.
 # A:<line 1>:<line 2>:<line 3>
-
 A:The University of London:Undernet IRC server:IRC Admins <irc@london.ac.uk>
 
+
+# [Y:lines]
 #
-# All connections to the server are associated with a certain ``connection
-# class'', be they incoming or outgoing (initiated by the server), be they
+# All connections to the server are associated with a certain "connection
+# class", be they incoming or outgoing (initiated by the server), be they
 # clients, servers or Martians. (Note that ircd doesn't have direct support
 # for Martians (yet?); they will have to register as normal users. ;-)
 # 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> should be set at either 0 or 1.
+#
 # 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)
-
-Y:90:90:300:1:1700000
-Y:80:90:300:1:1700000
-Y:70:90:300:1:1700000
-Y:50:90:300:10:1700000
+# 80 = leaf servers (only used if your server is a hub)
+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.
-
 Y:10:90:0:100:160000
 Y:2:90:0:5:80000
 Y:1:90:0:400:160000
 
+
+# [I:lines]
 #
 # To allow clients to connect, they need authorization. This can be
 # done based on hostmask, address mask, and/or with a password.
 # With intelligent use of classes and the maxconnections field in the
 # Y: lines, you can let in a specific domain, but get rid of all other
-# domains in the same toplevel, thus setting up some sort of 'reverse
-# K: line'.
+# domains in the same toplevel, thus setting up some sort of "reverse
+# K: line".
 # I:<IP mask or crap to force resolving>:<opt passwd>:<hostmask>::<class>
-
+#
 # Technical description (for examples, see below):
-# For every connecting client, the IP-number is know.  A reverse lookup
+# For every connecting client, the IP address is known.  A reverse lookup
 # on this IP-number is done to get the (/all) hostname(s).
 # Each hostname that belongs to this IP-number is matched to <hostmask>,
 # and the I: line is used when any matches; the client will then show
-# with this particular hostname.  If none of the hostnames matches, then
+# with this particular hostname.  If none of the hostnames match, then
 # the IP-number is matched against the <IP mask ...> field, if this matches
 # then the I: line is used nevertheless and the client will show with the
 # first (main) hostname if any; if the IP-number did not resolve then the
@@ -114,20 +126,19 @@ Y:1:90:0:400:160000
 # match this I: line:
 # I:jolan.ppro::foobar::1
 # Finally, I: lines with empty <IP mask ..> or <hostmask> fields are skipped.
-
-# This is the 'fallback' entry. All .uk, .nl, and all unresolved are
+#
+# This is the "fallback" entry. All .uk, .nl, and all unresolved are
 # in these two lines.
 # By using two different lines, multiple connections from a single IP
 # are only allowed from hostnames which have both valid forward and
 # reverse DNS mappings.
-
 I:*@*:1:Unresolved::1
 I:Resolved::*@*::1
 
 # If you don't want unresolved dudes to be able to connect to your
 # server, use just:
 # I:NotMatchingCrap::*@*::1
-
+#
 # Here, take care of all American ISPs.
 I:Resolved::*@*.com::2
 I:Resolved::*@*.net::2
@@ -148,7 +159,7 @@ I:Resolved::*@*.NL.net::1
 # You can request a more complete listing, including the "list of standard
 # K-lines" from the Routing Committee; it will also be sent to you if
 # you apply for a server and get accepted.
-
+#
 # Ourselves - this makes sure that we can get in, no matter how full
 # the server is (hopefully).
 I:*@193.37.*::*@*.london.ac.uk::10
@@ -161,44 +172,67 @@ I:*@193.37.*::*@*.london.ac.uk::10
 # that have "dial??.*" as host mask:
 # I:Resolved:1:*@*.swipnet.se::1
 # I:Resolved:2:*@dial??.*::1
+#
+# If you are not worried about who connects, this line will allow everyone
+# to connect.
+I:*::*::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.
 T:*.net:net_com.motd
 T:*.com:net_com.motd
+T:2:net_com.motd
 
 # A different MOTD for ourselves, where we point out that the helpdesk
 # better not be bothered with questions regarding irc...
 T:*.london.ac.uk:london.motd
 
+
+# [U:lines]
 #
-# One of the many nice features of Undernet is ``Uworld'', a program
+# 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
-# change, thus allowing opers to, for example, 'unlock' a channel that
+# change, thus allowing opers to, for example, "unlock" a channel that
 # has been taken over.
 # 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.
+# U:<Server Name>:<Juped Nicks>:*
+#
 # Note: (1) These lines are agreed on by every server admin on Undernet;
 # (2) These lines must be the same on every single server, or results
 # will be disasterous; (3) This is a useful feature, not something that
 # is a liability and abused regularly (well... :-)
 # If you're on Undernet, you MUST have these lines. I cannnot stress
-# this enough.
+# 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.
+#
 # As of ircu2.10.05 is it possible to Jupe nicks. Juped nicks need to be
 # added to U: lines.  As per CFV-0095, the following nicks must be juped,
 # it is not allowed to jupe others as well.
+U:Uworld.EU.undernet.org:EuWorld,E,StatServ,NoteServ:*
+U:Uworld2.undernet.org:UWorld2,ChanSvr,ChanSaver,ChanServ:*
+U:Uworld.undernet.org:Uworld,NickSvr,NickSaver,NickServ:*
+U:channels.undernet.org:LPT1,X,login:*
+U:channels2.undernet.org:LPT2,W,Undernet:*
+U:channels3.undernet.org:COM1,V,protocol:*
+U:channels4.undernet.org:COM2,U,pass:*
+U:channels5.undernet.org:COM3,Y,AUX:*
+U:channels6.undernet.org:COM4,Z,newpass:*
 
-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:*
 
+# [K:lines]
 #
 # While running your server, you will most probably encounter individuals
 # or groups of persons that you do not wish to have access to your server.
@@ -213,7 +247,7 @@ U:Uworld.undernet.org:Uworld,X,W,NickSvr,NickSaver,NickServ,LPT1,LPT2,AUX:*
 # Note that K: lines are local to the server; if you ban a person or a
 # whole domain from your server, they can get on IRC via any other server
 # that doesn't have them K: lined (yet).
-
+#
 # With a simple comment, using quotes:
 K:*.au:"Please use a nearer server":*
 K:*.edu:"Please use a nearer server":*
@@ -229,6 +263,13 @@ K:unixbox.flooder.co.uk:!kline/youflooded.txt:*luser
 # even if an IP address has a properly resolving host name.
 k:192.168.*:!klines/martians:*
 
+# Additionally, you may specify a hostmask prefixed with $R to indicate
+# a match should be performed against the "real-name" / "info" field
+# instead of the host/IP.
+K:$R*sub7*:"You are infected with a Trojan":*
+
+
+# [C:lines]
 #
 # You probably want your server connected to other servers, so your users
 # have other users to chat with.
@@ -246,12 +287,16 @@ 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
 
+
+# [H:lines]
 #
 # If your server starts on a bit larger network, you'll probably get
 # assigned one or two uplinks to which your server can connect.
@@ -260,12 +305,16 @@ C:1.2.3.4:passwd:Amsterdam.NL.Eu.UnderNet.org:4400:90
 # H:<allowed hostmask>::<server name>
 H:*.*::Amsterdam.NL.Eu.UnderNet.org
 
+
+# [L:lines]
 #
 # Of course, the opposite is also possible: forcing a server to be
 # a leaf. L: lines follow Murphy's Law: if you use them, there's a big
 # chance that routing will be screwed up afterwards.
 # L:<opt disallowed hostmask>::<server mask>:<opt max depth>
 
+
+# [D:lines]
 #
 # For an advanced, real-time rule-based routing decision making system
 # you can use Disallow lines. For more information, see doc/readme.crules.
@@ -273,10 +322,12 @@ H:*.*::Amsterdam.NL.Eu.UnderNet.org
 # d:<server mask that ircd will not autoconnect to>::<rule>
 # D:*.US.UnderNet.org::connected(*.US.UnderNet.org)
 # d:*.EU.UnderNet.org::connected(Amsterdam.NL.EU.*)
-
+#
 # The following line is recommended for leaf servers:
 # d:*::directcon(*)
 
+
+# [O:lines]
 #
 # Inevitably, you have reached the part about "IRC Operators". Oper status
 # grants some special privileges to a user, like the power to make the
@@ -296,29 +347,50 @@ H:*.*::Amsterdam.NL.Eu.UnderNet.org
 # Local operators are designated with a lowercase 'o'
 # O:<host/IP mask>:<encrypted password>:<Nick>::<connection class>
 # o:<host/IP mask>:<encrypted password>:<Nick>::<connection class>
-
+#
+# The encrypted password is optional.  If you wish to encrypt your password,
+# there is a utility in the ircd.  Please read the file tools/README.  
 O:*@*.cs.vu.nl:VRKLKuGKn0jLs:Niels::10
+o:*@*.uu.net:noncryptedpass:Braden::10
 
 # Note that the <connection class> is optional, but leaving it away
 # puts the O: lines in class 0, which usually only accepts one connection
 # at a time.  If you want users to Oper up more then once per O: line,
 # then use a connection class that allows more then one connection,
 # for example (using class 10 as in the example above):
+#
+# Once you OPER your connection class changes no matter where you are or
+# your previous connection classes.  If the defined connection class is 10
+# for the O:line, then your new connection class is 10.
 # Y:10:90:0:100:160000
 
+
 # [P:lines]
-# When your server gets fuller, you will notice delays when trying to
-# connect to your server's primary listening port. Via the Port lines
-# it is possible to specify additional ports for ircd to listen to.
+# When your server gets more full, you will notice delays when trying to
+# connect to your server's primary listening port. It is possible via the
+# Port lines to specify additional ports for the ircd to listen to.
 # De facto ports are: 6667 - standard; 6660-6669 - additional client
 # 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,31 +398,123 @@ 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>
+# C = Client (Ports 6660-6669)
+# S = Server (Port 4400)
+#
+# 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.
 P:::S:4400
+
 # This is a Server port that is Hidden
 #P:::SH:4401
 
 # 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
 #P:*:168.8.21.107:CH:7000
 
-#
-# Well, you have now reached the end of this sample configuration file
-# If you have any questions, feel free to mail <doco-com@undernet.org>
-# or <coder-com@undernet.org>.
-# If you are interested in linking your server to the Undernet IRC network
-# visit http://www.routing-com.undernet.org/, and if there are any problems
-# then contact <routing-com@undernet.org> asking for information.
-# Upgrades of the Undernet ircd can be found on http://coder-com.undernet.org/.
+
+# [F:lines]
+#
+# IRC servers have a large number of options and features.  Most of these
+# are set at compile time through the use of #define's--see "make config"
+# for more details--but we are working to move many of these into the
+# configuration file.  Feature lines are the hook we're using for this.
+# F:<Option>:<Value>
+#
+# The entire purpose of F:lines are so that you do not have to recompile
+# the IRCD everytime you want to change a feature.  All of the features
+# are listed below, and at the bottom is how to set logging.
+#
+# A Special Thanks to Kev for writing the documentation of F:lines.  It can
+# be found at doc/readme.features and the logging documentation can be
+# found at doc/readme.log.  The defaults used by the Undernet network are
+# below.
+#
+# F:DOMAINNAME:<obtained from /etc/resolv.conf by ./configure>
+# F:RELIABLE_CLOCK:FALSE
+# F:BUFFERPOOL:27000000
+# F:HAS_FERGUSON_FLUSHER:FALSE
+# F:CLIENT_FLOOD:1024
+# F:SERVER_PORT:4400
+# F:NODEFAULTMOTD:TRUE
+# F:KILL_IPMISMATCH:FALSE
+# F:IDLE_FROM_MSG:TRUE
+# F:HUB:FALSE
+# F:WALLOPS_OPER_ONLY:FALSE
+# F:NODNS:FALSE
+# F:RANDOM_SEED:<you should set one explicitly>
+# F:DEFAULT_LIST_PARAM
+# F:NICKNAMEHISTORYLENGTH:800
+# F:KILLCHASETIMELIMIT:30
+# F:MAXCHANNELSPERUSER:10
+# F:AVBANLEN:40
+# F:MAXBANS:30
+# F:MAXSILES:15
+# F:HANGONGOODLINK:300
+# F:HANGONRETRYDELAY:10
+# F:CONNECTTIMEOUT:90
+# F:TIMESEC:60
+# F:MAXIMUM_LINKS:1
+# F:PINGFREQUENCY:120
+# F:CONNECTFREQUENCY:600
+# F:DEFAULTMAXSENDQLENGTH:40000
+# F:MPATH:ircd.motd
+# F:RPATH:remote.motd
+# F:PPATH:ircd.pid
+# F:VIRTUAL_HOST:FALSE
+# F:TOS_SERVER:0x08
+# F:TOS_CLIENT:0x08
+# F:CRYPT_OPER_PASSWORD:TRUE
+# F:OPER_NO_CHAN_LIMIT:TRUE
+# F:OPER_MODE_LCHAN:TRUE
+# F:OPER_WALK_THROUGH_LMODES:FALSE
+# F:NO_OPER_DEOP_LCHAN:FALSE
+# F:SHOW_INVISIBLE_USERS:TRUE
+# F:SHOW_ALL_INVISIBLE_USERS:TRUE
+# F:UNLIMIT_OPER_QUERY:FALSE
+# F:LOCAL_KILL_ONLY:FALSE
+# F:CONFIG_OPERCMDS:FALSE
+# F:OPER_KILL:TRUE
+# F:OPER_REHASH:TRUE
+# F:OPER_RESTART:TRUE
+# F:OPER_DIE:TRUE
+# F:OPER_GLINE:TRUE
+# F:OPER_LGLINE:TRUE
+# F:OPER_JUPE:TRUE
+# F:OPER_LJUPE:TRUE
+# F:OPER_OPMODE:TRUE
+# F:OPER_LOPMODE:TRUE
+# F:OPER_BADCHAN:FALSE
+# F:OPER_LBADCHAN:FALSE
+# F:OPER_SET:TRUE
+# F:OPERS_SEE_IN_SECRET_CHANNELS:TRUE
+# F:LOCOP_KILL:TRUE
+# F:LOCOP_REHASH:TRUE
+# F:LOCOP_RESTART:FALSE
+# F:LOCOP_DIE:FALSE
+# F:LOCOP_LGLINE:TRUE
+# F:LOCOP_LJUPE:TRUE
+# F:LOCOP_LOPMODE:TRUE
+# F:LOCOP_LBADCHAN:FALSE
+# F:LOCOP_SET:FALSE
+# F:LOCOP_SEE_IN_SECRET_CHANNELS:FALSE
+
+
+# Well, you have now reached the end of this sample configuration
+# file. If you have any questions, feel free to mail
+# <coder-com@undernet.org>.  If you are interested in linking your
+# server to the Undernet IRC network visit
+# http://www.routing-com.undernet.org/, and if there are any
+# problems then contact <routing-com@undernet.org> asking for
+# information. Upgrades of the Undernet ircd can be found on
+# http://coder-com.undernet.org/.
 #
 # For the rest:  Good Luck!
 #