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