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