Fix bug #1299105 (overzealous IPv4 G-line checking).
[ircu2.10.12-pk.git] / doc / example.conf
1 # ircd.conf - configuration file for ircd version ircu2.10
2 #
3 # Last Updated:  20, March 2002.
4 #
5 # Written by Niels <niels@undernet.org>, based on the original example.conf,
6 # server code and some real-life (ahem) experience.
7 #
8 # Updated and heavily modified by Braden <dbtem@yahoo.com>.
9 #
10 # Rewritten by A1kmm(Andrew Miller)<a1kmm@mware.virtualave.net> to support
11 # the new flex/bison configuration parser.
12 #
13 # Thanks and credits to: Run, Trillian, Cym, Morrissey, Chaos, Flynn,
14 #                        Xorath, WildThang, Mmmm, SeKs, Ghostwolf and
15 #                        all other Undernet IRC Admins and Operators,
16 #                        and programmers working on the Undernet ircd.
17 #
18 # This is an example of the configuration file used by the Undernet ircd.
19 #
20 # This document is based on a (fictious) server in Europe with a
21 # connection to the Undernet IRC network. It is primarily a leaf server,
22 # but if all the other hubs in Europe aren't in service, it can connect
23 # to one in the US by itself.
24 #
25 # The configuration format consists of a number of blocks in the format
26 #  BlockName { setting = number; setting2 = "string"; setting3 = yes; };
27 # Note that comments start from a #(hash) and go to the end of the line.
28 # Whitespace(space, tab, or carriage return/linefeed) are ignored and may
29 # be used to make the configuration file more readable.
30 #
31 # Please note that when ircd puts the configuration lines into practice,
32 # it parses them exactly the other way round than they are listed here.
33 # It uses the blocks in reverse order.
34 #
35 # This means that you should start your Client blocks with the
36 # "fall through", most vanilla one, and end with the most detailed.
37 #
38 # There is a difference between the "hostname" and the "server name"
39 # of the machine that the server is run on. For example, the host can
40 # have "veer.cs.vu.nl" as FQDN, and "Amsterdam.NL.EU.undernet.org" as
41 # server name.
42 # A "server mask" is something like "*.EU.UnderNet.org", which is
43 # matched by "Amsterdam.NL.EU.undernet.org" but not by
44 # "Manhattan.KS.US.undernet.org".
45 #
46 # Please do NOT just rename the example.conf to ircd.conf and expect
47 # it to work.
48
49
50 # [General]
51 #
52 # First some information about the server.
53 # General {
54 #         name = "servername";
55 #         vhost = "ipv4vhost";
56 #         vhost = "ipv6vhost";
57 #         description = "description";
58 #         numeric = numericnumber;
59 # };
60 #
61 # If present, <virtual host> must contain a valid address in dotted
62 # quad or IPv6 numeric notation (127.0.0.1 or ::1).  The address MUST
63 # be the address of a physical interface on the host.  This address is
64 # used for outgoing connections if the Connect{} block does not
65 # override it.  See Port{} for listener virtual hosting.  If in doubt,
66 # leave it out -- or use "*", which has the same meaning as no vhost.
67 #
68 # You may specify both an IPv4 virtual host and an IPv6 virtual host,
69 # to indicate which address should be used for outbound connections
70 # of the respective type.
71 #
72 # Note that <server numeric> has to be unique on the network your server
73 # is running on, must be between 0 and 4095, and is not updated on a rehash.
74 General {
75          name = "London.UK.Eu.UnderNet.org";
76          description = "University of London, England";
77          numeric = 1;
78 };
79
80 # [Admin]
81 #
82 # This sets information that can be retrieved with the /ADMIN command.
83 # It should contain at least an admin Email contact address.
84 Admin {
85   Location = "The University of London";
86   # At most two contact lines are allowed...
87   Contact = "Undernet IRC server";
88   Contact = "IRC Admins <irc@london.ac.uk>";
89 };
90
91 # [Classes]
92 #
93 # All connections to the server are associated with a certain "connection
94 # class", be they incoming or outgoing (initiated by the server), be they
95 # clients or servers.
96 # Recommended client classes:
97 # Take the following class blocks only as a guide.
98 # Class {
99 #  name = "<class>";
100 #  pingfreq = time;
101 #  connectfreq = time;
102 #  maxlinks = number;
103 #  sendq = size;
104 #  usermode = "+i";
105 # };
106 #
107 # maxlinks should be set at either 0 or 1.
108 #
109 # <connect freq> applies only to servers, and specifies the frequency 
110 # that the server tries to autoconnect. setting this to 0 will cause
111 # the server to attempt to connect repeatedly with no delay until the 
112 # <maximum links> condition is satisfied. This is a Bad Thing(tm).
113 # Note that times can be specified as a number, or by giving something
114 # like: 1 minutes 20 seconds, or 1*60+20.
115 #
116 # Recommended server classes:
117 # All your server uplinks you are not a hub for.
118 Class {
119  name = "Server";
120  pingfreq = 1 minutes 30 seconds;
121  connectfreq = 5 minutes;
122  maxlinks = 1;
123  sendq = 9000000;
124 };
125 # All the leaf servers you hub for.
126 Class {
127  name = "LeafServer";
128  pingfreq = 1 minutes 30 seconds;
129  connectfreq = 5 minutes;
130  maxlinks = 0;
131  sendq = 9000000;
132 };
133
134 # Client {
135 #  username = "ident";
136 #  host = "host";
137 #  ip = "127.0.0.0/8";
138 #  password = "password";
139 #  class = "classname";
140 #  maxlinks = 3;
141 # };
142 #
143 # Everything in a Client block is optional.  If a username mask is
144 # given, it must match the client's username from the IDENT protocol.
145 # If a host mask is given, the client's hostname must resolve and
146 # match the host mask.  If a CIDR-style IP mask is given, the client
147 # must have an IP matching that range.  If maxlinks is given, it is
148 # limits the number of matching clients allowed from a particular IP
149 # address.
150 #
151 # Recommended client classes:
152 # Client classes. 10 = locals; 2 = for all .net and .com that are not
153 # in Europe; 1 = for everybody.
154 Class {
155  name = "Local";
156  pingfreq = 1 minutes 30 seconds;
157  sendq = 160000;
158  maxlinks = 100;
159  usermode = "+iw";
160 };
161 Client
162 {
163  class = "Other";
164  username = "*";
165 };
166 Class {
167  name = "America";
168  pingfreq = 1 minutes 30 seconds;
169  sendq = 80000;
170  maxlinks = 5;
171 };
172 Class {
173  name = "Other";
174  pingfreq = 1 minutes 30 seconds;
175  sendq = 160000;
176  maxlinks = 400;
177 };
178 Class {
179  name = "Opers";
180  pingfreq = 1 minutes 30 seconds;
181  sendq = 160000;
182  maxlinks = 10;
183
184  # For connection classes intended for operator use, you can specify
185  # privileges used when the Operator block (see below) names this
186  # class.  The local (aka globally_opered) privilege MUST be defined
187  # by either the Class or Operator block.  The following privileges
188  # exist:
189  #
190  # local (or propagate, with the opposite sense)
191  # whox  (log oper's use of x flag with /WHO)
192  # display (oper status visible to lusers)
193  # chan_limit (can join local channels when in
194  #                              MAXCHANNELSPERUSER channels)
195  # mode_lchan (can /MODE &channel without chanops)
196  # deop_lchan (cannot be deopped or kicked on local channels)
197  # walk_lchan (can forcibly /JOIN &channel OVERRIDE)
198  # show_invis (see +i users in /WHO x)
199  # show_all_invis (see +i users in /WHO x)
200  # unlimit_query (show more results from /WHO)
201  # local_kill (can kill clients on this server)
202  # rehash (can use /REHASH)
203  # restart (can use /RESTART)
204  # die (can use /DIE)
205  # local_jupe (not used)
206  # set (can use /SET)
207  # local_gline (can set a G-line for this server only)
208  # local_badchan (can set a Gchan for this server only)
209  # see_chan (can see users in +s channels in /WHO)
210  # wide_gline (can use ! to force a wide G-line)
211  # see_opers (can see opers without DISPLAY privilege)
212  # local_opmode (can use OPMODE/CLEARMODE on local channels)
213  # force_local_opmode (can use OPMODE/CLEARMODE on quarantined local channels)
214  # kill (can kill clients on other servers)
215  # gline (can issue G-lines to other servers)
216  # jupe_server (not used)
217  # opmode (can use /OPMODE)
218  # badchan (can issue Gchans to other servers)
219  # force_opmode (can use OPMODE/CLEARMODE on quarantined global channels)
220  # apass_opmode (can use OPMODE/CLEARMODE on +A and +U keys)
221  #
222  # For global opers (with propagate = yes or local = no), the default
223  # is to grant all of the above privileges EXCEPT apass_opmode.  For
224  # local opers, the default is to grant ONLY the following privileges:
225  #  chan_limit, mode_lchan, show_invis, show_all_invis, local_kill,
226  #  rehash, local_gline, local_jupe, local_opmode, whox, display,
227  #  force_local_opmode
228  # Any privileges listed in a Class block override the defaults.
229
230  local = no;
231 };
232 # [Client]
233 #
234 # To allow clients to connect, they need authorization. This can be
235 # done based on hostmask, address mask, and/or with a password.
236 # With intelligent use of classes and the maxconnections field in the
237 # Client blocks, you can let in a specific domain, but get rid of all other
238 # domains in the same toplevel, thus setting up some sort of "reverse
239 # Kill block".
240 # Client {
241 #  host = "user@host";
242 #  ip = "ip@host";
243 #  password = "password";
244 #  class = "classname";
245 # };
246 #
247 # Technical description (for examples, see below):
248 # For every connecting client, the IP address is known.  A reverse lookup
249 # on this IP-number is done to get the (/all) hostname(s).
250 # Each hostname that belongs to this IP-number is matched to <hostmask>,
251 # and the Client {} is used when any matches; the client will then show
252 # with this particular hostname.  If none of the hostnames match, then
253 # the IP-number is matched against the <IP mask ...> field, if this matches
254 # then the Client{} is used nevertheless and the client will show with the
255 # first (main) hostname if any; if the IP-number did not resolve then the
256 # client will show with the dot notation of the IP-number.
257 # There is a special case for the UNIX domain sockets and localhost connections
258 # though; in this case the <IP mask ...> field is compared with the
259 # name of the server (thus not with any IP-number representation). The name
260 # of the server is the one returned in the numeric 002 reply, for example:
261 # 002 Your host is 2.undernet.org[jolan.ppro], running version ...
262 # Then the "jolan.ppro" is the name used for matching.
263 # Therefore, unix domain sockets, and connections to localhost would
264 # match this block:
265 # host = "*@jolan.ppro";
266 #
267 # This is the "fallback" entry. All .uk, .nl, and all unresolved are
268 # in these two lines.
269 # By using two different lines, multiple connections from a single IP
270 # are only allowed from hostnames which have both valid forward and
271 # reverse DNS mappings.
272 Client
273 {
274  class = "Other";
275  ip = "*@*";
276 };
277
278
279 Client
280 {
281  class = "Other";
282  host = "*@*";
283 };
284 # If you don't want unresolved dudes to be able to connect to your
285 # server, do not specify any "ip = " settings.
286 #
287 # Here, take care of all American ISPs.
288 Client
289 {
290  host = "*@*.com";
291  class = "America";
292 };
293
294 Client
295 {
296  host = "*@*.net";
297  class = "America";
298 };
299 # Now list all the .com / .net domains that you wish to have access...
300 # actually it's less work to do it this way than to do it the other
301 # way around - K-lining every single ISP in the US.
302 # I wish people in Holland just got a .nl domain, and not try to be
303 # cool and use .com...
304 Client { host = "*@*.wirehub.net"; class = "Other";};
305 Client { host = "*@*.planete.net"; class = "Other";};
306 Client { host = "*@*.ivg.com"; class = "Other";};
307 Client { host = "*@*.ib.com"; class = "Other";};
308 Client { host = "*@*.ibm.net"; class = "Other";};
309 Client { host = "*@*.hydro.com"; class = "Other";};
310 Client { host = "*@*.nl.net"; class = "Local";};
311
312 # You can request a more complete listing, including the "list of standard
313 # Kill blocks" from the Routing Committee; it will also be sent to you if
314 # you apply for a server and get accepted.
315 #
316 # Ourselves - this makes sure that we can get in, no matter how full
317 # the server is (hopefully).
318 Client
319 {
320  host = "*@*.london.ac.uk";
321  ip = "*@193.37.*";
322  class = "Local";
323 };
324
325 # You can put an expression in the maxlinks value, which will make ircd
326 # only accept a client when the total number of connections to the network
327 # from the same IP number doesn't exceed this number.
328 # The following example would accept at most one connection per IP number
329 # from "*.swipnet.se" and at most two connections from dial up accounts
330 # that have "dial??.*" as host mask:
331 # Client {
332 #  host = "*@*.swipnet.se";
333 #  maxlinks = 1;
334 #  class = "Other";
335 # };
336 # Client {
337 #  host = "*@dial??.*";
338 #  maxlinks = 2;
339 #  class = "Other";
340 # };
341 #
342 # If you are not worried about who connects, this line will allow everyone
343 # to connect.
344 Client {
345  host = "*@*";
346  ip = "*@*";
347  class = "Other";
348 };
349
350
351 # [motd]
352 #
353 # It is possible to show a different Message of the Day to a connecting
354 # client depending on its origin.
355 # motd {
356 #  # Note: host can also be a classname.
357 #  host = "Other";
358 #  file = "path/to/motd/file";
359 # };
360 #
361 # DPATH/net_com.motd contains a special MOTD where users are encouraged
362 # to register their domains and get their own client{} lines if they're in
363 # Europe, or move to US.UnderNet.org if they're in the USA.
364 motd {
365  host = "*.net";
366  file = "net_com.motd";
367 };
368 motd {
369  host = "*.com";
370  file = "net_com.motd";
371 };
372 motd {
373  host = "America";
374  file = "net_com.motd";
375 };
376
377 # A different MOTD for ourselves, where we point out that the helpdesk
378 # better not be bothered with questions regarding irc...
379 motd {
380  host = "*.london.ac.uk";
381  file = "london.motd";
382 };
383
384 # [UWorld]
385 #
386 # One of the many nice features of Undernet is "Uworld", a program
387 # connected to the net as a server. This allows it to broadcast any mode
388 # change, thus allowing opers to, for example, "unlock" a channel that
389 # has been taken over.
390 # There is only one slight problem: the TimeStamp protocol prevents this.
391 # So there is a configuration option to allow them anyway from a certain
392 # server.
393 # UWorld {
394 #  # The servername or wildcard mask for it that this applies to.
395 #  name = "relservername";
396 # };
397 #
398 # You may have have more than one name listed in each block.
399 #
400 # Note: (1) These lines are agreed on by every server admin on Undernet;
401 # (2) These lines must be the same on every single server, or results
402 # will be disasterous; (3) This is a useful feature, not something that
403 # is a liability and abused regularly (well... :-)
404 # If you're on Undernet, you MUST have these lines. I cannnot stress
405 # this enough.  If all of the servers don't have the same lines, the
406 # servers will try to undo the mode hacks that Uworld does.  Make SURE that
407 # all of the servers have the EXACT same UWorld blocks.
408 #
409 # If your server starts on a bit larger network, you'll probably get
410 # assigned one or two uplinks to which your server can connect.
411 # If your uplink(s) also connect to other servers than yours (which is
412 # probable), you need to define your uplink as being allowed to "hub".
413 # See the Connect block documentation for details on how to do that.
414
415 UWorld {
416  name = "uworld.eu.undernet.org";
417  name = "uworld2.undernet.org";
418  name = "uworld.undernet.org";
419  name = "channels.undernet.org";
420  name = "channels2.undernet.org";
421  name = "channels3.undernet.org";
422  name = "channels4.undernet.org";
423  name = "channels5.undernet.org";
424  name = "channels6.undernet.org";
425 };
426
427 # As of ircu2.10.05 is it possible to Jupe nicks. As per CFV-0095 and
428 # CFV-0255, the following nicks must be juped, it is not allowed to
429 # jupe others as well.
430 Jupe {
431  nick = "A,B,C,D,E,F,G,H,I,J,K,L,M,N,O,P,Q,R,S,T,U,V,W,X,Y,Z,{,|,},~,-,_,`";
432  nick = "EuWorld,UWorld,UWorld2";
433  nick = "login,undernet,protocol,pass,newpass,org";
434  nick = "StatServ,NoteServ";
435  nick = "ChanSvr,ChanSaver,ChanServ";
436  nick = "NickSvr,NickSaver,NickServ";
437  nick = "LPT1,LPT2,COM1,COM2,COM3,COM4,AUX";
438 };
439
440 # [Kill]
441 #
442 # While running your server, you will most probably encounter individuals
443 # or groups of persons that you do not wish to have access to your server.
444 #
445 # For this purpose, the ircd understands "kill blocks". These are also
446 # known as K-lines, by virtue of the former config file format.
447 # Kill
448 # {
449 #   host = "user@host";
450 #   reason = "The reason the user will see";
451 # };
452 # It is possible to ban on the basis of the real name.
453 # It is also possible to use a file as comment for the ban, using
454 # file = "file":
455 # Kill
456 # {
457 #   realname = "realnametoban";
458 #   file = "path/to/file/with/reason/to/show";
459 # };
460 #
461 #
462 # The default reason is: "You are banned from this server"
463 # Note that Kill blocks are local to the server; if you ban a person or a
464 # whole domain from your server, they can get on IRC via any other server
465 # that doesn't have them Killed (yet).
466 #
467 # With a simple comment, using quotes:
468 Kill { host = "*.au"; reason = "Please use a nearer server"; };
469 Kill { host = "*.edu"; reason = "Please use a nearer server"; };
470
471 # You can also kill based on username.
472 Kill { username = "sub7"; realname = "s*7*"; reason = "You are infected with a Trojan"; };
473
474 # The file can contain for example, a reason, a link to the
475 # server rules and a contact address.  Note the combination
476 # of username and host in the host field.
477 Kill
478 {
479  host = "*luser@unixbox.flooder.co.uk";
480  file = "kline/youflooded.txt";
481 };
482
483 # IP-based kill lines apply to all hosts, even if an IP address has a
484 # properly resolving host name.
485 Kill
486 {
487  host = "192.168.*";
488  file = "klines/martians";
489 };
490
491 # The realname field lets you ban by realname...
492 Kill
493 {
494  realname = "*sub7*";
495  reason = "You are infected with a Trojan";
496 };
497
498 # [Connect]
499 #
500 # You probably want your server connected to other servers, so your users
501 # have other users to chat with.
502 # IRC servers connect to other servers forming a network with a star or
503 # tree topology. Loops are not allowed.
504 # In this network, two servers can be distinguished: "hub" and "leaf"
505 # servers. Leaf servers connect to hubs; hubs connect to each other.
506 # Of course, many servers can't be directly classified in one of these
507 # categories. Both a fixed and a rule-based decision making system for
508 # server links is provided for ircd to decide what links to allow, what
509 # to let humans do themselves, and what links to (forcefully) disallow.
510 #
511 # The Connect blocks
512 # define what servers the server connect to, and which servers are
513 # allowed to connect.
514 # Connect {
515 #  name = "servername";
516 #  host = "hostnameORip";
517 #  password = "passwd";
518 #  port = portno;
519 #  class = "classname";
520 #  maxhops = 2;
521 #  hub = "*.eu.undernet.org";
522 #  autoconnect = no;
523 # };
524 #
525 # The "port" field defines the default port the server tries to connect
526 # to if an operator uses /connect without specifying a port. This is also
527 # the port used when the server attempts to auto-connect to the remote
528 # server. (See Class blocks for more informationa about auto-connects).
529 # You may tell ircu to not automatically connect to a server by adding
530 # "autoconnect = no;"; the default is to autoconnect.
531 #
532 # The maxhops field causes an SQUIT if a hub tries to introduce
533 # servers farther away than that; the element 'leaf;' is an alias for
534 # 'maxhops = 0;'.  The hub field limits the names of servers that may
535 # be introduced by a hub; the element 'hub;' is an alias for
536 # 'hub = "*";'.
537 #
538 # Our primary uplink.
539 Connect {
540  name = "Amsterdam.NL.Eu.UnderNet.org";
541  host = "1.2.3.4";
542  password = "passwd";
543  port = 4400;
544  class = "Server";
545  hub;
546 };
547
548 # [crule]
549 #
550 # For an advanced, real-time rule-based routing decision making system
551 # you can use crule blocks. For more information, see doc/readme.crules.
552 # CRULE
553 # {
554 #  server = "servermask";
555 #  rule = "connectrule";
556 #  # Setting all to yes makes the rule always apply. Otherwise it only
557 #  # applies to autoconnects.
558 #  all = yes;
559 # };
560 CRULE
561 {
562  server = "*.US.UnderNet.org";
563  rule = "connected(*.US.UnderNet.org)";
564 };
565 CRULE
566 {
567  server = "*.EU.UnderNet.org";
568  rule = "connected(Amsterdam.NL.EU.*)";
569 };
570
571 # The following block is recommended for leaf servers:
572 CRULE
573 {
574  server = "*";
575  rule = "directcon(*)";
576 };
577
578 # [Operator]
579 #
580 # Inevitably, you have reached the part about "IRC Operators". Oper status
581 # grants some special privileges to a user, like the power to make the
582 # server break or (try to) establish a connection with another server,
583 # and to "kill" users off IRC.
584 # I can write many pages about this; I will restrict myself to saying that
585 # if you want to appoint somebody as IRC Operator on your server, that
586 # person should be aware of his/her responsibilities, and that you, being
587 # the admin, will be held accountable for their actions.
588 #
589 # There are two sorts of IRC Operators: "local" and "global". Local opers
590 # can squit, connect and kill - but only locally: their +o user mode
591 # is not not passed along to other servers. On Undernet, this prevents
592 # them from using Uworld as well.
593 #
594 # Operator {
595 #  host = "host/IP mask";
596 #  name = "opername";
597 #  password = "encryptedpass";
598 #  class = "classname";
599 #  # You can also set any operator privilege; see the Class block
600 #  # documentation for details.  A privilege defined for a single
601 #  # Operator will override the privilege settings for the Class
602 #  # and the default setting.
603 # };
604 #
605 # By default, the password is hashed using the system's native crypt()
606 # function.  Other password mechanisms are available; the umkpasswd
607 # utility from the ircd directory can hash passwords using those
608 # mechanisms.
609 #
610 # All privileges are shown with their default values; if you wish to
611 # override defaults, you should set only those privileges for the
612 # operator.  Listing defaulted privileges just makes things harder to
613 # find.
614 Operator {
615  local = no;
616  host = "*@*.cs.vu.nl";
617  password = "VRKLKuGKn0jLt";
618  name = "Niels";
619  class = "Local";
620 };
621 Operator {
622  host = "*@*.uu.net";
623  password = "$PLAIN$notencryptedpass";
624  name = "Niels";
625  class = "Opers";
626 };
627
628 # Note that the <connection class> is optional, but leaving it away
629 # puts the opers in class "default", which usually only accepts one
630 # connection at a time.  If you want users to Oper up more then once per
631 # block, then use a connection class that allows more then one connection,
632 # for example (using class Local as in the example above):
633 #
634 # Once you OPER your connection class changes no matter where you are or
635 # your previous connection classes.  If the defined connection class is
636 # Local for the operator block, then your new connection class is Local.
637
638 # [Port]
639 # When your server gets more full, you will notice delays when trying to
640 # connect to your server's primary listening port. It is possible via the
641 # Port lines to specify additional ports for the ircd to listen to.
642 # De facto ports are: 6667 - standard; 6660-6669 - additional client
643 # ports;
644 # Undernet uses 4400 for server listener ports.
645 # These are just hints, they are in no way official IANA or IETF policies.
646 # IANA says we should use port 194, but that requires us to run as root,
647 # so we don't do that.
648 #
649 # Port {
650 #  port = number;
651 #  mask = "ipmask";
652 #  # Use this to control the interface you bind to.
653 #  vhost = "virtualhostip";
654 #  # Setting to yes makes this server only.
655 #  server = yes;
656 #  # Setting to yes makes the port "hidden" from stats.
657 #  hidden = yes;
658 # };
659 #
660 # The mask setting allows you to specify a range of IP addresses that
661 # you will allow connections from. This should only contain IP addresses
662 # and '*' if used. This field only uses IP addresses. This does not use
663 # DNS in any way so you can't use it to allow *.nl or *.uk. Attempting
664 # to specify anything other than numbers, dots and stars [0-9.*] will result
665 # in the port allowing connections from anyone.
666 #
667 # The interface setting allows multiply homed hosts to specify which
668 # interface to use on a port by port basis, if an interface is not specified
669 # the default interface will be used. The interface MUST be the complete
670 # IP address for a real hardware interface on the machine running ircd.
671 # If you want to use virtual hosting *YOU* *MUST* *USE* *THIS* otherwise it
672 # WILL bind to all interfaces - not what most people seem to expect.
673 #
674 Port {
675  server = yes;
676  port = 4400;
677 };
678
679 # This is a Server port that is Hidden
680 Port {
681  server = yes;
682  hidden = yes;
683  port = 4401;
684 };
685
686 # The following are normal client ports
687 Port { port = 6667; };
688 Port { port = 6668; };
689 Port {
690  # This only accepts clients with IPs like 192.168.*.
691  mask = "192.168.*";
692  port = 6666;
693 };
694
695 # This is a hidden client port, listening on 168.8.21.107.
696 Port {
697  vhost = "168.8.21.107";
698  hidden = yes;
699  port = 7000;
700 };
701
702 # Quarantine blocks disallow operators from using OPMODE and CLEARMODE
703 # on certain channels.  Opers with the force_opmode (for local
704 # channels, force_local_opmode) privilege may override the quarantine
705 # by prefixing the channel name with an exclamation point ('!').
706 # Wildcards are NOT supported; the channel name must match exactly.
707 Quarantine {
708   "#shells" = "Thou shalt not support the h4><0rz";
709   "&kiddies" = "They can take care of themselves";
710 };
711
712 # This is a server-implemented alias to send a message to a service.
713 # The string after Pseudo is the command name; the name entry inside
714 # is the service name, used for error messages.  More than one nick
715 # entry can be provided; the last one listed has highest priority.
716 Pseudo "CHANSERV" {
717  name = "X";
718  nick = "X@channels.undernet.org";
719 };
720
721 # You can also prepend text before the user's message.
722 Pseudo "LOGIN" {
723  name = "X";
724  prepend = "LOGIN ";
725  nick = "X@channels.undernet.org";
726 };
727
728 # You can ask a separate server whether to allow users to connect.
729 IAuth {
730  pass = "ircd-iauth";
731  host = "127.0.0.1";
732  port = 7700;
733  connectfreq = 30;
734  timeout = 60;
735 };
736
737 # [features]
738 # IRC servers have a large number of options and features.  Most of these
739 # are set at compile time through the use of #define's--see "make config"
740 # for more details--but we are working to move many of these into the
741 # configuration file.  Features let you configure these at runtime.
742 # You only need one feature block in which you use
743 # "featurename" = "value1" , "value2", ..., "valuen-1", "valuen";
744 #
745 # The entire purpose of F:lines are so that you do not have to recompile
746 # the IRCD everytime you want to change a feature.  All of the features
747 # are listed below, and at the bottom is how to set logging.
748 #
749 # A Special Thanks to Kev for writing the documentation of F:lines.  It can
750 # be found at doc/readme.features and the logging documentation can be
751 # found at doc/readme.log.  The defaults used by the Undernet network are
752 # below.
753 #
754 features
755 {
756 # These log features are the only way to get certain error messages
757 # (such as when the server dies from being out of memory).  For more
758 # explanation of how they work, see doc/readme.log.
759  "LOG" = "SYSTEM" "FILE" "ircd.log";
760  "LOG" = "SYSTEM" "LEVEL" "CRIT";
761 #  "DOMAINNAME"="<obtained from /etc/resolv.conf by ./configure>";
762 #  "RELIABLE_CLOCK"="FALSE";
763 #  "BUFFERPOOL"="27000000";
764 #  "HAS_FERGUSON_FLUSHER"="FALSE";
765 #  "CLIENT_FLOOD"="1024";
766 #  "SERVER_PORT"="4400";
767 #  "NODEFAULTMOTD"="TRUE";
768 #  "MOTD_BANNER"="TRUE";
769 #  "KILL_IPMISMATCH"="FALSE";
770 #  "IDLE_FROM_MSG"="TRUE";
771 #  "HUB"="FALSE";
772 #  "WALLOPS_OPER_ONLY"="FALSE";
773 #  "NODNS"="FALSE";
774 #  "RANDOM_SEED"="<you should set one explicitly>";
775 #  "DEFAULT_LIST_PARAM"="TRUE";
776 #  "NICKNAMEHISTORYLENGTH"="800";
777 #  "NETWORK"="UnderNet";
778 #  "HOST_HIDING"="FALSE";
779 #  "HIDDEN_HOST"="users.undernet.org";
780 #  "HIDDEN_IP"="127.0.0.1";
781 #  "KILLCHASETIMELIMIT"="30";
782 #  "MAXCHANNELSPERUSER"="10";
783 #  "NICKLEN" = "12";
784 #  "AVBANLEN"="40";
785 #  "MAXBANS"="30";
786 #  "MAXSILES"="15";
787 #  "HANGONGOODLINK"="300";
788 # "HANGONRETRYDELAY" = "10";
789 # "CONNECTTIMEOUT" = "90";
790 # "MAXIMUM_LINKS" = "1";
791 # "PINGFREQUENCY" = "120";
792 # "CONNECTFREQUENCY" = "600";
793 # "DEFAULTMAXSENDQLENGTH" = "40000";
794 # "GLINEMAXUSERCOUNT" = "20";
795 # "MPATH" = "ircd.motd";
796 # "RPATH" = "remote.motd";
797 # "PPATH" = "ircd.pid";
798 # "TOS_SERVER" = "0x08";
799 # "TOS_CLIENT" = "0x08";
800 # "POLLS_PER_LOOP" = "200";
801 # "IRCD_RES_TIMEOUT" = "4";
802 # "IRCD_RES_RETRIES" = "2";
803 # "AUTH_TIMEOUT" = "9";
804 # "IPCHECK_CLONE_LIMIT" = "4";
805 # "IPCHECK_CLONE_PERIOD" = "40";
806 # "IPCHECK_CLONE_DELAY" = "600";
807 # "CHANNELLEN" = "200";
808 # "CONFIG_OPERCMDS" = "FALSE";
809 # "OPLEVELS" = "TRUE";
810 # "LOCAL_CHANNELS" = "TRUE";
811 # "ANNOUNCE_INVITES" = "FALSE";
812 #  These were introduced by Undernet CFV-165 to add "Head-In-Sand" (HIS)
813 #  behavior to hide most network topology from users.
814 #  "HIS_SNOTICES" = "TRUE";
815 #  "HIS_SNOTICES_OPER_ONLY" = "TRUE";
816 #  "HIS_DEBUG_OPER_ONLY" = "TRUE";
817 #  "HIS_WALLOPS" = "TRUE";
818 #  "HIS_MAP" = "TRUE";
819 #  "HIS_LINKS" = "TRUE";
820 #  "HIS_TRACE" = "TRUE";
821 #  "HIS_STATS_a" = "TRUE";
822 #  "HIS_STATS_c" = "TRUE";
823 #  "HIS_STATS_d" = "TRUE";
824 #  "HIS_STATS_e" = "TRUE";
825 #  "HIS_STATS_f" = "TRUE";
826 #  "HIS_STATS_g" = "TRUE";
827 #  "HIS_STATS_i" = "TRUE";
828 #  "HIS_STATS_j" = "TRUE";
829 #  "HIS_STATS_J" = "TRUE";
830 #  "HIS_STATS_k" = "TRUE";
831 #  "HIS_STATS_l" = "TRUE";
832 #  "HIS_STATS_L" = "TRUE";
833 #  "HIS_STATS_m" = "TRUE";
834 #  "HIS_STATS_M" = "TRUE";
835 #  "HIS_STATS_o" = "TRUE";
836 #  "HIS_STATS_p" = "TRUE";
837 #  "HIS_STATS_q" = "TRUE";
838 #  "HIS_STATS_r" = "TRUE";
839 #  "HIS_STATS_R" = "TRUE";
840 #  "HIS_STATS_t" = "TRUE";
841 #  "HIS_STATS_T" = "TRUE";
842 #  "HIS_STATS_u" = "FALSE";
843 #  "HIS_STATS_U" = "TRUE";
844 #  "HIS_STATS_v" = "TRUE";
845 #  "HIS_STATS_w" = "TRUE";
846 #  "HIS_STATS_x" = "TRUE";
847 #  "HIS_STATS_y" = "TRUE";
848 #  "HIS_STATS_z" = "TRUE";
849 #  "HIS_WHOIS_SERVERNAME" = "TRUE";
850 #  "HIS_WHOIS_IDLETIME" = "TRUE";
851 #  "HIS_WHOIS_LOCALCHAN" = "TRUE";
852 #  "HIS_WHO_SERVERNAME" = "TRUE";
853 #  "HIS_WHO_HOPCOUNT" = "TRUE";
854 #  "HIS_BANWHO" = "TRUE";
855 #  "HIS_KILLWHO" = "TRUE";
856 #  "HIS_REWRITE" = "TRUE";
857 #  "HIS_REMOTE" = "TRUE";
858 #  "HIS_NETSPLIT" = "TRUE";
859 #  "HIS_SERVERNAME" = "*.undernet.org";
860 #  "HIS_SERVERINFO" = "The Undernet Underworld";
861 #  "HIS_URLSERVERS" = "http://www.undernet.org/servers.php";
862 };
863
864 # Well, you have now reached the end of this sample configuration
865 # file. If you have any questions, feel free to mail
866 # <coder-com@undernet.org>.  If you are interested in linking your
867 # server to the Undernet IRC network visit
868 # http://www.routing-com.undernet.org/, and if there are any
869 # problems then contact <routing-com@undernet.org> asking for
870 # information. Upgrades of the Undernet ircd can be found on
871 # http://coder-com.undernet.org/.
872 #
873 # For the rest:  Good Luck!
874 #
875 #       -- Niels.