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

Comparing ircd-hybrid/trunk/doc/reference.conf (file contents):
Revision 1825 by michael, Sun Apr 14 19:54:48 2013 UTC vs.
Revision 2322 by michael, Sun Jun 23 12:01:30 2013 UTC

# Line 8 | Line 8
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,
# Line 30 | Line 30
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 47 | Line 47 | serverinfo {
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 <         * NOTE: The letters must be capitalized.  This cannot be changed at runtime.
50 >         * NOTE: The letters must be capitalized. This cannot be changed at runtime.
51           */
52          sid = "0HY";
53  
# Line 58 | Line 58 | serverinfo {
58  
59          /*
60           * network info: the name and description of the network this server
61 <         * is on.  Shown in the 005 reply and used with serverhiding.
61 >         * is on. Shown in the 005 reply and used with serverhiding.
62           */
63          network_name = "MyNet";
64          network_desc = "This is My Network";
# Line 73 | Line 73 | serverinfo {
73           * vhost: the IP to bind to when we connect outward to ipv4 servers.
74           * This should be an ipv4 IP only, or "*" for INADDR_ANY.
75           */
76 <        #vhost = "192.169.0.1";
76 > #       vhost = "192.169.0.1";
77  
78          /*
79 <         * vhost6: the IP to bind to when we connect outward to ipv6 servers.
80 <         * This should be an ipv6 IP only, or "*" for INADDR_ANY.
79 >         * vhost6: the address to bind to when we make outgoing connections
80 >         * to IPv6 servers. This should be an IPv6 address, or "*" for INADDR_ANY.
81           */
82 <        #vhost6 = "3ffe:80e8:546::2";
82 > #       vhost6 = "3ffe:80e8:546::2";
83  
84 <        /* max_clients: the maximum number of clients allowed to connect */
84 >        /* max_clients: the maximum number of clients allowed to connect. */
85          max_clients = 512;
86  
87          /*
# Line 98 | Line 98 | serverinfo {
98          max_topic_length = 160;
99  
100          /*
101 <         * rsa_private_key_file: the path to the file containing our
102 <         * rsa key for cryptlink.
101 >         * rsa_private_key_file: the path to the file containing the
102 >         * RSA key for cryptlink.
103           *
104 <         * Example command to store a 2048 bit RSA keypair in
104 >         * Example commands to store a 2048 bit RSA keypair in
105           * rsa.key, and the public key in rsa.pub:
106 <         *
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
110           *      chmod 0600 rsa.key
111           *      chmod 0644 rsa.pub
112           */
113 <        #rsa_private_key_file = "/usr/local/ircd/etc/rsa.key";
113 > #       rsa_private_key_file = "/usr/local/ircd/etc/rsa.key";
114  
115          /*
116           * ssl_certificate_file: the path to the file containing our
117 <         * ssl certificate for encrypted client connection.
117 >         * SSL certificate for encrypted client connection.
118           *
119           * This assumes your private RSA key is stored in rsa.key. You
120 <         * MUST have an RSA key in order to generate the certificate
120 >         * MUST have an RSA key in order to generate the certificate.
121 >         *
122 >         * Example command:
123           *
124           *      openssl req -new -days 365 -x509 -key rsa.key -out cert.pem
125           *
# Line 130 | Line 132 | serverinfo {
132           *      Common Name: irc.someirc.net
133           *      E-mail: you@domain.com
134           */
135 <        #ssl_certificate_file = "/usr/local/ircd/etc/cert.pem";
135 > #       ssl_certificate_file = "/usr/local/ircd/etc/cert.pem";
136  
137          /*
138           * ssl_dh_param_file:
139           *
140           * 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.
141 >         * DH parameters are required when using ciphers with EDH
142 >         * (ephemeral Diffie-Hellman) key exchange.
143           *
144           * A DH parameter file can be created by running:
145           *
# Line 147 | Line 149 | serverinfo {
149           * regarding specific OpenSSL dhparam command-line options
150           * can be found in the OpenSSL manual.
151           */
152 <        #ssl_dh_param_file = "/usr/local/ircd/etc/dhparam.pem";
152 > #       ssl_dh_param_file = "/usr/local/ircd/etc/dhparam.pem";
153  
154          /*
155           * ssl_cipher_list:
156           *
157 <         * List of ciphers that are supported by _this_ server. Can be used to
157 >         * List of ciphers to support on _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.
159 >         * If a client (which also includes incoming server connections) is not
160 >         * capable of using any of the ciphers listed here, the connection will
161 >         * simply be rejected.
162           *
163 <         * A list of supported ciphers can be obtained by running:
163 >         * A list of supported ciphers by OpenSSL can be obtained by running:
164           *
165           *      openssl ciphers -ssl3 -tls1 -v
166           *
167           * Multiple ciphers are separated by colons. The order of preference is
168           * from left to right.
169           */
170 <        #ssl_cipher_list = "DHE-RSA-AES256-SHA:AES256-SHA";
170 > #       ssl_cipher_list = "DHE-RSA-AES256-SHA:AES256-SHA";
171  
172          /*
173           * ssl_server_method:
# Line 175 | Line 177 | serverinfo {
177           * outgoing (client method) SSL/TLS connections.
178           * This can be either sslv3 for SSLv3, and/or tlsv1 for TLSv1.
179           */
180 <        #ssl_server_method = tlsv1, sslv3;
181 <        #ssl_client_method = tlsv1;
180 > #       ssl_server_method = tlsv1, sslv3;
181 > #       ssl_client_method = tlsv1;
182   };
183  
184   /*
# Line 192 | Line 194 | admin {
194   * class {}:  contains information about classes for users
195   */
196   class {
197 <        /* name: the name of the class */
197 >        /* name: the name of the class. */
198          name = "users";
199  
200          /*
# Line 203 | Line 205 | class {
205  
206          /*
207           * number_per_ip: how many local users are allowed to connect
208 <         * from one IP  (optional)
208 >         * from a single IP address  (optional)
209           */
210          number_per_ip = 2;
211  
212          /*
213           * max_local: how many local users are allowed to connect
214 <         * from one ident@host  (optional)
214 >         * from a single ident@host  (optional)
215           */
216          max_local = 2;
217  
# Line 225 | Line 227 | class {
227  
228          /*
229           * the following lines are optional and allow you to define
230 <         * how many users can connect from one /NN subnet
230 >         * how many users can connect from one /NN subnet.
231           */
232          cidr_bitlen_ipv4 = 24;
233          cidr_bitlen_ipv6 = 120;
234          number_per_cidr = 16;
235  
236          /*
237 <         * sendq: the amount of data allowed in a clients send queue before
237 >         * sendq: the amount of data allowed in a client's send queue before
238           * they are dropped.
239           */
240          sendq = 100 kbytes;
241  
242          /*
243 <         * recvq: maximum amount of data in a clients receive queue before
243 >         * recvq: the amount of data allowed in a client's receive queue before
244           * they are dropped for flooding. Defaults to 2560 if the chosen
245           * value isn't within the range of 512 to 8000.
246           */
# Line 253 | Line 255 | class {
255          sendq = 100 kbytes;
256  
257          /*
258 <         * min_idle: minimum idle time that is shown in /whois
258 >         * min_idle: minimum idle time that is shown in /whois.
259           */
260          min_idle = 3 hours;
261  
262          /*
263 <         * max_idle: maximum idle time that is shown in /whois
263 >         * max_idle: maximum idle time that is shown in /whois.
264           */
265          max_idle = 8 hours;
266  
267          /*
268           * flags:
269           *
270 <         * random_idle          - idle time is randomly selected within the
271 <         *                        range of min_idle to max_idle
272 <         * hide_idle_from_opers - fake idle time will be shown to operators, too
270 >         * random_idle          - a fake idle time is set randomly between
271 >         *                        min_idle and max_idle
272 >         * hide_idle_from_opers - the fake idle time will also be shown to operators
273           */
274          flags = random_idle, hide_idle_from_opers;
275   };
# Line 277 | Line 279 | class {
279          ping_time = 90 seconds;
280  
281          /*
282 <         * connectfreq: only used in server classes.  Specifies the delay
282 >         * connectfreq: only used in server classes. Specifies the delay
283           * between autoconnecting to servers.
284           */
285          connectfreq = 5 minutes;
286  
287 <        /* max number: the amount of servers to autoconnect to */
287 >        /* max number: the number of servers to autoconnect to. */
288          max_number = 1;
289  
290 <        /* sendq: servers need a higher sendq as they send more data */
290 >        /* sendq: servers need a higher sendq as they send more data. */
291          sendq = 2 megabytes;
292   };
293  
294   /*
295 + * motd {}: Allows the display of a different MOTD to a client
296 + * depending on its origin. Applies to local users only.
297 + */
298 + motd {
299 +        /*
300 +         * mask: multiple mask entries are permitted. Mask can either be
301 +         * a class name or a hostname.
302 +         */
303 +        mask = "*.at";
304 +        mask = "*.de";
305 +        mask = "*.ch";
306 +
307 +        /*
308 +         * file: path to the actual motd file.
309 +         */
310 +        file = "/usr/local/ircd/etc/german.motd";
311 + };
312 +
313 + /*
314   * listen {}:  contains information about the ports ircd listens on
315   */
316   listen {
317          /*
318 <         * port: the specific port to listen on.  If no host is specified
319 <         * before, it will listen on all available IPs.
318 >         * port: the port to listen on. If no host is specified
319 >         * earlier in the listen {} block, it will listen on all available IPs.
320           *
321 <         * Ports are separated via a comma, a range may be specified using ".."
321 >         * Ports are separated by commsa; a range may be specified using ".."
322           */
323          
324 <        /* port: listen on all available IPs, ports 6665 to 6669 */
324 >        /* port: listen on all available IP addresses, ports 6665 to 6669 */
325          port = 6665 .. 6669;
326  
327          /*
328 <         * Listen on 192.168.0.1/6697 with ssl enabled and hidden from STATS P
328 >         * Listen on 192.168.0.1/6697 with SSL enabled and hidden from STATS P
329           * unless you are an administrator.
330           *
331 <         * NOTE: The "flags" directive has to come before "port".  Always!
331 >         * NOTE: The "flags" directive always has to come before "port".
332           *
333           * Currently available flags are:
334           *
# Line 320 | Line 341 | listen {
341          port = 6697;
342  
343          /*
344 <         * host: set a specific IP/host the ports after the line will listen
345 <         * on.  This may be ipv4 or ipv6.
344 >         * host: set a specific IP address/host to listen on using the
345 >         * subsequent port definitions. This may be IPv4 or IPv6.
346           */
347          host = "1.2.3.4";
348          port = 7000, 7001;
# Line 336 | Line 357 | listen {
357   auth {
358          /*
359           * user: the user@host allowed to connect. Multiple user
360 <         * lines are permitted per auth block.
360 >         * lines are permitted within each auth block.
361           */
362          user = "*@172.16.0.0/12";
363          user = "*test@123D:B567:*";
# Line 351 | Line 372 | auth {
372          encrypted = yes;
373  
374          /*
375 <         * spoof: fake the users host to this.  This is free-form,
376 <         * just do everyone a favor and don't abuse it. ('=' prefix on /stats I)
375 >         * spoof: fake the user's host to this. This is free-form, just do
376 >         * everyone a favor and don't abuse it. ('=' prefix on /stats I)
377           */
378          spoof = "I.still.hate.packets";
379  
# Line 371 | Line 392 | auth {
392           * resv_exempt   - exempt this user from resvs ('$' prefix on /stats I)
393           * no_tilde      - remove ~ from a user with no ident ('-' prefix on /stats I)
394           * can_flood     - allow this user to exceed flood limits ('|' prefix on /stats I)
395 <         * webirc        - enables WEBIRC authentication for web-based clients such as Mibbit
395 >         * webirc        - enables WEBIRC authentication for web-based clients such as Mibbit
396           *                 ('<' prefix on /stats I)
397           */
398          flags = need_password, spoof_notice, exceed_limit, kline_exempt,
# Line 380 | Line 401 | auth {
401  
402   auth {
403          /*
404 <         * redirect: the server and port to redirect a user to.  A user does
405 <         * not have to obey the redirection, the ircd just suggests an alternative
404 >         * redirect: the server and port to redirect a user to. A user does not
405 >         * have to obey the redirection; the ircd just suggests an alternative
406           * server for them.
407           */
408          redirserv = "this.is.not.a.real.server";
# Line 401 | Line 422 | auth {
422  
423   /*
424   * operator {}:  defines ircd operators
404 *
405 * ircd-hybrid no longer supports local operators, privileges are
406 * controlled via flags.
425   */
426   operator {
427          /* name: the name of the oper */
# Line 417 | Line 435 | operator {
435          user = "*@127.0.0.0/8";
436  
437          /*
438 <         * password: the password required to oper.  By default this will
438 >         * password: the password required to oper. By default this will
439           * need to be encrypted by using the provided mkpasswd tool.
440           * Several password hash algorithms are available depending
441           * on your system's crypt() implementation. For example, a modern
442 <         * glibc already has support for SHA-256/512, and MD5 encryption
442 >         * glibc already has support for the SHA-256/512 and MD5 encryption
443           * algorithms.
444           */
445          password = "$5$x5zof8qe.Yc7/bPp$5zIg1Le2Lsgd4CvOjaD20pr5PmcfD7ha/9b2.TaUyG4";
# Line 434 | Line 452 | operator {
452  
453          /*
454           * rsa_public_key_file: the public key for this oper when using Challenge.
455 <         * A password should not be defined when this is used, see
455 >         * A password should not be defined when this is used; see
456           * doc/challenge.txt for more information.
457           */
458   #       rsa_public_key_file = "/usr/local/ircd/etc/oper.pub";
459  
460 +        /*
461 +         * ssl_certificate_fingerprint: enhances security by additionally checking
462 +         * the oper's client certificate fingerprint against the specified
463 +         * fingerprint below.
464 +         *
465 +         * Hint: your users can use the following command to obtain a SHA-256 hash
466 +         * of their ssl certificate:
467 +         *
468 +         *      openssl x509 -sha256 -noout -fingerprint -in cert.pem | sed -e 's/^.*=//;s/://g'
469 +         */
470 + #       ssl_certificate_fingerprint = "4C62287BA6776A89CD4F8FF10A62FFB35E79319F51AF6C62C674984974FCCB1D";
471 +
472 +        /*
473 +         * ssl_connection_required: client must be connected over SSL/TLS
474 +         * in order to be able to use this oper{} block.
475 +         * Default is 'no' if nothing else is specified.
476 +         */
477 +        ssl_connection_required = no;
478 +
479          /* class: the class the oper joins when they successfully /oper */
480          class = "opers";
481  
482          /*
483 <         * umodes: default usermodes opers get when they /oper.  If defined,
483 >         * umodes: the default usermodes opers get when they /oper. If defined,
484           * it will override oper_umodes settings in general {}.
485           * Available usermodes:
486           *
487           * +b - bots         - See bot and drone flooding notices
488           * +c - cconn        - Client connection/quit notices
452         * +C - cconn_full   - Client connection/quit notices full
489           * +D - deaf         - Don't receive channel messages
490           * +d - debug        - See debugging notices
491           * +e - external     - See remote server connection and split notices
492 +         * +F - farconnect   - Remote client connection/quit notices
493           * +f - full         - See auth{} block full notices
494           * +G - softcallerid - Server Side Ignore for users not on your channels
495           * +g - callerid     - Server Side Ignore (for privmsgs etc)
496           * +H - hidden       - Hides operator status to other users
497 <         * +i - invisible    - Not shown in NAMES or WHO unless you share a
461 <         *                     a channel
497 >         * +i - invisible    - Not shown in NAMES or WHO unless you share a channel
498           * +j - rej          - See rejected client notices
499           * +k - skill        - See server generated KILL messages
500           * +l - locops       - See LOCOPS messages
501           * +n - nchange      - See client nick changes
502 +         * +R - nononreg     - Only receive private messages from registered clients
503           * +s - servnotice   - See general server notices
504           * +u - unauth       - See unauthorized client notices
505           * +w - wallop       - See server generated WALLOPS
506           * +y - spy          - See LINKS, STATS, TRACE notices etc.
507           * +z - operwall     - See oper generated WALLOPS
508           */
509 < #       umodes = locops, servnotice, operwall, wallop;
509 >        umodes = locops, servnotice, operwall, wallop;
510  
511          /*
512 <         * privileges: controls the activities and commands an oper is
512 >         * privileges: controls the activities and commands an oper is
513           * allowed to do on the server. All options default to no.
514           * Available options:
515           *
516 <         * module       - allows MODULE
517 <         * global_kill  - allows remote users to be /KILL'd
518 <         * remote       - allows remote SQUIT and CONNECT
519 <         * remoteban    - allows remote KLINE/UNKLINE
520 <         * dline        - allows DLINE
521 <         * undline      - allows UNDLINE
522 <         * kline        - allows KILL and KLINE
523 <         * unkline      - allows UNKLINE
524 <         * gline        - allows GLINE
525 <         * xline        - allows XLINE
526 <         * globops      - allows GLOBOPS
527 <         * operwall     - allows OPERWALL
528 <         * nick_changes - allows oper to see nickchanges via usermode +n
529 <         * rehash       - allows oper to REHASH config
530 <         * die          - allows DIE
531 <         * restart      - allows RESTART
532 <         * set          - allows SET
533 <         * admin        - gives admin privileges. admins for example,
534 <         *                may see the real IP addresses of servers.
516 >         * module         - allows MODULE
517 >         * connect        - allows local CONNECT              | ('P' flag)
518 >         * connect:remote - allows remote CONNECT             | ('Q' flag)
519 >         * squit          - allows local SQUIT                | ('R' flag)
520 >         * squit:remote   - allows remote SQUIT               | ('S' flag)
521 >         * kill           - allows to KILL local clients      | ('N' flag)
522 >         * kill:remote    - allows remote users to be /KILL'd | ('O' flag)
523 >         * remoteban      - allows remote KLINE/UNKLINE       | ('B' flag)
524 >         * dline          - allows DLINE                      |
525 >         * undline        - allows UNDLINE                    |
526 >         * kline          - allows KLINE                      | ('K' flag)
527 >         * unkline        - allows UNKLINE                    | ('U' flag)
528 >         * gline          - allows GLINE                      | ('G' flag)
529 >         * xline          - allows XLINE                      | ('X' flag)
530 >         * locops         - allows LOCOPS                     |
531 >         * globops        - allows GLOBOPS                    |
532 >         * wallops        - allows WALLOPS                    |
533 >         * operwall       - allows OPERWALL                   | ('L' flag)
534 >         * rehash         - allows oper to REHASH config      | ('H' flag)
535 >         * die            - allows DIE                        | ('D' flag)
536 >         * restart        - allows RESTART                    |
537 >         * set            - allows SET                        |
538 >         * admin          - gives administrator privileges    | ('A' flag)
539           */
540 <        flags = global_kill, remote, kline, unkline, xline, globops, restart,
541 <                die, rehash, nick_changes, admin, operwall, module;
540 >        flags = kill, kill:remote, connect, connect:remote, kline, unkline,
541 >                xline, globops, restart, die, rehash, admin, operwall, module;
542   };
543  
544   /*
545 < * service {}: specifies what server may act as a network service
545 > * service {}: specifies a server which may act as a network service
546   *
547 < * NOTE: it is absolutely important that every single server on the network
547 > * NOTE: it is very important that every server on the network
548   *       has the same service{} block.
549   */
550   service {
# Line 512 | Line 553 | service {
553   };
554  
555   /*
556 < * connect {}:  controls servers we connect to
556 > * connect {}: define a server to connect to
557   */
558   connect {
559          /* name: the name of the server */
560          name = "irc.uplink.com";
561  
562          /*
563 <         * host: the host or IP to connect to.  If a hostname is used it
564 <         * must match the reverse dns of the server.
563 >         * host: the host or IP address to connect to. If a hostname is used it
564 >         * must match the reverse DNS of the server.
565           */
566          host = "192.168.0.1";
567  
568          /*
569 <         * vhost: the IP to bind to when we connect outward to servers.
569 >         * vhost: the IP address to bind to when making outgoing connections to
570 >         * servers.
571           * serverinfo::vhost and serverinfo::vhost6 will be overridden
572           * by this directive.
573           */
574          vhost = "192.168.0.2";
575  
576          /*
577 <         * passwords: the passwords we send (OLD C:) and accept (OLD N:).
578 <         * The remote server will have these passwords reversed.
577 >         * passwords: the passwords to send (OLD C:) and accept (OLD N:).
578 >         * The remote server will have these passwords swapped.
579           */
580          send_password = "password";
581          accept_password = "anotherpassword";
# Line 548 | Line 590 | connect {
590          port = 6666;
591  
592          /*
593 <         * hub_mask: the mask of servers that this server may hub.  Multiple
594 <         * entries are permitted
593 >         * hub_mask: the mask of servers that this server may hub. Multiple
594 >         * entries are permitted.
595           */
596          hub_mask = "*";
597  
598          /*
599 <         * leaf_mask: the mask of servers this server may not hub.  Multiple
600 <         * entries are permitted.  Useful for forbidding EU -> US -> EU routes.
599 >         * leaf_mask: the mask of servers this server may not hub. Multiple
600 >         * entries are permitted. Useful for forbidding EU -> US -> EU routes.
601           */
602   #       leaf_mask = "*.uk";
603  
# Line 566 | Line 608 | connect {
608           * ssl_cipher_list:
609           *
610           * List of ciphers that the server we are connecting to must support.
611 <         * If the server isn't capable of any cipher listed below, the
612 <         * connection will simply be rejected.
611 >         * If the server is not capable of using any of the ciphers listed below,
612 >         * the connection will simply be rejected.
613           * Can be used to enforce stronger ciphers, even though this option
614           * is not necessarily required to establish a SSL/TLS connection.
615           *
616           * Multiple ciphers are separated by colons. The order of preference
617           * is from left to right.
618           */
619 <        #ssl_cipher_list = "DHE-RSA-AES256-SHA:AES256-SHA";
619 > #       ssl_cipher_list = "DHE-RSA-AES256-SHA:AES256-SHA";
620 >
621 >        /*
622 >         * ssl_certificate_fingerprint: enhances security by additionally checking
623 >         * the server's client certificate fingerprint against the specified
624 >         * fingerprint below.
625 >         */
626 > #       ssl_certificate_fingerprint = "4C62287BA6776A89CD4F8FF10A62FFB35E79319F51AF6C62C674984974FCCB1D";
627  
628          /*
629           * autoconn   - controls whether we autoconnect to this server or not,
# Line 605 | Line 654 | connect {
654   */
655   cluster {
656          /*
657 <         * name: the server to share with, this can take wildcards
657 >         * name: the server to share with; this can take wildcards
658           *
659 <         * NOTE: only local actions will be clustered, meaning if
659 >         * NOTE: only local actions will be clustered, meaning that if
660           *       the server receives a shared kline/unkline/etc, it
661           *       will not be propagated to clustered servers.
662           *
# Line 618 | Line 667 | cluster {
667          name = "*.arpa";
668  
669          /*
670 <         * type: list of what to share, options are as follows:
670 >         * type: list of what to share; options are as follows:
671           *      dline   - share dlines
672           *      undline - share undlines
673           *      kline   - share klines
# Line 636 | Line 685 | cluster {
685   /*
686   * shared {}: users that are allowed to remote kline
687   *
688 < * NOTE: This can be effectively used for remote klines.
688 > * NOTE: This can effectively be used for remote klines.
689   *       Please note that there is no password authentication
690 < *       for users setting remote klines.  You must also be
690 > *       for users setting remote klines. You must also be
691   *       /oper'd in order to issue a remote kline.
692   */
693   shared {
694          /*
695 <         * name: the server the user must be on to set klines.  If this is not
696 <         * specified, the user will be allowed to kline from all servers.
695 >         * name: the server the user must be connected to in order to set klines.
696 >         * If this is not specified, the user will be allowed to kline from all
697 >         * servers.
698           */
699          name = "irc2.some.server";
700  
701          /*
702 <         * user: the user@host mask that is allowed to set klines.  If this is
702 >         * user: the user@host mask that is allowed to set klines. If this is
703           * not specified, all users on the server above will be allowed to set
704           * a remote kline.
705           */
# Line 680 | Line 730 | kill {
730          reason = "Obviously hacked account";
731   };
732  
683 kill {
684        user = "^O[[:alpha:]]?[[:digit:]]+(x\.o|\.xo)$@^[[:alnum:]]{4}\.evilnet.tld$";
685
686        /*
687         * NOTE: You have to set type=regex; when using a regular expression
688         * based user entry
689         */
690        type = regex;
691 };
692
733   /*
734 < * deny {}:  IPs that are not allowed to connect (before DNS/ident lookup)
734 > * deny {}:  IP addresses that are not allowed to connect
735 > * (before DNS/ident lookup)
736   * Oper issued dlines will be added to the specified dline config
737   */
738   deny {
# Line 700 | Line 741 | deny {
741   };
742  
743   /*
744 < * exempt {}: IPs that are exempt from deny {} and Dlines
744 > * exempt {}:  IP addresses that are exempt from deny {} and Dlines
745   */
746   exempt {
747          ip = "192.168.0.0/16";
# Line 709 | Line 750 | exempt {
750   /*
751   * resv {}:  nicks and channels users may not use/join
752   */
753 < resv { nick = "clone*"; reason = "Clone bots"; };
754 < resv { nick = "NickServ"; reason = "Reserved for services"; };
755 < resv { nick = "OperServ"; reason = "Reserved for services"; };
756 < resv { nick = "MemoServ"; reason = "Reserved for services"; };
757 < resv { nick = "BotServ"; reason = "Reserved for services"; };
758 < resv { nick = "HelpServ"; reason = "Reserved for services"; };
759 < resv { nick = "HostServ"; reason = "Reserved for services"; };
760 < resv { nick = "StatServ"; reason = "Reserved for services"; };
761 < resv { channel = "#*services*"; reason = "Reserved for services"; };
753 > resv { mask = "clone*"; reason = "Clone bots"; };
754 > resv { mask = "ChanServ"; reason = "Reserved for services"; };
755 > resv { mask = "NickServ"; reason = "Reserved for services"; };
756 > resv { mask = "OperServ"; reason = "Reserved for services"; };
757 > resv { mask = "MemoServ"; reason = "Reserved for services"; };
758 > resv { mask = "BotServ"; reason = "Reserved for services"; };
759 > resv { mask = "HelpServ"; reason = "Reserved for services"; };
760 > resv { mask = "HostServ"; reason = "Reserved for services"; };
761 > resv { mask = "StatServ"; reason = "Reserved for services"; };
762 > resv { mask = "#*services*"; reason = "Reserved for services"; };
763 >
764 > resv {
765 >        /*
766 >         * mask: masks starting with a '#' are automatically considered
767 >         * as channel name masks.
768 >         */
769 >        mask = "#helsinki";
770 >        reason = "Channel is reserved for finnish inhabitants";
771 >
772 >        /*
773 >         * exempt: can be either a ISO 3166 alpha-2 two letter country
774 >         * code, or a nick!user@host mask. CIDR is supported. Exempt
775 >         * entries can be stacked.
776 >         */
777 >        exempt = "FI";
778 > };
779  
780   /*
781 < * gecos {}:  The X: replacement, used for banning users based on
724 < * their "realname".
781 > * gecos {}:  Used for banning users based on their "realname".
782   */
783   gecos {
784          name = "*sex*";
# Line 733 | Line 790 | gecos {
790          reason = "Trojan drone";
791   };
792  
736 gecos {
737        name = "^\[J[0o]hn Do[3e]\]-[0-9]{2,5}$";
738
739        /*
740         * NOTE: You have to set type=regex; when using a regular expression
741         * based name entry
742         */
743        type = regex;
744 };
745
793   /*
794   * channel {}:  The channel block contains options pertaining to channels
795   */
796   channel {
797          /*
798           * disable_fake_channels: this option, if set to 'yes', will
799 <         * disallow clients to create or join channels that have one
799 >         * disallow clients from creating or joining channels that have one
800           * of the following ASCII characters in their name:
801           *
802           *   2 | bold
# Line 763 | Line 810 | channel {
810          disable_fake_channels = yes;
811  
812          /*
766         * restrict_channels: reverse channel RESVs logic, only reserved
767         * channels are allowed
768         */
769        restrict_channels = no;
770
771        /*
813           * knock_delay: The amount of time a user must wait between issuing
814           * the knock command.
815           */
# Line 792 | Line 833 | channel {
833           */
834          max_chans_per_oper = 50;
835  
795        /* quiet_on_ban: stop banned people talking in channels. */
796        quiet_on_ban = yes;
797
836          /* max_bans: maximum number of +b/e/I modes in a channel */
837          max_bans = 100;
838  
839          /*
840 <         * how many joins in how many seconds constitute a flood, use 0 to
840 >         * how many joins in how many seconds constitute a flood. Use 0 to
841           * disable. +b opers will be notified (changeable via /set)
842           */
843          join_flood_count = 16;
844          join_flood_time = 8 seconds;
845  
846          /*
847 <         * splitcode: The ircd will now check splitmode every few seconds.
847 >         * The ircd will now check splitmode (whether a server is split from
848 >         * the network) every few seconds; this functionality is known as
849 >         * splitcode and is influenced by the options below.
850           *
851           * Either split users or split servers can activate splitmode, but
852           * both conditions must be met for the ircd to deactivate splitmode.
# Line 816 | Line 856 | channel {
856  
857          /*
858           * default_split_user_count: when the usercount is lower than this level,
859 <         * consider ourselves split.  This must be set for automatic splitmode.
859 >         * consider ourselves split. This must be set for automatic splitmode.
860           */
861          default_split_user_count = 0;
862  
863          /*
864           * default_split_server_count: when the servercount is lower than this,
865 <         * consider ourselves split.  This must be set for automatic splitmode.
865 >         * consider ourselves split. This must be set for automatic splitmode.
866           */
867          default_split_server_count = 0;
868  
869 <        /* no_create_on_split: disallow users creating channels on split. */
869 >        /* no_create_on_split: do not allow users to create channels on split. */
870          no_create_on_split = yes;
871  
872 <        /* no_join_on_split: disallow users joining channels at all on a split. */
872 >        /* no_join_on_split: do not allow users to join channels on a split. */
873          no_join_on_split = no;
874   };
875  
876   /*
877   * serverhide {}:  The serverhide block contains the options regarding
878 < * serverhiding
878 > * to server hiding
879   */
880   serverhide {
881          /*
882 +         * disable_remote_commands: disable users issuing commands
883 +         * on remote servers.
884 +         */
885 +        disable_remote_commands = no;
886 +
887 +        /*
888           * flatten_links: this option will show all servers in /links appear
889 <         * that they are linked to this current server
889 >         * as though they are linked to this current server.
890           */
891          flatten_links = no;
892  
# Line 852 | Line 898 | serverhide {
898  
899          /*
900           * hidden: hide this server from a /links output on servers that
901 <         * support it.  This allows hub servers to be hidden etc.
901 >         * support it. This allows hub servers to be hidden etc.
902           */
903          hidden = no;
904  
# Line 863 | Line 909 | serverhide {
909          hide_servers = no;
910  
911          /*
912 +         * hide_services: define this if you want to hide the location of
913 +         * services servers that are specified in the service{} block.
914 +         */
915 +        hide_services = no;
916 +
917 +        /*
918           * Use this as the servername users see if hide_servers = yes.
919           */
920          hidden_name = "*.hidden.com";
921  
922          /*
923           * hide_server_ips: If this is disabled, opers will be unable to see
924 <         * servers ips and will be shown a masked ip, admins will be shown the
925 <         * real ip.
924 >         * servers' IP addresses and will be shown a masked IP address; admins
925 >         * will be shown the real IP address.
926           *
927 <         * If this is enabled, nobody can see a servers ip. *This is a kludge*,
928 <         * it has the side effect of hiding the ips everywhere, including
929 <         * logfiles.
927 >         * If this is enabled, nobody can see a server's IP address.
928 >         * *This is a kludge*: it has the side effect of hiding the IP addresses
929 >         * everywhere, including logfiles.
930           *
931           * We recommend you leave this disabled, and just take care with who you
932           * give administrator privileges to.
# Line 887 | Line 939 | serverhide {
939   * compiled in options in config.h
940   */
941   general {
942 +        /*
943 +         * cycle_on_host_change: sends a fake QUIT/JOIN combination
944 +         * when services change the hostname of a specific client.
945 +         */
946 +        cycle_on_host_change = yes;
947 +
948          /* services_name: servername of nick/channel services */
949          services_name = "service.someserver";
950  
951          /* max_watch: maximum WATCH entries a client can have. */
952          max_watch = 60;
953  
954 <        /* gline_enable: enable glines, network wide temp klines */
954 >        /* gline_enable: enable glines (network-wide temporary klines). */
955          gline_enable = yes;
956  
957          /*
958           * gline_duration: the amount of time a gline will remain on your
959 <         * server before expiring
959 >         * server before expiring.
960           */
961          gline_duration = 1 day;
962  
963          /*
964 <         * gline_request_duration:  how long a pending G-line can be around.
965 <         * 10 minutes should be plenty
964 >         * gline_request_duration: how long a pending G-line can be around.
965 >         * 10 minutes should be plenty.
966           */
967          gline_request_duration = 10 minutes;
968  
969          /*
970           * gline_min_cidr: the minimum required length of a CIDR bitmask
971 <         * for IPv4 based glines
971 >         * for IPv4 based glines.
972           */
973          gline_min_cidr = 16;
974  
975          /*
976           * gline_min_cidr6: the minimum required length of a CIDR bitmask
977 <         * for IPv6 based glines
977 >         * for IPv6 based glines.
978           */
979          gline_min_cidr6 = 48;
980  
# Line 926 | Line 984 | general {
984          invisible_on_connect = yes;
985  
986          /*
987 <         * Max time from the nickname change that still causes KILL
988 <         * automatically to switch for the current nick of that user.
987 >         * kill_chase_time_limit: KILL chasing is a feature whereby a KILL
988 >         * issued for a user who has recently changed nickname will be applied
989 >         * automatically to the new nick. kill_chase_time_limit is the maximum
990 >         * time following a nickname change that this chasing will apply.
991           */
992          kill_chase_time_limit = 90 seconds;
993  
994          /*
995 <         * If hide_spoof_ips is disabled, opers will be allowed to see the real
996 <         * IP of spoofed users in /trace etc. If this is defined they will be
997 <         * shown a masked IP.
995 >         * hide_spoof_ips: if disabled, opers will be allowed to see the real
996 >         * IP address of spoofed users in /trace etc. If this is defined they
997 >         * will be shown a masked IP.
998           */
999          hide_spoof_ips = yes;
1000  
1001          /*
1002 <         * Ignore bogus timestamps from other servers.  Yes, this will desync
1003 <         * the network, but it will allow chanops to resync with a valid non TS 0
1002 >         * Ignore bogus timestamps from other servers. Yes, this will desync the
1003 >         * network, but it will allow chanops to resync with a valid non TS 0
1004           *
1005           * This should be enabled network wide, or not at all.
1006           */
# Line 952 | Line 1012 | general {
1012           */
1013          disable_auth = no;
1014  
955        /* disable_remote_commands: disable users doing commands on remote servers */
956        disable_remote_commands = no;
957
1015          /*
1016           * tkline_expire_notices: enables or disables temporary kline/xline
1017           * expire notices.
# Line 963 | Line 1020 | general {
1020  
1021          /*
1022           * default_floodcount: the default value of floodcount that is configurable
1023 <         * via /quote set floodcount.  This is the amount of lines a user
1023 >         * via /quote set floodcount. This is the number of lines a user
1024           * may send to any other user/channel in one second.
1025           */
1026          default_floodcount = 10;
1027  
1028          /*
1029 <         * failed_oper_notice: send a notice to all opers on the server when
1029 >         * failed_oper_notice: send a notice to all opers on the server when
1030           * someone tries to OPER and uses the wrong password, host or ident.
1031           */
1032          failed_oper_notice = yes;
1033  
1034          /*
1035 <         * dots_in_ident: the amount of '.' characters permitted in an ident
1035 >         * dots_in_ident: the number of '.' characters permitted in an ident
1036           * reply before the user is rejected.
1037           */
1038          dots_in_ident = 2;
1039  
1040          /*
1041 <         * min_nonwildcard: the minimum non wildcard characters in k/d/g lines
1042 <         * placed via the server.  klines hand placed are exempt from limits.
1043 <         * wildcard chars: '.' ':' '*' '?' '@' '!' '#'
1041 >         * min_nonwildcard: the minimum number of non-wildcard characters in
1042 >         * k/d/g lines placed via the server. K-lines hand-placed are exempt from
1043 >         * this limit.
1044 >         * Wildcard chars: '.', ':', '*', '?', '@', '!'
1045           */
1046          min_nonwildcard = 4;
1047  
1048          /*
1049 <         * min_nonwildcard_simple: the minimum non wildcard characters in
1050 <         * gecos bans.  wildcard chars: '*' '?' '#'
1049 >         * min_nonwildcard_simple: the minimum number of non-wildcard characters
1050 >         * in gecos bans. Wildcard chars: '*', '?'
1051           */
1052          min_nonwildcard_simple = 3;
1053  
1054 <        /* max_accept: maximum allowed /accept's for +g usermode */
1054 >        /* max_accept: maximum allowed /accept's for +g usermode. */
1055          max_accept = 20;
1056  
1057 <        /* anti_nick_flood: enable the nickflood control code */
1057 >        /* anti_nick_flood: enable the nickflood control code. */
1058          anti_nick_flood = yes;
1059  
1060 <        /* nick flood: the nick changes allowed in the specified period */
1060 >        /* nick flood: the number of nick changes allowed in the specified period */
1061          max_nick_time = 20 seconds;
1062          max_nick_changes = 5;
1063  
# Line 1011 | Line 1069 | general {
1069  
1070          /*
1071           * ts delta: the time delta allowed between server clocks before
1072 <         * a warning is given, or before the link is dropped.  all servers
1072 >         * a warning is given, or before the link is dropped. All servers
1073           * should run ntpdate/rdate to keep clocks in sync
1074           */
1075          ts_warn_delta = 30 seconds;
# Line 1019 | Line 1077 | general {
1077  
1078          /*
1079           * warn_no_nline: warn opers about servers that try to connect but
1080 <         * we don't have a connect {} block for.  Twits with misconfigured
1081 <         * servers can get really annoying with this enabled.
1080 >         * for which we don't have a connect {} block. Twits with misconfigured
1081 >         * servers can become really annoying with this enabled.
1082           */
1083          warn_no_nline = yes;
1084  
1085          /*
1086           * stats_e_disabled: set this to 'yes' to disable "STATS e" for both
1087 <         * operators and administrators.  Doing so is a good idea in case
1087 >         * operators and administrators. Doing so is a good idea in case
1088           * there are any exempted (exempt{}) server IPs you don't want to
1089           * see leaked.
1090           */
# Line 1038 | Line 1096 | general {
1096          /* stats_P_oper_only: make stats P (ports) oper only */
1097          stats_P_oper_only = yes;
1098  
1099 +        /* stats_u_oper_only: make stats u (uptime) oper only */
1100 +        stats_u_oper_only = no;
1101 +
1102          /*
1103 <         * stats i oper only: make stats i (auth {}) oper only. set to:
1104 <         *     yes:    show users no auth blocks, made oper only.
1105 <         *     masked: show users first matching auth block
1106 <         *     no:     show users all auth blocks.
1103 >         * stats i oper only: make stats i (auth {}) oper only. Set to:
1104 >         *     yes    - show users no auth blocks, made oper only.
1105 >         *     masked - show users the first matching auth block
1106 >         *     no     - show users all auth blocks.
1107           */
1108          stats_i_oper_only = yes;
1109  
1110          /*
1111 <         * stats_k_oper_only: make stats k/K (klines) oper only.  set to:
1112 <         *     yes:    show users no auth blocks, made oper only
1113 <         *     masked: show users first matching auth block
1114 <         *     no:     show users all auth blocks.
1111 >         * stats_k_oper_only: make stats k/K (klines) oper only. Set to:
1112 >         *     yes    - show users no auth blocks, made oper only
1113 >         *     masked - show users the first matching auth block
1114 >         *     no     - show users all auth blocks.
1115           */
1116          stats_k_oper_only = yes;
1117  
# Line 1067 | Line 1128 | general {
1128          opers_bypass_callerid = no;
1129  
1130          /*
1131 <         * pace_wait_simple: time between use of less intensive commands
1131 >         * pace_wait_simple: minimum time required between use of less
1132 >         * intensive commands
1133           * (ADMIN, HELP, (L)USERS, VERSION, remote WHOIS)
1134           */
1135          pace_wait_simple = 1 second;
1136  
1137          /*
1138 <         * pace_wait: time between more intensive commands
1138 >         * pace_wait: minimum time required between use of more intensive commands
1139           * (AWAY, INFO, LINKS, MAP, MOTD, STATS, WHO, wildcard WHOIS, WHOWAS)
1140           */
1141          pace_wait = 10 seconds;
1142  
1143          /*
1144 <         * short_motd: send clients a notice telling them to read the motd
1145 <         * instead of forcing a motd to clients who may simply ignore it.
1144 >         * short_motd: send clients a notice telling them to read the MOTD
1145 >         * instead of forcing an MOTD to clients who may simply ignore it.
1146           */
1147          short_motd = no;
1148  
# Line 1095 | Line 1157 | general {
1157  
1158          /*
1159           * true_no_oper_flood: completely eliminate flood limits for opers
1160 <         * and for clients with can_flood = yes in their auth {} blocks
1160 >         * and for clients with can_flood = yes in their auth {} blocks.
1161           */
1162          true_no_oper_flood = yes;
1163  
1164 <        /* oper_pass_resv: allow opers to over-ride RESVs on nicks/channels */
1164 >        /* oper_pass_resv: allow opers to over-ride RESVs on nicks/channels. */
1165          oper_pass_resv = yes;
1166  
1167 <        /* REMOVE ME.  The following line checks you've been reading. */
1167 >        /* REMOVE ME.  The following line checks that you have been reading. */
1168          havent_read_conf = 1;
1169  
1170          /*
1171 <         * max_targets: the maximum amount of targets in a single
1172 <         * PRIVMSG/NOTICE.  Set to 999 NOT 0 for unlimited.
1171 >         * max_targets: the maximum number of targets in a single
1172 >         * PRIVMSG/NOTICE. Set to 999 NOT 0 for unlimited.
1173           */
1174          max_targets = 4;
1175  
1176          /*
1115         * message_locale: the default message locale
1116         * Use "standard" for the compiled in defaults.
1117         * To install the translated messages, go into messages/ in the
1118         * source directory and run `make install'.
1119         */
1120        message_locale = "standard";
1121
1122        /*
1177           * usermodes configurable: a list of usermodes for the options below
1178           *
1179           * +b - bots         - See bot and drone flooding notices
1180           * +c - cconn        - Client connection/quit notices
1127         * +C - cconn_full   - Client connection/quit notices full
1181           * +D - deaf         - Don't receive channel messages
1182           * +d - debug        - See debugging notices
1183           * +e - external     - See remote server connection and split notices
1184 +         * +F - farconnect   - Remote client connection/quit notices
1185           * +f - full         - See auth{} block full notices
1186           * +G - softcallerid - Server Side Ignore for users not on your channels
1187           * +g - callerid     - Server Side Ignore (for privmsgs etc)
# Line 1138 | Line 1192 | general {
1192           * +k - skill        - See server generated KILL messages
1193           * +l - locops       - See LOCOPS messages
1194           * +n - nchange      - See client nick changes
1195 +         * +R - nononreg     - Only receive private messages from registered clients
1196           * +s - servnotice   - See general server notices
1197           * +u - unauth       - See unauthorized client notices
1198           * +w - wallop       - See server generated WALLOPS
# Line 1146 | Line 1201 | general {
1201           */
1202  
1203          /* oper_only_umodes: usermodes only opers may set */
1204 <        oper_only_umodes = bots, cconn, cconn_full, debug, full, hidden, skill,
1204 >        oper_only_umodes = bots, cconn, debug, full, hidden, skill,
1205                             nchange, rej, spy, external, operwall,
1206 <                           locops, unauth;
1206 >                           locops, unauth, farconnect;
1207  
1208          /* oper_umodes: default usermodes opers get when they /oper */
1209          oper_umodes = bots, locops, servnotice, operwall, wallop;
1210  
1211          /*
1212           * use_egd: if your system does not have *random devices yet you
1213 <         * want to use OpenSSL and encrypted links, enable this.  Beware -
1214 <         * EGD is *very* CPU intensive when gathering data for its pool
1213 >         * want to use OpenSSL and encrypted links, enable this. Beware -
1214 >         * EGD is *very* CPU intensive when gathering data for its pool.
1215           */
1216   #       use_egd = yes;
1217  
# Line 1167 | Line 1222 | general {
1222   #       egdpool_path = "/var/run/egd-pool";
1223  
1224          /*
1225 <         * throttle_time: the minimum amount of time between connections from
1226 <         * the same ip.  exempt {} blocks are excluded from this throttling.
1227 <         * Offers protection against flooders who reconnect quickly.  
1225 >         * throttle_time: the minimum amount of time required between
1226 >         * connections from the same IP address. exempt {} blocks are excluded
1227 >         * from this throttling.
1228 >         * Offers protection against flooders who reconnect quickly.
1229           * Set to 0 to disable.
1230           */
1231          throttle_time = 10;
# Line 1183 | Line 1239 | modules {
1239          path = "/usr/local/ircd/lib/ircd-hybrid/modules";
1240          path = "/usr/local/ircd/lib/ircd-hybrid/modules/autoload";
1241  
1242 <        /* module: the name of a module to load on startup/rehash */
1243 <        #module = "some_module.la";
1242 >        /* module: the name of a module to load on startup/rehash. */
1243 > #       module = "some_module.la";
1244   };
1245  
1246   /*
# Line 1196 | Line 1252 | log {
1252  
1253          file {
1254                  type = oper;
1255 <                name = "/home/ircd/var/log/oper.log";
1255 >                name = "/usr/local/ircd/var/log/oper.log";
1256                  size = unlimited;
1257          };
1258  
1259          file {
1260                  type = user;
1261 <                name = "/home/ircd/var/log/user.log";
1261 >                name = "/usr/local/ircd/var/log/user.log";
1262                  size = 50 megabytes;
1263          };
1264  
1265          file {
1266                  type = kill;
1267 <                name = "/home/ircd/var/log/kill.log";
1267 >                name = "/usr/local/ircd/var/log/kill.log";
1268                  size = 50 megabytes;
1269          };
1270  
1271          file {
1272                  type = kline;
1273 <                name = "/home/ircd/var/log/kline.log";
1273 >                name = "/usr/local/ircd/var/log/kline.log";
1274                  size = 50 megabytes;
1275          };
1276  
1277          file {
1278                  type = dline;
1279 <                name = "/home/ircd/var/log/dline.log";
1279 >                name = "/usr/local/ircd/var/log/dline.log";
1280                  size = 50 megabytes;
1281          };
1282  
1283          file {
1284                  type = gline;
1285 <                name = "/home/ircd/var/log/gline.log";
1285 >                name = "/usr/local/ircd/var/log/gline.log";
1286                  size = 50 megabytes;
1287          };
1288  
1289          file {
1290                  type = debug;
1291 <                name = "/home/ircd/var/log/debug.log";
1291 >                name = "/usr/local/ircd/var/log/debug.log";
1292                  size = 50 megabytes;
1293          };
1294   };

Diff Legend

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