ViewVC Help
View File | Revision Log | Show Annotations | View Changeset | Root Listing
root/svn/ircd-hybrid/trunk/doc/reference.conf
(Generate patch)

Comparing ircd-hybrid/trunk/doc/reference.conf (file contents):
Revision 2150 by michael, Fri May 31 18:39:43 2013 UTC vs.
Revision 4254 by michael, Fri Jul 18 19:07:27 2014 UTC

# Line 1 | Line 1
1 < /* ircd-hybrid reference configuration file
2 < * Copyright (C) 2000-2013 Hybrid Development Team
1 > /*
2 > * This is an example configuration file for ircd-hybrid
3   *
4 < * Written by ejb, wcampbel, db, leeh and others
4 > * Copyright (c) 2000-2014 ircd-hybrid development team
5   *
6   * $Id$
7   */
8  
9   /*
10   * ########################################################################
11 < * IMPORTANT NOTES:
11 > * IMPORTANT NOTE:
12   *
13 < * auth {} blocks MUST be specified in order of precedence.  The first one
14 < * that matches a user will be used.  So place spoofs first, then specials,
13 > * auth {} blocks MUST be specified in order of precedence. The first one
14 > * that matches a user will be used. So place spoofs first, then specials,
15   * then general access.
16   * ########################################################################
17   *
# Line 23 | Line 23
23   *
24   * Times/durations are written as:
25   *        12 hours 30 minutes 1 second
26 < *        
26 > *
27   * Valid units of time:
28   *        year, month, week, day, hour, minute, second
29   *
30   * Valid units of size:
31   *        megabyte/mbyte/mb, kilobyte/kbyte/kb, byte
32   *
33 < * Sizes and times may be singular or plural.  
34 < */
33 > * Sizes and times may be singular or plural.
34 > */
35  
36  
37   /*
# Line 39 | Line 39
39   */
40   serverinfo {
41          /*
42 <         * name: the name of this server.  This cannot be changed at runtime.
42 >         * name: the name of this server. This cannot be changed at runtime.
43           */
44          name = "hades.arpa";
45  
46          /*
47 <         * sid: a server's unique ID.  This is three characters long and must
48 <         * be in the form [0-9][A-Z0-9][A-Z0-9].  The first character must be
47 >         * sid: a server's unique ID. This is three characters long and must
48 >         * be in the form [0-9][A-Z0-9][A-Z0-9]. The first character must be
49           * a digit, followed by 2 alpha-numerical letters.
50 +         *
51           * NOTE: The letters must be capitalized. This cannot be changed at runtime.
52           */
53          sid = "0HY";
# Line 73 | Line 74 | serverinfo {
74           * vhost: the IP to bind to when we connect outward to ipv4 servers.
75           * This should be an ipv4 IP only, or "*" for INADDR_ANY.
76           */
77 <        #vhost = "192.169.0.1";
77 > #       vhost = "192.169.0.1";
78  
79          /*
80 <         * vhost6: the IP to bind to when we connect outward to ipv6 servers.
81 <         * This should be an ipv6 IP only, or "*" for INADDR_ANY.
80 >         * vhost6: the address to bind to when we make outgoing connections
81 >         * to IPv6 servers. This should be an IPv6 address, or "*" for INADDR_ANY.
82           */
83 <        #vhost6 = "3ffe:80e8:546::2";
83 > #       vhost6 = "3ffe:80e8:546::2";
84  
85          /* max_clients: the maximum number of clients allowed to connect. */
86          max_clients = 512;
# Line 98 | Line 99 | serverinfo {
99          max_topic_length = 160;
100  
101          /*
102 <         * rsa_private_key_file: the path to the file containing our
103 <         * rsa key for cryptlink.
102 >         * rsa_private_key_file: the path to the file containing the
103 >         * RSA key.
104 >         *
105 >         * Example commands to store a 2048 bit RSA key in rsa.key:
106           *
104         * Example command to store a 2048 bit RSA keypair in
105         * rsa.key, and the public key in rsa.pub:
106         *
107           *      openssl genrsa -out rsa.key 2048
108 <         *      openssl rsa -in rsa.key -pubout -out rsa.pub
109 <         *      chown <ircd-user>.<ircd.group> rsa.key rsa.pub
108 >         *      chown <ircd-user>.<ircd.group> rsa.key
109           *      chmod 0600 rsa.key
111         *      chmod 0644 rsa.pub
110           */
111 <        #rsa_private_key_file = "/usr/local/ircd/etc/rsa.key";
111 > #       rsa_private_key_file = "etc/rsa.key";
112  
113          /*
114           * ssl_certificate_file: the path to the file containing our
115 <         * ssl certificate for encrypted client connection.
115 >         * SSL certificate for encrypted client connection.
116           *
117           * This assumes your private RSA key is stored in rsa.key. You
118           * MUST have an RSA key in order to generate the certificate.
# Line 132 | Line 130 | serverinfo {
130           *      Common Name: irc.someirc.net
131           *      E-mail: you@domain.com
132           */
133 <        #ssl_certificate_file = "/usr/local/ircd/etc/cert.pem";
133 > #       ssl_certificate_file = "etc/cert.pem";
134  
135          /*
136 <         * ssl_dh_param_file:
137 <         *
138 <         * Path to the PEM encoded Diffie-Hellman parameter file.
141 <         * DH parameters are strictly required when using ciphers
142 <         * with EDH (ephemeral Diffie-Hellman) key exchange.
136 >         * ssl_dh_param_file: path to the PEM encoded Diffie-Hellman
137 >         * parameter file. DH parameters are required when using
138 >         * ciphers with EDH (ephemeral Diffie-Hellman) key exchange.
139           *
140           * A DH parameter file can be created by running:
141           *
142 <         *      openssl dhparam -out dhparam.pem 1024
142 >         *      openssl dhparam -out dhparam.pem 2048
143           *
144           * Prime size must be at least 1024 bits. Further information
145           * regarding specific OpenSSL dhparam command-line options
146           * can be found in the OpenSSL manual.
147           */
148 <        #ssl_dh_param_file = "/usr/local/ircd/etc/dhparam.pem";
148 > #       ssl_dh_param_file = "etc/dhparam.pem";
149  
150          /*
151 <         * ssl_cipher_list:
151 >         * ssl_dh_elliptic_curve: defines the curve to use for the
152 >         * Elliptic Curve Diffie-Hellman (ECDH) algorithm.
153           *
154 <         * List of ciphers that are supported by _this_ server. Can be used to
158 <         * enforce specific ciphers for incoming SSL/TLS connections.
159 <         * If a client (which also includes incoming server connections) isn't
160 <         * capable of any cipher listed below, the connection will simply be
161 <         * rejected.
154 >         * A list of supported curves by OpenSSL can be obtained by running:
155           *
156 <         * A list of supported ciphers can be obtained by running:
156 >         *      openssl ecparam -list_curves
157 >         */
158 > #       ssl_dh_elliptic_curve = "secp521r1";
159 >
160 >        /*
161 >         * ssl_cipher_list: list of ciphers to support on _this_ server.
162 >         * Can be used to enforce specific ciphers for incoming SSL/TLS
163 >         * connections. If a client (which also includes incoming server connections)
164 >         * is not capable of using any of the ciphers listed here, the connection will
165 >         * simply be rejected.
166 >         *
167 >         * A list of supported ciphers by OpenSSL can be obtained by running:
168           *
169           *      openssl ciphers -ssl3 -tls1 -v
170           *
171           * Multiple ciphers are separated by colons. The order of preference is
172           * from left to right.
173           */
174 <        #ssl_cipher_list = "DHE-RSA-AES256-SHA:AES256-SHA";
174 > #       ssl_cipher_list = "ECDHE-RSA-AES256-GCM-SHA384:DHE-RSA-AES256-GCM-SHA384:DHE-RSA-AES256-SHA:AES256-SHA";
175  
176          /*
177 <         * ssl_server_method:
178 <         * ssl_client_method:
177 >         * ssl_message_digest_algorithm: defines what cryptographic hash function
178 >         * to use for generating fingerprint hashes of X.509 certificates.
179 >         * Default is SHA-256 if nothing else is specified.
180           *
181 <         * SSL/TLS methods we provide for incoming (server method) and
182 <         * outgoing (client method) SSL/TLS connections.
183 <         * This can be either sslv3 for SSLv3, and/or tlsv1 for TLSv1.
181 >         * A list of supported message digest algorithms by OpenSSL can be obtained by running:
182 >         *
183 >         *      openssl list-message-digest-algorithms
184           */
185 <        #ssl_server_method = tlsv1, sslv3;
181 <        #ssl_client_method = tlsv1;
185 > #       ssl_message_digest_algorithm = "sha256";
186   };
187  
188   /*
# Line 205 | Line 209 | class {
209  
210          /*
211           * number_per_ip: how many local users are allowed to connect
212 <         * from one IP  (optional)
212 >         * from a single IP address (optional)
213           */
214          number_per_ip = 2;
215  
216          /*
217           * max_local: how many local users are allowed to connect
218 <         * from one ident@host  (optional)
218 >         * from a single ident@host (optional)
219           */
220          max_local = 2;
221  
222          /*
223 <         * max_global: network-wide limit of users per ident@host  (optional)
223 >         * max_global: network-wide limit of users per ident@host (optional)
224           */
225          max_global = 10;
226  
# Line 226 | Line 230 | class {
230          max_number = 100;
231  
232          /*
233 <         * the following lines are optional and allow you to define
233 >         * The following lines are optional and allow you to define
234           * how many users can connect from one /NN subnet.
235           */
236          cidr_bitlen_ipv4 = 24;
# Line 234 | Line 238 | class {
238          number_per_cidr = 16;
239  
240          /*
241 <         * sendq: the amount of data allowed in a clients send queue before
241 >         * sendq: the amount of data allowed in a client's send queue before
242           * they are dropped.
243           */
244          sendq = 100 kbytes;
245  
246          /*
247 <         * recvq: maximum amount of data in a clients receive queue before
247 >         * recvq: the amount of data allowed in a client's receive queue before
248           * they are dropped for flooding. Defaults to 2560 if the chosen
249           * value isn't within the range of 512 to 8000.
250           */
# Line 254 | Line 258 | class {
258          max_number = 100;
259          sendq = 100 kbytes;
260  
261 +
262 +        /*
263 +         * max_channels: maximum number of channels users in this class can join.
264 +         */
265 +        max_channels = 60;
266 +
267          /*
268           * min_idle: minimum idle time that is shown in /whois.
269           */
# Line 267 | Line 277 | class {
277          /*
278           * flags:
279           *
280 <         * random_idle          - idle time is randomly selected within the
281 <         *                        range of min_idle to max_idle
282 <         * hide_idle_from_opers - fake idle time will be shown to operators, too
280 >         * random_idle          - a fake idle time is set randomly between
281 >         *                        min_idle and max_idle
282 >         * hide_idle_from_opers - the fake idle time will also be shown to operators
283           */
284          flags = random_idle, hide_idle_from_opers;
285   };
# Line 284 | Line 294 | class {
294           */
295          connectfreq = 5 minutes;
296  
297 <        /* max number: the amount of servers to autoconnect to. */
297 >        /* max number: the number of servers to autoconnect to. */
298          max_number = 1;
299  
300          /* sendq: servers need a higher sendq as they send more data. */
# Line 292 | Line 302 | class {
302   };
303  
304   /*
305 < * motd {}: specifies various MOTD files. Applies to local users only.
305 > * motd {}: Allows the display of a different MOTD to a client
306 > * depending on its origin. Applies to local users only.
307   */
308   motd {
309          /*
310           * mask: multiple mask entries are permitted. Mask can either be
311 <         * a class name or a hostname.
311 >         * a class name or a hostname. CIDR is supported.
312           */
313          mask = "*.at";
314          mask = "*.de";
315          mask = "*.ch";
316  
317          /*
318 <         * file: path top the actual motd file.
318 >         * file: path to the actual motd file.
319           */
320 <        file = "/usr/local/ircd/etc/german.motd";
320 >        file = "etc/german.motd";
321   };
322  
323   /*
# Line 314 | Line 325 | motd {
325   */
326   listen {
327          /*
328 <         * port: the specific port to listen on. If no host is specified
329 <         * before, it will listen on all available IPs.
328 >         * port: the port to listen on. If no host is specified earlier
329 >         * in the listen {} block, it will listen on all available IPs.
330           *
331 <         * Ports are separated via a comma, a range may be specified using ".."
331 >         * Ports are separated by commas; a range may be specified using ".."
332           */
333 <        
334 <        /* port: listen on all available IPs, ports 6665 to 6669 */
333 >
334 >        /* port: listen on all available IP addresses, ports 6665 to 6669 */
335          port = 6665 .. 6669;
336  
337          /*
338 <         * Listen on 192.168.0.1/6697 with ssl enabled and hidden from STATS P
338 >         * Listen on 192.168.0.1/6697 with SSL enabled and hidden from STATS P
339           * unless you are an administrator.
340           *
341 <         * NOTE: The "flags" directive has to come before "port". Always!
341 >         * NOTE: The "flags" directive always has to come before "port".
342           *
343           * Currently available flags are:
344           *
# Line 340 | Line 351 | listen {
351          port = 6697;
352  
353          /*
354 <         * host: set a specific IP/host the ports after the line will listen
355 <         * on. This may be ipv4 or ipv6.
354 >         * host: set a specific IP address/host to listen on using the
355 >         * subsequent port definitions. This may be IPv4 or IPv6.
356           */
357          host = "1.2.3.4";
358          port = 7000, 7001;
# Line 356 | Line 367 | listen {
367   auth {
368          /*
369           * user: the user@host allowed to connect. Multiple user
370 <         * lines are permitted per auth block.
370 >         * lines are permitted within each auth block.
371           */
372          user = "*@172.16.0.0/12";
373          user = "*test@123D:B567:*";
374  
375 <        /* password: an optional password that is required to use this block */
375 >        /* password: an optional password that is required to use this block. */
376          password = "letmein";
377  
378          /*
# Line 371 | Line 382 | auth {
382          encrypted = yes;
383  
384          /*
385 <         * spoof: fake the users host to this. This is free-form, just do
385 >         * spoof: fake the user's host to this. This is free-form, just do
386           * everyone a favor and don't abuse it. ('=' prefix on /stats I)
387           */
388          spoof = "I.still.hate.packets";
389  
390 <        /* class: the class the user is placed in */
390 >        /* class: the class the user is placed in. */
391          class = "opers";
392  
393          /*
# Line 401 | Line 412 | auth {
412   auth {
413          /*
414           * redirect: the server and port to redirect a user to. A user does not
415 <         * have to obey the redirection, the ircd just suggests an alternative
415 >         * have to obey the redirection; the ircd just suggests an alternative
416           * server for them.
417           */
418          redirserv = "this.is.not.a.real.server";
419          redirport = 6667;
420 <        
420 >
421          user = "*.server";
422  
423 <        /* class: a class is required even though it is not used */
423 >        /* class: a class is required even though it is not used. */
424          class = "users";
425   };
426  
# Line 427 | Line 438 | operator {
438          name = "sheep";
439  
440          /*
441 <         * user: the user@host required for this operator. Multiple
442 <         * user="" lines are supported.
441 >         * user: the user@host required for this operator. Multiple user
442 >         * lines are permitted within each operator block.
443           */
444          user = "*sheep@192.168.0.0/16";
445          user = "*@127.0.0.0/8";
# Line 438 | Line 449 | operator {
449           * need to be encrypted by using the provided mkpasswd tool.
450           * Several password hash algorithms are available depending
451           * on your system's crypt() implementation. For example, a modern
452 <         * glibc already has support for SHA-256/512, and MD5 encryption
452 >         * glibc already has support for the SHA-256/512 and MD5 encryption
453           * algorithms.
454           */
455          password = "$5$x5zof8qe.Yc7/bPp$5zIg1Le2Lsgd4CvOjaD20pr5PmcfD7ha/9b2.TaUyG4";
# Line 451 | Line 462 | operator {
462  
463          /*
464           * rsa_public_key_file: the public key for this oper when using Challenge.
465 <         * A password should not be defined when this is used, see
465 >         * A password should not be defined when this is used; see
466           * doc/challenge.txt for more information.
467           */
468 < #       rsa_public_key_file = "/usr/local/ircd/etc/oper.pub";
468 > #       rsa_public_key_file = "etc/oper.pub";
469 >
470 >        /*
471 >         * ssl_certificate_fingerprint: enhances security by additionally checking
472 >         * the oper's client certificate fingerprint against the specified
473 >         * fingerprint below.
474 >         *
475 >         * Hint: your users can use the following command to obtain a SHA-256 hash
476 >         * of their ssl certificate:
477 >         *
478 >         *      openssl x509 -sha256 -noout -fingerprint -in cert.pem | sed -e 's/^.*=//;s/://g'
479 >         */
480 > #       ssl_certificate_fingerprint = "4C62287BA6776A89CD4F8FF10A62FFB35E79319F51AF6C62C674984974FCCB1D";
481  
482 <        /* class: the class the oper joins when they successfully /oper */
482 >        /*
483 >         * ssl_connection_required: client must be connected over SSL/TLS
484 >         * in order to be able to use this oper{} block.
485 >         * Default is 'no' if nothing else is specified.
486 >         */
487 >        ssl_connection_required = no;
488 >
489 >        /* class: the class the oper joins when they successfully /oper or /challenge. */
490          class = "opers";
491  
492          /*
493 <         * umodes: default usermodes opers get when they /oper. If defined,
494 <         * it will override oper_umodes settings in general {}.
493 >         * umodes: the default usermodes opers get when they /oper or /challenge.
494 >         * If defined, it will override oper_umodes settings in general {}.
495           * Available usermodes:
496           *
497           * +b - bots         - See bot and drone flooding notices
498           * +c - cconn        - Client connection/quit notices
469         * +C - cconn_full   - Client connection/quit notices full
499           * +D - deaf         - Don't receive channel messages
500           * +d - debug        - See debugging notices
501           * +e - external     - See remote server connection and split notices
# Line 475 | Line 504 | operator {
504           * +G - softcallerid - Server Side Ignore for users not on your channels
505           * +g - callerid     - Server Side Ignore (for privmsgs etc)
506           * +H - hidden       - Hides operator status to other users
507 <         * +i - invisible    - Not shown in NAMES or WHO unless you share a
479 <         *                     a channel
507 >         * +i - invisible    - Not shown in NAMES or WHO unless you share a channel
508           * +j - rej          - See rejected client notices
509           * +k - skill        - See server generated KILL messages
510           * +l - locops       - See LOCOPS messages
511           * +n - nchange      - See client nick changes
512 +         * +p - hidechans    - Hides channel list in WHOIS
513 +         * +q - hideidle     - Hides idle and signon time in WHOIS
514           * +R - nononreg     - Only receive private messages from registered clients
515           * +s - servnotice   - See general server notices
516           * +u - unauth       - See unauthorized client notices
517           * +w - wallop       - See server generated WALLOPS
518           * +y - spy          - See LINKS, STATS, TRACE notices etc.
489         * +z - operwall     - See oper generated WALLOPS
519           */
520 < #       umodes = locops, servnotice, operwall, wallop;
520 >        umodes = locops, servnotice, wallop;
521  
522          /*
523 <         * privileges: controls the activities and commands an oper is
524 <         * allowed to do on the server. All options default to no.
523 >         * privileges: controls the activities and commands an oper is
524 >         * allowed to do on the server. All options default to 'no'.
525           * Available options:
526           *
527           * module         - allows MODULE
# Line 509 | Line 538 | operator {
538           * unkline        - allows UNKLINE                    | ('U' flag)
539           * gline          - allows GLINE                      | ('G' flag)
540           * xline          - allows XLINE                      | ('X' flag)
541 +         * unxline        - allows UNXLINE                    |
542           * locops         - allows LOCOPS                     |
543           * globops        - allows GLOBOPS                    |
544           * wallops        - allows WALLOPS                    |
515         * operwall       - allows OPERWALL                   | ('L' flag)
545           * rehash         - allows oper to REHASH config      | ('H' flag)
546           * die            - allows DIE                        | ('D' flag)
547           * restart        - allows RESTART                    |
# Line 520 | Line 549 | operator {
549           * admin          - gives administrator privileges    | ('A' flag)
550           */
551          flags = kill, kill:remote, connect, connect:remote, kline, unkline,
552 <                xline, globops, restart, die, rehash, admin, operwall, module;
552 >                xline, globops, restart, die, rehash, admin, module;
553   };
554  
555   /*
556 < * service {}: specifies what server may act as a network service
556 > * service {}: specifies a server which may act as a network service
557   *
558 < * NOTE: it is absolutely important that every single server on the network
558 > * NOTE: it is very important that every server on the network
559   *       has the same service{} block.
560   */
561   service {
# Line 535 | Line 564 | service {
564   };
565  
566   /*
567 < * connect {}:  controls servers we connect to
567 > * connect {}: define a server to connect to
568   */
569   connect {
570 <        /* name: the name of the server */
570 >        /* name: the name of the server. */
571          name = "irc.uplink.com";
572  
573          /*
574 <         * host: the host or IP to connect to. If a hostname is used it
575 <         * must match the reverse dns of the server.
574 >         * host: the host or IP address to connect to. If a hostname is used it
575 >         * must match the reverse DNS of the server.
576           */
577          host = "192.168.0.1";
578  
579          /*
580 <         * vhost: the IP to bind to when we connect outward to servers.
580 >         * vhost: the IP address to bind to when making outgoing connections to
581 >         * servers.
582           * serverinfo::vhost and serverinfo::vhost6 will be overridden
583           * by this directive.
584           */
585          vhost = "192.168.0.2";
586  
587          /*
588 <         * passwords: the passwords we send (OLD C:) and accept (OLD N:).
589 <         * The remote server will have these passwords reversed.
588 >         * passwords: the passwords to send (OLD C:) and accept (OLD N:).
589 >         * The remote server will have these passwords swapped.
590           */
591          send_password = "password";
592          accept_password = "anotherpassword";
# Line 567 | Line 597 | connect {
597           */
598          encrypted = no;
599  
600 <        /* port: the port to connect to this server on */
600 >        /* port: the port to connect to this server on. */
601          port = 6666;
602  
603          /*
# Line 582 | Line 612 | connect {
612           */
613   #       leaf_mask = "*.uk";
614  
615 <        /* class: the class this server is in */
615 >        /* class: the class this server is in. */
616          class = "server";
617  
618          /*
619 <         * ssl_cipher_list:
620 <         *
621 <         * List of ciphers that the server we are connecting to must support.
592 <         * If the server isn't capable of any cipher listed below, the
593 <         * connection will simply be rejected.
619 >         * ssl_cipher_list: list of ciphers that the server we are connecting to
620 >         * must support. If the server is not capable of using any of the ciphers
621 >         * listed below, the connection will simply be rejected.
622           * Can be used to enforce stronger ciphers, even though this option
623           * is not necessarily required to establish a SSL/TLS connection.
624           *
625           * Multiple ciphers are separated by colons. The order of preference
626           * is from left to right.
627           */
628 <        #ssl_cipher_list = "DHE-RSA-AES256-SHA:AES256-SHA";
628 > #       ssl_cipher_list = "ECDHE-RSA-AES256-GCM-SHA384:DHE-RSA-AES256-GCM-SHA384:DHE-RSA-AES256-SHA:AES256-SHA";
629 >
630 >        /*
631 >         * ssl_certificate_fingerprint: enhances security by additionally checking
632 >         * the server's client certificate fingerprint against the specified
633 >         * fingerprint below.
634 >         */
635 > #       ssl_certificate_fingerprint = "4C62287BA6776A89CD4F8FF10A62FFB35E79319F51AF6C62C674984974FCCB1D";
636  
637          /*
638           * autoconn   - controls whether we autoconnect to this server or not,
# Line 628 | Line 663 | connect {
663   */
664   cluster {
665          /*
666 <         * name: the server to share with, this can take wildcards
666 >         * name: the server to share with; this can take wildcards
667           *
668 <         * NOTE: only local actions will be clustered, meaning if
668 >         * NOTE: only local actions will be clustered, meaning that if
669           *       the server receives a shared kline/unkline/etc, it
670           *       will not be propagated to clustered servers.
671           *
# Line 641 | Line 676 | cluster {
676          name = "*.arpa";
677  
678          /*
679 <         * type: list of what to share, options are as follows:
679 >         * type: list of what to share; options are as follows:
680           *      dline   - share dlines
681           *      undline - share undlines
682           *      kline   - share klines
# Line 659 | Line 694 | cluster {
694   /*
695   * shared {}: users that are allowed to remote kline
696   *
697 < * NOTE: This can be effectively used for remote klines.
697 > * NOTE: This can effectively be used for remote klines.
698   *       Please note that there is no password authentication
699   *       for users setting remote klines. You must also be
700   *       /oper'd in order to issue a remote kline.
701   */
702   shared {
703          /*
704 <         * name: the server the user must be on to set klines. If this is not
705 <         * specified, the user will be allowed to kline from all servers.
704 >         * name: the server the user must be connected to in order to set klines.
705 >         * If this is not specified, the user will be allowed to kline from all
706 >         * servers.
707           */
708          name = "irc2.some.server";
709  
# Line 704 | Line 740 | kill {
740   };
741  
742   /*
743 < * deny {}:  IPs that are not allowed to connect (before DNS/ident lookup)
743 > * deny {}:  IP addresses that are not allowed to connect
744 > * (before DNS/ident lookup)
745   * Oper issued dlines will be added to the specified dline config
746   */
747   deny {
# Line 713 | Line 750 | deny {
750   };
751  
752   /*
753 < * exempt {}:  IPs that are exempt from deny {} and Dlines
753 > * exempt {}:  IP addresses that are exempt from deny {} and Dlines
754   */
755   exempt {
756          ip = "192.168.0.0/16";
# Line 723 | Line 760 | exempt {
760   * resv {}:  nicks and channels users may not use/join
761   */
762   resv { mask = "clone*"; reason = "Clone bots"; };
763 + resv { mask = "Global"; reason = "Reserved for services"; };
764   resv { mask = "ChanServ"; reason = "Reserved for services"; };
765   resv { mask = "NickServ"; reason = "Reserved for services"; };
766   resv { mask = "OperServ"; reason = "Reserved for services"; };
# Line 736 | Line 774 | resv { mask = "#*services*"; reason = "R
774   resv {
775          /*
776           * mask: masks starting with a '#' are automatically considered
777 <         * as channel name mask.
777 >         * as channel name masks.
778           */
779          mask = "#helsinki";
780 <        reason = "Channel is reserved for finnish inhabitants";
780 >        reason = "Channel is reserved for Finnish inhabitants";
781  
782          /*
783           * exempt: can be either a ISO 3166 alpha-2 two letter country
# Line 768 | Line 806 | gecos {
806   channel {
807          /*
808           * disable_fake_channels: this option, if set to 'yes', will
809 <         * disallow clients to create or join channels that have one
809 >         * disallow clients from creating or joining channels that have one
810           * of the following ASCII characters in their name:
811           *
812           *   2 | bold
# Line 782 | Line 820 | channel {
820          disable_fake_channels = yes;
821  
822          /*
823 <         * knock_delay: The amount of time a user must wait between issuing
824 <         * the knock command.
823 >         * invite_client_count, invite_client_time: how many INVITE commands
824 >         * are permitted per client per invite_client_time.
825           */
826 <        knock_delay = 5 minutes;
826 >        invite_client_count = 10;
827 >        invite_client_time = 5 minutes;
828  
829          /*
830 <         * knock_delay_channel: How often a knock to any specific channel
831 <         * is permitted, regardless of the user sending the knock.
830 >         * knock_client_count, knock_client_time: how many KNOCK commands
831 >         * are permitted per client per knock_client_time.
832           */
833 <        knock_delay_channel = 1 minute;
833 >        knock_client_count = 1;
834 >        knock_client_time = 5 minutes;
835  
836          /*
837 <         * max_chans_per_user: The maximum number of channels a user can
838 <         * join/be on.
837 >         * knock_delay_channel: how often a KNOCK to any specific channel
838 >         * is permitted, regardless of the user sending the KNOCK.
839           */
840 <        max_chans_per_user = 25;
840 >        knock_delay_channel = 1 minute;
841  
842          /*
843 <         * max_chans_per_oper: The maximum number of channels an oper can
844 <         * join/be on.
843 >         * max_channels: the maximum number of channels a user can join/be on.
844 >         * This is a default value which can be overriden with class{} blocks.
845           */
846 <        max_chans_per_oper = 50;
846 >        max_channels = 25;
847  
848          /* max_bans: maximum number of +b/e/I modes in a channel */
849          max_bans = 100;
850  
851          /*
852 <         * how many joins in how many seconds constitute a flood, use 0 to
852 >         * how many joins in how many seconds constitute a flood. Use 0 to
853           * disable. +b opers will be notified (changeable via /set)
854           */
855          join_flood_count = 16;
856          join_flood_time = 8 seconds;
857  
858          /*
859 <         * splitcode: The ircd will now check splitmode every few seconds.
859 >         * The ircd will now check splitmode (whether a server is split from
860 >         * the network) every few seconds; this functionality is known as
861 >         * splitcode and is influenced by the options below.
862           *
863           * Either split users or split servers can activate splitmode, but
864           * both conditions must be met for the ircd to deactivate splitmode.
865 <         *
865 >         *
866           * You may force splitmode to be permanent by /quote set splitmode on
867           */
868  
# Line 836 | Line 878 | channel {
878           */
879          default_split_server_count = 0;
880  
881 <        /* no_create_on_split: disallow users creating channels on split. */
881 >        /* no_create_on_split: do not allow users to create channels on split. */
882          no_create_on_split = yes;
883  
884 <        /* no_join_on_split: disallow users joining channels at all on a split. */
884 >        /* no_join_on_split: do not allow users to join channels on a split. */
885          no_join_on_split = no;
886   };
887  
888   /*
889   * serverhide {}:  The serverhide block contains the options regarding
890 < * serverhiding
890 > * to server hiding. For more information regarding server hiding,
891 > * please see doc/serverhide.txt
892   */
893   serverhide {
894          /*
895 +         * disable_remote_commands: disable users issuing commands
896 +         * on remote servers.
897 +         */
898 +        disable_remote_commands = no;
899 +
900 +        /*
901           * flatten_links: this option will show all servers in /links appear
902 <         * that they are linked to this current server.
902 >         * as though they are linked to this current server.
903           */
904          flatten_links = no;
905  
# Line 885 | Line 934 | serverhide {
934  
935          /*
936           * hide_server_ips: If this is disabled, opers will be unable to see
937 <         * servers ips and will be shown a masked ip, admins will be shown the
938 <         * real ip.
937 >         * servers' IP addresses and will be shown a masked IP address; admins
938 >         * will be shown the real IP address.
939           *
940 <         * If this is enabled, nobody can see a servers ip. *This is a kludge*,
941 <         * it has the side effect of hiding the ips everywhere, including
942 <         * logfiles.
940 >         * If this is enabled, nobody can see a server's IP address.
941 >         * *This is a kludge*: it has the side effect of hiding the IP addresses
942 >         * everywhere, including logfiles.
943           *
944           * We recommend you leave this disabled, and just take care with who you
945           * give administrator privileges to.
# Line 903 | Line 952 | serverhide {
952   * compiled in options in config.h
953   */
954   general {
955 <        /* services_name: servername of nick/channel services */
955 >        /*
956 >         * cycle_on_host_change: sends a fake QUIT/JOIN combination
957 >         * when services change the hostname of a specific client.
958 >         */
959 >        cycle_on_host_change = yes;
960 >
961 >        /* services_name: servername of nick/channel services. */
962          services_name = "service.someserver";
963  
964          /* max_watch: maximum WATCH entries a client can have. */
965 <        max_watch = 60;
965 >        max_watch = 30;
966  
967 <        /* gline_enable: enable glines, network wide temp klines. */
967 >        /* max_accept: maximum allowed /accept's for +g usermode. */
968 >        max_accept = 30;
969 >
970 >        /* gline_enable: enable glines (network-wide temporary klines). */
971          gline_enable = yes;
972  
973          /*
974 <         * gline_duration: the amount of time a gline will remain on your
974 >         * gline_duration: the amount of time a G-line will remain on your
975           * server before expiring.
976           */
977          gline_duration = 1 day;
# Line 926 | Line 984 | general {
984  
985          /*
986           * gline_min_cidr: the minimum required length of a CIDR bitmask
987 <         * for IPv4 based glines.
987 >         * for IPv4 based G-lines.
988           */
989          gline_min_cidr = 16;
990  
991          /*
992           * gline_min_cidr6: the minimum required length of a CIDR bitmask
993 <         * for IPv6 based glines.
993 >         * for IPv6 based G-lines.
994           */
995          gline_min_cidr6 = 48;
996  
997          /*
998 <         * Whether to automatically set mode +i on connecting users.
998 >         * invisible_on_connect: whether to automatically set mode +i on
999 >         * connecting users.
1000           */
1001          invisible_on_connect = yes;
1002  
1003          /*
1004 <         * kill_chase_time_limit: maximum time from the nickname change that
1005 <         * still causes KILL automatically to switch for the current nick of
1006 <         * that user.
1004 >         * kill_chase_time_limit: KILL chasing is a feature whereby a KILL
1005 >         * issued for a user who has recently changed nickname will be applied
1006 >         * automatically to the new nick. kill_chase_time_limit is the maximum
1007 >         * time following a nickname change that this chasing will apply.
1008           */
1009 <        kill_chase_time_limit = 90 seconds;
1009 >        kill_chase_time_limit = 30 seconds;
1010  
1011          /*
1012           * hide_spoof_ips: if disabled, opers will be allowed to see the real
1013 <         * IP of spoofed users in /trace etc. If this is defined they will be
1014 <         * shown a masked IP.
1013 >         * IP address of spoofed users in /trace etc. If this is defined they
1014 >         * will be shown a masked IP.
1015           */
1016          hide_spoof_ips = yes;
1017  
1018          /*
1019 <         * Ignore bogus timestamps from other servers. Yes, this will desync the
1020 <         * network, but it will allow chanops to resync with a valid non TS 0
1019 >         * ignore_bogus_ts: ignore bogus timestamps from other servers.
1020 >         * Yes, this will desync the network, but it will allow chanops
1021 >         * to resync with a valid non TS 0.
1022           *
1023           * This should be enabled network wide, or not at all.
1024           */
# Line 969 | Line 1030 | general {
1030           */
1031          disable_auth = no;
1032  
972        /* disable_remote_commands: disable users doing commands on remote servers. */
973        disable_remote_commands = no;
974
1033          /*
1034           * tkline_expire_notices: enables or disables temporary kline/xline
1035           * expire notices.
# Line 980 | Line 1038 | general {
1038  
1039          /*
1040           * default_floodcount: the default value of floodcount that is configurable
1041 <         * via /quote set floodcount. This is the amount of lines a user
1042 <         * may send to any other user/channel in one second.
1041 >         * via /quote set floodcount. This is the number of lines a user may send
1042 >         * to any other user/channel in one second.
1043           */
1044          default_floodcount = 10;
1045  
1046          /*
1047 <         * failed_oper_notice: send a notice to all opers on the server when
1047 >         * failed_oper_notice: send a notice to all opers on the server when
1048           * someone tries to OPER and uses the wrong password, host or ident.
1049           */
1050          failed_oper_notice = yes;
1051  
1052          /*
1053 <         * dots_in_ident: the amount of '.' characters permitted in an ident
1053 >         * dots_in_ident: the number of '.' characters permitted in an ident
1054           * reply before the user is rejected.
1055           */
1056          dots_in_ident = 2;
1057  
1058          /*
1059 <         * min_nonwildcard: the minimum non wildcard characters in k/d/g lines
1060 <         * placed via the server. K-lines hand placed are exempt from limits.
1061 <         * Wildcard chars: '.', ':', '*', '?', '@', '!'
1059 >         * min_nonwildcard: the minimum number of non-wildcard characters in
1060 >         * k/d/g lines placed via the server. K-lines hand-placed are exempt from
1061 >         * this limit.
1062 >         * Wildcard characters: '.', ':', '*', '?', '@', '!'
1063           */
1064          min_nonwildcard = 4;
1065  
1066          /*
1067 <         * min_nonwildcard_simple: the minimum non wildcard characters in
1068 <         * gecos bans. Wildcard chars: '*', '?'
1067 >         * min_nonwildcard_simple: the minimum number of non-wildcard characters
1068 >         * in gecos bans. Wildcard characters: '*', '?'
1069           */
1070          min_nonwildcard_simple = 3;
1071  
1013        /* max_accept: maximum allowed /accept's for +g usermode. */
1014        max_accept = 20;
1015
1072          /* anti_nick_flood: enable the nickflood control code. */
1073          anti_nick_flood = yes;
1074  
1075 <        /* nick flood: the nick changes allowed in the specified period */
1075 >        /* nick flood: the number of nick changes allowed in the specified period. */
1076          max_nick_time = 20 seconds;
1077          max_nick_changes = 5;
1078  
# Line 1027 | Line 1083 | general {
1083          anti_spam_exit_message_time = 5 minutes;
1084  
1085          /*
1086 <         * ts delta: the time delta allowed between server clocks before
1087 <         * a warning is given, or before the link is dropped. All servers
1088 <         * should run ntpdate/rdate to keep clocks in sync
1086 >         * ts_warn_delta, ts_max_delta: the time delta allowed between server
1087 >         * clocks before a warning is given, or before the link is dropped.
1088 >         * All servers should run ntpdate/rdate to keep clocks in sync.
1089           */
1090 <        ts_warn_delta = 30 seconds;
1091 <        ts_max_delta = 5 minutes;
1090 >        ts_warn_delta = 10 seconds;
1091 >        ts_max_delta = 2 minutes;
1092  
1093          /*
1094 <         * warn_no_nline: warn opers about servers that try to connect but
1095 <         * we don't have a connect {} block for. Twits with misconfigured
1096 <         * servers can get really annoying with this enabled.
1094 >         * warn_no_connect_block: warn opers about servers that try to connect
1095 >         * but for which we don't have a connect {} block. Twits with
1096 >         * misconfigured servers can become really annoying with this enabled.
1097           */
1098 <        warn_no_nline = yes;
1098 >        warn_no_connect_block = yes;
1099  
1100          /*
1101           * stats_e_disabled: set this to 'yes' to disable "STATS e" for both
1102           * operators and administrators. Doing so is a good idea in case
1103 <         * there are any exempted (exempt{}) server IPs you don't want to
1103 >         * there are any exempted (exempt {}) server IPs you don't want to
1104           * see leaked.
1105           */
1106          stats_e_disabled = no;
1107  
1108 <        /* stats_o_oper only: make stats o (opers) oper only */
1108 >        /* stats_o_oper_only: make stats o (opers) oper only. */
1109          stats_o_oper_only = yes;
1110  
1111 <        /* stats_P_oper_only: make stats P (ports) oper only */
1111 >        /* stats_P_oper_only: make stats P (ports) oper only. */
1112          stats_P_oper_only = yes;
1113  
1114 +        /* stats_u_oper_only: make stats u (uptime) oper only. */
1115 +        stats_u_oper_only = no;
1116 +
1117          /*
1118 <         * stats i oper only: make stats i (auth {}) oper only. Set to:
1118 >         * stats_i_oper_only: make stats i (auth {}) oper only. Set to:
1119           *     yes    - show users no auth blocks, made oper only.
1120 <         *     masked - show users first matching auth block
1120 >         *     masked - show users the first matching auth block
1121           *     no     - show users all auth blocks.
1122           */
1123          stats_i_oper_only = yes;
# Line 1066 | Line 1125 | general {
1125          /*
1126           * stats_k_oper_only: make stats k/K (klines) oper only. Set to:
1127           *     yes    - show users no auth blocks, made oper only
1128 <         *     masked - show users first matching auth block
1128 >         *     masked - show users the first matching auth block
1129           *     no     - show users all auth blocks.
1130           */
1131          stats_k_oper_only = yes;
# Line 1084 | Line 1143 | general {
1143          opers_bypass_callerid = no;
1144  
1145          /*
1146 <         * pace_wait_simple: time between use of less intensive commands
1147 <         * (ADMIN, HELP, (L)USERS, VERSION, remote WHOIS)
1146 >         * pace_wait_simple: minimum time required between use of less
1147 >         * intensive commands
1148 >         * (ADMIN, HELP, LUSERS, VERSION, remote WHOIS)
1149           */
1150          pace_wait_simple = 1 second;
1151  
1152          /*
1153 <         * pace_wait: time between more intensive commands
1154 <         * (AWAY, INFO, LINKS, MAP, MOTD, STATS, WHO, wildcard WHOIS, WHOWAS)
1153 >         * pace_wait: minimum time required between use of more intensive commands
1154 >         * (AWAY, INFO, LINKS, MAP, MOTD, STATS, WHO, WHOWAS)
1155           */
1156          pace_wait = 10 seconds;
1157  
1158          /*
1159 <         * short_motd: send clients a notice telling them to read the motd
1160 <         * instead of forcing a motd to clients who may simply ignore it.
1159 >         * short_motd: send clients a notice telling them to read the MOTD
1160 >         * instead of forcing an MOTD to clients who may simply ignore it.
1161           */
1162          short_motd = no;
1163  
1164          /*
1165 <         * ping_cookie: require clients to respond exactly to a ping command,
1165 >         * ping_cookie: require clients to respond exactly to a PING command,
1166           * can help block certain types of drones and FTP PASV mode spoofing.
1167           */
1168          ping_cookie = no;
# Line 1112 | Line 1172 | general {
1172  
1173          /*
1174           * true_no_oper_flood: completely eliminate flood limits for opers
1175 <         * and for clients with can_flood = yes in their auth {} blocks.
1175 >         * and for clients with 'can_flood' in their auth {} blocks.
1176           */
1177          true_no_oper_flood = yes;
1178  
1179          /* oper_pass_resv: allow opers to over-ride RESVs on nicks/channels. */
1180          oper_pass_resv = yes;
1181  
1182 <        /* REMOVE ME.  The following line checks you've been reading. */
1182 >        /* REMOVE ME. The following line checks that you have been reading. */
1183          havent_read_conf = 1;
1184  
1185          /*
1186 <         * max_targets: the maximum amount of targets in a single
1186 >         * max_targets: the maximum number of targets in a single
1187           * PRIVMSG/NOTICE. Set to 999 NOT 0 for unlimited.
1188           */
1189          max_targets = 4;
# Line 1133 | Line 1193 | general {
1193           *
1194           * +b - bots         - See bot and drone flooding notices
1195           * +c - cconn        - Client connection/quit notices
1136         * +C - cconn_full   - Client connection/quit notices full
1196           * +D - deaf         - Don't receive channel messages
1197           * +d - debug        - See debugging notices
1198           * +e - external     - See remote server connection and split notices
# Line 1142 | Line 1201 | general {
1201           * +G - softcallerid - Server Side Ignore for users not on your channels
1202           * +g - callerid     - Server Side Ignore (for privmsgs etc)
1203           * +H - hidden       - Hides operator status to other users
1204 <         * +i - invisible    - Not shown in NAMES or WHO unless you share a
1146 <         *                     a channel
1204 >         * +i - invisible    - Not shown in NAMES or WHO unless you share a channel
1205           * +j - rej          - See rejected client notices
1206           * +k - skill        - See server generated KILL messages
1207           * +l - locops       - See LOCOPS messages
1208           * +n - nchange      - See client nick changes
1209 +         * +p - hidechans    - Hides channel list in WHOIS
1210 +         * +q - hideidle     - Hides idle and signon time in WHOIS
1211           * +R - nononreg     - Only receive private messages from registered clients
1212           * +s - servnotice   - See general server notices
1213           * +u - unauth       - See unauthorized client notices
1214           * +w - wallop       - See server generated WALLOPS
1215           * +y - spy          - See LINKS, STATS, TRACE notices etc.
1156         * +z - operwall     - See oper generated WALLOPS
1216           */
1217  
1218 <        /* oper_only_umodes: usermodes only opers may set */
1219 <        oper_only_umodes = bots, cconn, cconn_full, debug, full, hidden, skill,
1220 <                           nchange, rej, spy, external, operwall,
1221 <                           locops, unauth, farconnect;
1218 >        /* oper_only_umodes: usermodes only opers may set. */
1219 >        oper_only_umodes = bots, cconn, debug, full, hidden, skill,
1220 >                        nchange, rej, spy, external,
1221 >                        locops, unauth, farconnect;
1222  
1223 <        /* oper_umodes: default usermodes opers get when they /oper */
1224 <        oper_umodes = bots, locops, servnotice, operwall, wallop;
1223 >        /* oper_umodes: default usermodes opers get when they /oper or /challenge. */
1224 >        oper_umodes = bots, locops, servnotice, wallop;
1225  
1226          /*
1227 <         * use_egd: if your system does not have *random devices yet you
1228 <         * want to use OpenSSL and encrypted links, enable this. Beware -
1170 <         * EGD is *very* CPU intensive when gathering data for its pool.
1227 >         * throttle_count: the maximum number of connections from the same
1228 >         * IP address allowed in throttle_time duration.
1229           */
1230 < #       use_egd = yes;
1230 >        throttle_count = 1;
1231  
1232          /*
1233 <         * egdpool_path: path to EGD pool. Not necessary for OpenSSL >= 0.9.7
1234 <         * which automatically finds the path.
1235 <         */
1178 < #       egdpool_path = "/var/run/egd-pool";
1179 <
1180 <        /*
1181 <         * throttle_time: the minimum amount of time between connections from
1182 <         * the same ip. exempt {} blocks are excluded from this throttling.
1233 >         * throttle_time: the minimum amount of time required between
1234 >         * connections from the same IP address. exempt {} blocks are
1235 >         * excluded from this throttling.
1236           * Offers protection against flooders who reconnect quickly.
1237           * Set to 0 to disable.
1238           */
1239 <        throttle_time = 10;
1239 >        throttle_time = 2 seconds;
1240   };
1241  
1242   modules {
# Line 1191 | Line 1244 | modules {
1244           * path: other paths to search for modules specified below
1245           * and in "/module load".
1246           */
1247 <        path = "/usr/local/ircd/lib/ircd-hybrid/modules";
1248 <        path = "/usr/local/ircd/lib/ircd-hybrid/modules/autoload";
1247 >        path = "lib/ircd-hybrid/modules";
1248 >        path = "lib/ircd-hybrid/modules/autoload";
1249  
1250          /* module: the name of a module to load on startup/rehash. */
1251 <        #module = "some_module.la";
1251 > #       module = "some_module.la";
1252   };
1253  
1254   /*
# Line 1207 | Line 1260 | log {
1260  
1261          file {
1262                  type = oper;
1263 <                name = "/home/ircd/var/log/oper.log";
1263 >                name = "var/log/oper.log";
1264                  size = unlimited;
1265          };
1266  
1267          file {
1268                  type = user;
1269 <                name = "/home/ircd/var/log/user.log";
1269 >                name = "var/log/user.log";
1270                  size = 50 megabytes;
1271          };
1272  
1273          file {
1274                  type = kill;
1275 <                name = "/home/ircd/var/log/kill.log";
1275 >                name = "var/log/kill.log";
1276                  size = 50 megabytes;
1277          };
1278  
1279          file {
1280                  type = kline;
1281 <                name = "/home/ircd/var/log/kline.log";
1281 >                name = "var/log/kline.log";
1282                  size = 50 megabytes;
1283          };
1284  
1285          file {
1286                  type = dline;
1287 <                name = "/home/ircd/var/log/dline.log";
1287 >                name = "var/log/dline.log";
1288                  size = 50 megabytes;
1289          };
1290  
1291          file {
1292                  type = gline;
1293 <                name = "/home/ircd/var/log/gline.log";
1293 >                name = "var/log/gline.log";
1294 >                size = 50 megabytes;
1295 >        };
1296 >
1297 >        file {
1298 >                type = xline;
1299 >                name = "var/log/xline.log";
1300 >                size = 50 megabytes;
1301 >        };
1302 >
1303 >        file {
1304 >                type = resv;
1305 >                name = "var/log/resv.log";
1306                  size = 50 megabytes;
1307          };
1308  
1309          file {
1310                  type = debug;
1311 <                name = "/home/ircd/var/log/debug.log";
1311 >                name = "var/log/debug.log";
1312                  size = 50 megabytes;
1313          };
1314   };

Diff Legend

Removed lines
+ Added lines
< Changed lines (old)
> Changed lines (new)