From: Kevin L. Mitchell Date: Wed, 27 Jun 2001 14:57:02 +0000 (+0000) Subject: Author: Braden X-Git-Url: http://git.pk910.de/?p=ircu2.10.12-pk.git;a=commitdiff_plain;h=ebd77a83f3ddfc6e7951b747acc2851bcfc19f16 Author: Braden Log message: Updated example.conf describing various changes to the configuration file. (Reviewed by Kev .) git-svn-id: file:///home/klmitch/undernet-ircu/undernet-ircu-svn/ircu2/trunk@520 c9e4aea6-c8fd-4c43-8297-357d70d61c8c --- diff --git a/ChangeLog b/ChangeLog index ab8c6fe..404db93 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,5 +1,8 @@ 2001-06-27 Kevin L. Mitchell + * doc/example.conf: updated example.conf from Braden + + * include/supported.h: forward-port from pl15 2001-06-25 Kevin L. Mitchell diff --git a/doc/example.conf b/doc/example.conf index 588bc76..049b7c8 100644 --- a/doc/example.conf +++ b/doc/example.conf @@ -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 , based on the original example.conf, # server code and some real-life (ahem) experience. # +# Updated and heavily modified by Braden . +# # 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 @@ -16,25 +20,32 @@ # 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::::: +# M::::: # # must contain either a * or a valid IPv4 address in # dotted quad notation. (127.0.0.1) The address MUST be the address @@ -44,79 +55,63 @@ # The server must be compiled with virtual hosting turned on to get this # to work correctly. # -# The 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 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::: - A:The University of London:Undernet IRC server:IRC Admins + +# [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::::: - +# # 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 # condition is satisfied. This is a Bad Thing(tm). - -# 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, 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 remote servers. This field DOES NOT limit -# the total number of servers that can be manually connected. -# To turn off auto connecting, 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. - +# +# should be set at either 0 or 1. +# # Server classes: 90 = all your uplinks for who you do not wish to hub; # 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::::: - +# # 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 , # 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 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 @@ -131,20 +126,19 @@ Y:1:90:0:400:160000 # match this I: line: # I:jolan.ppro::foobar::1 # Finally, I: lines with empty or 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 @@ -165,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 @@ -178,9 +172,13 @@ I:*@193.37.*::*@*.london.ac.uk::10 # that have "dial??.*" as host mask: # I:Resolved:1:*@*.swipnet.se::1 # I:Resolved:2:*@dial??.*::1 - # -# T:Lines +# 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. @@ -193,33 +191,48 @@ I:*@193.37.*::*@*.london.ac.uk::10 # 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:::* +# # 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,W,ChanSvr,ChanSaver,ChanServ,COM1,COM2,COM3,COM4:* -U:Uworld.undernet.org:Uworld,X,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. @@ -234,7 +247,7 @@ U:Uworld.undernet.org:Uworld,X,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":* @@ -255,6 +268,8 @@ k:192.168.*:!klines/martians:* # 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. @@ -276,10 +291,12 @@ K:$R*sub7*:"You are infected with a Trojan":* # 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. @@ -288,12 +305,16 @@ C:1.2.3.4:passwd:Amsterdam.NL.Eu.UnderNet.org:4400:90 # H::: 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:::: + +# [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. @@ -301,10 +322,12 @@ H:*.*::Amsterdam.NL.Eu.UnderNet.org # d::: # 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 @@ -324,20 +347,28 @@ H:*.*::Amsterdam.NL.Eu.UnderNet.org # Local operators are designated with a lowercase 'o' # O::::: # o::::: - +# +# 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 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. @@ -367,11 +398,15 @@ 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 # +# C = Client (Ports 6660-6669) +# S = Server (Port 4400) +# # P:::<[CS][H]>: # # 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 @@ -384,74 +419,102 @@ P:192.168.*:::6666 # with the IP address 168.8.21.107 #P:*:168.8.21.107:CH:7000 + # [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::[:[...]] -# -# Currently, the only defined value for is "LOG," and it allows you -# to customize the settings of the logging architecture. You can set the -# default logging facility to, say, local7 (F:LOG:LOCAL7), or set a log -# file for one of the subsystems (F:LOG:GLINE:FILE:gline.log). More than -# one subsystem can log to the same file without danger of interleaving. -# -# The currently defined subsystems are SYSTEM, CONFIG, OPERMODE (used by -# /opmode and /clearmode), GLINE, JUPE, WHO (used by /whox), NETWORK -# (connects and disconnects), OPERKILL, SERVKILL, USER, OPER, OPERLOG, -# USERLOG, RESOLVER, SOCKET, DEBUG, and OLDLOG. You can set log files -# for these subsystems to log to, or you can tell them to syslog their -# data, or even send server notices. You can do any of these in -# combination, but you can't log to more than one file. You can also set -# minimum log levels per subsystem, if you wish. -# -# The format for LOG Feature lines is as follows: -# -# F:LOG: -# F:LOG::[:] -# -# The first sets the default facility for ircu to log to to . -# Valid values are listed in the syslog(3) man page; just -# remove the "LOG_" prefix. -# -# The list of subsystems is given above. The valid values for are -# FILE, FACILITY, SNOMASK, and LEVEL, which respectively set the log file, -# the syslog facility, a server notice mask value, and the minimum log -# level. If no is given, or if is empty, the default -# value for that type is set. -# -# Valid 's for the FACILITY type are the normal syslog values (with -# the "LOG_" prefix removed) or the special values "NONE" (which specifies -# that syslogging should not be attempted) and "DEFAULT" (which specifies -# that the server-wide facility should be used); the default for all -# subsystems is "NONE." -# -# Valid 's for the SNOMASK type are OLDSNO, SERVKILL, OPERKILL, -# HACK2, HACK3, UNAUTH, TCPCOMMON, TOOMANY, HACK4, GLINE, NETWORK, -# IPMISMATCH, THROTTLE, OLDREALOP, and CONNEXIT, as well as the special -# values NONE, which specifies that no server notices should be sent, -# and DEBUG, which is only available if DEBUGMODE has been enabled. -# -# Valid 's for the LEVEL type are CRIT, ERR, WARNING, NOTICE, -# TRACE, INFO, and DEBUG. Note that logs with level CRIT always result -# in server notices to mask SNO_OLDSNO, and logs with level DEBUG always -# send server notices to mask SNO_DEBUG. -# -# A couple of things to note: log settings are not reset to defaults prior -# to a rehash; this means that if you delete F-lines and rehash, logs will -# continue going to the same place. Also, all subsystems are defaulted to -# minimum log level INFO (or DEBUG if DEBUGMODE is #define'd). - -# -# Well, you have now reached the end of this sample configuration file -# If you have any questions, feel free to mail -# or . -# 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 asking for information. -# Upgrades of the Undernet ircd can be found on http://coder-com.undernet.org/. +# F: