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