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