doc/ircd.conf.example

   1 /* doc/ircd.conf.example - brief example configuration file
   2  *
   3  * Copyright (C) 2000-2002 Hybrid Development Team
   4  * Copyright (C) 2002-2005 ircd-ratbox development team
   5  * Copyright (C) 2005-2006 charybdis development team
   6  *
   7  * See reference.conf for more information.
   8  */
   9
  10 /* Extensions */
  11 #loadmodule "extensions/chm_nonotice";
  12 #loadmodule "extensions/chm_operonly_compat";
  13 #loadmodule "extensions/chm_quietunreg_compat";
  14 #loadmodule "extensions/chm_sslonly_compat";
  15 #loadmodule "extensions/chm_operpeace";
  16 #loadmodule "extensions/createauthonly";
  17 #loadmodule "extensions/extb_account";
  18 #loadmodule "extensions/extb_canjoin";
  19 #loadmodule "extensions/extb_channel";
  20 #loadmodule "extensions/extb_combi";
  21 #loadmodule "extensions/extb_extgecos";
  22 #loadmodule "extensions/extb_hostmask";
  23 #loadmodule "extensions/extb_oper";
  24 #loadmodule "extensions/extb_realname";
  25 #loadmodule "extensions/extb_server";
  26 #loadmodule "extensions/extb_ssl";
  27 #loadmodule "extensions/extb_usermode";
  28 #loadmodule "extensions/hurt";
  29 #loadmodule "extensions/m_extendchans";
  30 #loadmodule "extensions/m_findforwards";
  31 #loadmodule "extensions/m_identify";
  32 #loadmodule "extensions/m_locops";
  33 #loadmodule "extensions/no_oper_invis";
  34 #loadmodule "extensions/sno_farconnect";
  35 #loadmodule "extensions/sno_globalkline";
  36 #loadmodule "extensions/sno_globalnickchange";
  37 #loadmodule "extensions/sno_globaloper";
  38 #loadmodule "extensions/sno_whois";
  39 #loadmodule "extensions/override";
  40 #loadmodule "extensions/no_kill_services";
  41
  42 /*
  43  * IP cloaking extensions: use ip_cloaking_4.0
  44  * if you're linking 3.2 and later, otherwise use
  45  * ip_cloaking, for compatibility with older 3.x
  46  * releases.
  47  */
  48
  49 #loadmodule "extensions/ip_cloaking_4.0";
  50 #loadmodule "extensions/ip_cloaking";
  51
  52 serverinfo {
  53         name = "hades.arpa";
  54         sid = "42X";
  55         description = "charybdis test server";
  56         network_name = "StaticBox";
  57
  58         /* On multi-homed hosts you may need the following. These define
  59          * the addresses we connect from to other servers. */
  60         /* for IPv4 */
  61         #vhost = "192.0.2.6";
  62         /* for IPv6 */
  63         #vhost6 = "2001:db8:2::6";
  64
  65         /* ssl_cert: certificate (and optionally key) for our ssl server */
  66         ssl_cert = "etc/ssl.pem";
  67
  68         /* ssl_private_key: our ssl private key (if not contained in ssl_cert file) */
  69         #ssl_private_key = "etc/ssl.key";
  70
  71         /* ssl_dh_params: DH parameters, generate with openssl dhparam -out dh.pem 2048
  72          * In general, the DH parameters size should be the same as your key's size.
  73          * However it has been reported that some clients have broken TLS implementations which may
  74          * choke on keysizes larger than 2048-bit, so we would recommend using 2048-bit DH parameters
  75          * for now if your keys are larger than 2048-bit.
  76          *
  77          * If you do not provide parameters, some TLS backends will fail on DHE- ciphers,
  78          * and some will succeed but use weak, common DH groups! */
  79         ssl_dh_params = "etc/dh.pem";
  80
  81         /* ssld_count: number of ssld processes you want to start, if you
  82          * have a really busy server, using N-1 where N is the number of
  83          * cpu/cpu cores you have might be useful. A number greater than one
  84          * can also be useful in case of bugs in ssld and because ssld needs
  85          * two file descriptors per SSL connection.
  86          */
  87         ssld_count = 1;
  88
  89         /* default max clients: the default maximum number of clients
  90          * allowed to connect.  This can be changed once ircd has started by
  91          * issuing:
  92          *   /quote set maxclients <limit>
  93          */
  94         default_max_clients = 1024;
  95
  96         /* nicklen: enforced nickname length (for this server only; must not
  97          * be longer than the maximum length set while building).
  98          */
  99         nicklen = 30;
 100 };
 101
 102 admin {
 103         name = "Lazy admin (lazya)";
 104         description = "StaticBox client server";
 105         email = "nobody@127.0.0.1";
 106 };
 107
 108 log {
 109         fname_userlog = "logs/userlog";
 110         #fname_fuserlog = "logs/fuserlog";
 111         fname_operlog = "logs/operlog";
 112         #fname_foperlog = "logs/foperlog";
 113         fname_serverlog = "logs/serverlog";
 114         #fname_klinelog = "logs/klinelog";
 115         fname_killlog = "logs/killlog";
 116         fname_operspylog = "logs/operspylog";
 117         #fname_ioerrorlog = "logs/ioerror";
 118 };
 119
 120 /* class {} blocks MUST be specified before anything that uses them.  That
 121  * means they must be defined before auth {} and before connect {}.
 122  */
 123 class "users" {
 124         ping_time = 2 minutes;
 125         number_per_ident = 10;
 126         number_per_ip = 10;
 127         number_per_ip_global = 50;
 128         cidr_ipv4_bitlen = 24;
 129         cidr_ipv6_bitlen = 64;
 130         number_per_cidr = 200;
 131         max_number = 3000;
 132         sendq = 400 kbytes;
 133 };
 134
 135 class "opers" {
 136         ping_time = 5 minutes;
 137         number_per_ip = 10;
 138         max_number = 1000;
 139         sendq = 1 megabyte;
 140 };
 141
 142 class "server" {
 143         ping_time = 5 minutes;
 144         connectfreq = 5 minutes;
 145         max_number = 1;
 146         sendq = 4 megabytes;
 147 };
 148
 149 listen {
 150         /* defer_accept: wait for clients to send IRC handshake data before
 151          * accepting them.  if you intend to use software which depends on the
 152          * server replying first, such as BOPM, you should disable this feature.
 153          * otherwise, you probably want to leave it on.
 154          */
 155         defer_accept = yes;
 156
 157         /* If you want to listen on a specific IP only, specify host.
 158          * host definitions apply only to the following port line.
 159          */
 160         #host = "192.0.2.6";
 161         port = 5000, 6665 .. 6669;
 162         sslport = 6697;
 163
 164         /* Listen on IPv6 (if you used host= above). */
 165         #host = "2001:db8:2::6";
 166         #port = 5000, 6665 .. 6669;
 167         #sslport = 9999;
 168 };
 169
 170 /* auth {}: allow users to connect to the ircd (OLD I:)
 171  * auth {} blocks MUST be specified in order of precedence.  The first one
 172  * that matches a user will be used.  So place spoofs first, then specials,
 173  * then general access, then restricted.
 174  */
 175 auth {
 176         /* user: the user@host allowed to connect.  Multiple IPv4/IPv6 user
 177          * lines are permitted per auth block.  This is matched against the
 178          * hostname and IP address (using :: shortening for IPv6 and
 179          * prepending a 0 if it starts with a colon) and can also use CIDR
 180          * masks.
 181          */
 182         user = "*@198.51.100.0/24";
 183         user = "*test@2001:db8:1:*";
 184
 185         /* password: an optional password that is required to use this block.
 186          * By default this is not encrypted, specify the flag "encrypted" in
 187          * flags = ...; below if it is.
 188          */
 189         password = "letmein";
 190
 191         /* spoof: fake the users user@host to be be this.  You may either
 192          * specify a host or a user@host to spoof to.  This is free-form,
 193          * just do everyone a favour and dont abuse it. (OLD I: = flag)
 194          */
 195         spoof = "I.still.hate.packets";
 196
 197         /* Possible flags in auth:
 198          *
 199          * encrypted                  | password is encrypted with mkpasswd
 200          * spoof_notice               | give a notice when spoofing hosts
 201          * exceed_limit (old > flag)  | allow user to exceed class user limits
 202          * kline_exempt (old ^ flag)  | exempt this user from k/g/xlines,
 203          *                            | dnsbls, and proxies
 204          * proxy_exempt               | exempt this user from proxies
 205          * dnsbl_exempt               | exempt this user from dnsbls
 206          * spambot_exempt             | exempt this user from spambot checks
 207          * shide_exempt               | exempt this user from serverhiding
 208          * jupe_exempt                | exempt this user from generating
 209          *                              warnings joining juped channels
 210          * resv_exempt                | exempt this user from resvs
 211          * flood_exempt               | exempt this user from flood limits
 212          *                              USE WITH CAUTION.
 213          * no_tilde     (old - flag)  | don't prefix ~ to username if no ident
 214          * need_ident   (old + flag)  | require ident for user in this class
 215          * need_ssl                   | require SSL/TLS for user in this class
 216          * need_sasl                  | require SASL id for user in this class
 217          */
 218         flags = kline_exempt, exceed_limit;
 219
 220         /* class: the class the user is placed in */
 221         class = "opers";
 222 };
 223
 224 auth {
 225         user = "*@*";
 226         class = "users";
 227 };
 228
 229 /* privset {} blocks MUST be specified before anything that uses them.  That
 230  * means they must be defined before operator {}.
 231  */
 232 privset "local_op" {
 233         privs = oper:local_kill, oper:operwall;
 234 };
 235
 236 privset "server_bot" {
 237         extends = "local_op";
 238         privs = oper:kline, oper:remoteban, snomask:nick_changes;
 239 };
 240
 241 privset "global_op" {
 242         extends = "local_op";
 243         privs = oper:global_kill, oper:routing, oper:kline, oper:unkline, oper:xline,
 244                 oper:resv, oper:mass_notice, oper:remoteban;
 245 };
 246
 247 privset "admin" {
 248         extends = "global_op";
 249         privs = oper:admin, oper:die, oper:rehash, oper:spy, oper:grant;
 250 };
 251
 252 operator "god" {
 253         /* name: the name of the oper must go above */
 254
 255         /* user: the user@host required for this operator.  CIDR *is*
 256          * supported now. auth{} spoofs work here, other spoofs do not.
 257          * multiple user="" lines are supported.
 258          */
 259         user = "*god@127.0.0.1";
 260
 261         /* password: the password required to oper.  Unless ~encrypted is
 262          * contained in flags = ...; this will need to be encrypted using
 263          * mkpasswd, MD5 is supported
 264          */
 265         password = "etcnjl8juSU1E";
 266
 267         /* rsa key: the public key for this oper when using Challenge.
 268          * A password should not be defined when this is used, see
 269          * doc/challenge.txt for more information.
 270          */
 271         #rsa_public_key_file = "/usr/local/ircd/etc/oper.pub";
 272
 273         /* umodes: the specific umodes this oper gets when they oper.
 274          * If this is specified an oper will not be given oper_umodes
 275          * These are described above oper_only_umodes in general {};
 276          */
 277         #umodes = locops, servnotice, operwall, wallop;
 278
 279         /* fingerprint: if specified, the oper's client certificate
 280          * fingerprint will be checked against the specified fingerprint
 281          * below.
 282          */
 283         #fingerprint = "c77106576abf7f9f90cca0f63874a60f2e40a64b";
 284
 285         /* snomask: specific server notice mask on oper up.
 286          * If this is specified an oper will not be given oper_snomask.
 287          */
 288         snomask = "+Zbfkrsuy";
 289
 290         /* flags: misc options for the operator.  You may prefix an option
 291          * with ~ to disable it, e.g. ~encrypted.
 292          *
 293          * Default flags are encrypted.
 294          *
 295          * Available options:
 296          *
 297          * encrypted:    the password above is encrypted [DEFAULT]
 298          * need_ssl:     must be using SSL/TLS to oper up
 299          */
 300         flags = encrypted;
 301
 302         /* privset: privileges set to grant */
 303         privset = "admin";
 304 };
 305
 306 connect "irc.uplink.com" {
 307         host = "203.0.113.3";
 308         send_password = "password";
 309         accept_password = "anotherpassword";
 310         port = 6666;
 311         hub_mask = "*";
 312         class = "server";
 313         flags = compressed, topicburst;
 314
 315         #fingerprint = "c77106576abf7f9f90cca0f63874a60f2e40a64b";
 316 };
 317
 318 connect "ssl.uplink.com" {
 319         host = "203.0.113.129";
 320         send_password = "password";
 321         accept_password = "anotherpassword";
 322         port = 9999;
 323         hub_mask = "*";
 324         class = "server";
 325         flags = ssl, topicburst;
 326 };
 327
 328 service {
 329         name = "services.int";
 330 };
 331
 332 cluster {
 333         name = "*";
 334         flags = kline, tkline, unkline, xline, txline, unxline, resv, tresv, unresv;
 335 };
 336
 337 shared {
 338         oper = "*@*", "*";
 339         flags = all, rehash;
 340 };
 341
 342 /* exempt {}: IPs that are exempt from Dlines and rejectcache. (OLD d:) */
 343 exempt {
 344         ip = "127.0.0.1";
 345 };
 346
 347 channel {
 348         use_invex = yes;
 349         use_except = yes;
 350         use_forward = yes;
 351         use_knock = yes;
 352         knock_delay = 5 minutes;
 353         knock_delay_channel = 1 minute;
 354         max_chans_per_user = 15;
 355         max_chans_per_user_large = 60;
 356         max_bans = 100;
 357         max_bans_large = 500;
 358         default_split_user_count = 0;
 359         default_split_server_count = 0;
 360         no_create_on_split = no;
 361         no_join_on_split = no;
 362         burst_topicwho = yes;
 363         kick_on_split_riding = no;
 364         only_ascii_channels = no;
 365         resv_forcepart = yes;
 366         channel_target_change = yes;
 367         disable_local_channels = no;
 368         autochanmodes = "+nt";
 369         displayed_usercount = 3;
 370         strip_topic_colors = no;
 371 };
 372
 373 serverhide {
 374         flatten_links = yes;
 375         links_delay = 5 minutes;
 376         hidden = no;
 377         disable_hidden = no;
 378 };
 379
 380 /* These are the blacklist settings.
 381  * You can have multiple combinations of host and rejection reasons.
 382  * They are used in pairs of one host/rejection reason.
 383  *
 384  * These settings should be adequate for most networks.
 385  *
 386  * Word to the wise: Do not use blacklists like SPEWS for blocking IRC
 387  * connections.
 388  *
 389  * As of charybdis 2.2, you can do some keyword substitution on the rejection
 390  * reason. The available keyword substitutions are:
 391  *
 392  *   ${ip}           - the user's IP
 393  *   ${host}         - the user's canonical hostname
 394  *   ${dnsbl-host}   - the dnsbl hostname the lookup was done against
 395  *   ${nick}         - the user's nickname
 396  *   ${network-name} - the name of the network
 397  *
 398  * As of charybdis 3.4, a type parameter is supported, which specifies the
 399  * address families the blacklist supports. IPv4 and IPv6 are supported.
 400  * IPv4 is currently the default as few blacklists support IPv6 operation
 401  * as of this writing.
 402  *
 403  * As of charybdis 3.5, a matches parameter is allowed; if omitted, any result
 404  * is considered a match. If included, a comma-separated list of *quoted*
 405  * strings is allowed to match queries. They may be of the format "0" to "255"
 406  * to match the final octet (e.g. 127.0.0.1) or "127.x.y.z" to explicitly match
 407  * an A record. The blacklist is only applied if it matches anything in the
 408  * list. You may freely mix full IP's and final octets.
 409  *
 410  * Consult your blacklist provider for the meaning of these parameters; they
 411  * are usually used to denote different ban types.
 412  */
 413 blacklist {
 414         host = "rbl.efnetrbl.org";
 415         type = ipv4;
 416         reject_reason = "${nick}, your IP (${ip}) is listed in EFnet's RBL. For assistance, see http://efnetrbl.org/?i=${ip}";
 417
 418         /* Example of a blacklist that supports both IPv4 and IPv6 and using matches */
 419 #       host = "foobl.blacklist.invalid";
 420 #       type = ipv4, ipv6;
 421 #       matches = "4", "6", "127.0.0.10";
 422 #       reject_reason = "${nick}, your IP (${ip}) is listed in ${dnsbl-host} for some reason. In order to protect ${network-name} from abuse, we are not allowing connections listed in ${dnsbl-host} to connect";
 423 };
 424
 425 /* These are the OPM settings.
 426  * This is similar to the functionality provided by BOPM. It will scan incoming
 427  * connections for open proxies by connecting to clients and attempting several
 428  * different open proxy handshakes. If they connect back to us (via a dedicated
 429  * listening port), and send back the data we send them, they are considered
 430  * an open proxy. For politeness reasons (users may be confused by the incoming
 431  * connection attempts if they are logging incoming connections), the user is
 432  * notified upon connect if they are being scanned.
 433  *
 434  * WARNING:
 435  * These settings are considered experimental. Only the most common proxy types
 436  * are checked for (Charybdis is immune from POST and GET proxies). If you are
 437  * not comfortable with experimental code, remove or comment out the *entire*
 438  * block below to disable the proxy scanner.
 439  */
 440 opm {
 441         /* IPv4 address to listen on. This must be a publicly facing IP address
 442          * to be effective.
 443          * If omitted, it defaults to serverinfo::vhost.
 444          */
 445         #listen_ipv4 = "127.0.0.1";
 446
 447         /* IPv4 port to listen on.
 448          * This should not be the same as any existing listeners.
 449          */
 450         #port_ipv4 = 32000;
 451
 452         /* IPv6 address to listen on. This must be a publicly facing IP address
 453          * to be effective.
 454          * If omitted, it defaults to serverinfo::vhost6.
 455          */
 456         #listen_ipv6 = "::1";
 457
 458         /* IPv6 port to listen on.
 459          * This should not be the same as any existing listeners.
 460          */
 461         #port_ipv6 = 32000;
 462
 463         /* You can also set the listen_port directive which will set both the
 464          * IPv4 and IPv6 ports at once.
 465          */
 466         listen_port = 32000;
 467
 468         /* This sets the timeout in seconds before ending open proxy scans.
 469          * Values less than 1 or greater than 60 are ignored.
 470          * It is advisable to keep it as short as feasible, so clients do not
 471          * get held up by excessively long scan times.
 472          */
 473         timeout = 5;
 474
 475         /* These are the ports to scan for SOCKS4 proxies on. They may overlap
 476          * with other scan types. Sensible defaults are given below.
 477          */
 478         socks4_ports = 1080, 10800, 443, 80, 8080, 8000;
 479
 480         /* These are the ports to scan for SOCKS5 proxies on. They may overlap
 481          * with other scan types. Sensible defaults are given below.
 482          */
 483         socks5_ports = 1080, 10800, 443, 80, 8080, 8000;
 484
 485         /* These are the ports to scan for HTTP connect proxies on (plaintext).
 486          * They may overlap with other scan types. Sensible defaults are given
 487          * below.
 488          */
 489         httpconnect_ports = 80, 8080, 8000;
 490
 491         /* These are the ports to scan for HTTPS CONNECT proxies on (SSL).
 492          * They may overlap with other scan types. Sensible defaults are given
 493          * below.
 494          */
 495         httpsconnect_ports = 443, 4443;
 496 };
 497
 498 alias "NickServ" {
 499         target = "NickServ";
 500 };
 501
 502 alias "ChanServ" {
 503         target = "ChanServ";
 504 };
 505
 506 alias "OperServ" {
 507         target = "OperServ";
 508 };
 509
 510 alias "MemoServ" {
 511         target = "MemoServ";
 512 };
 513
 514 alias "NS" {
 515         target = "NickServ";
 516 };
 517
 518 alias "CS" {
 519         target = "ChanServ";
 520 };
 521
 522 alias "OS" {
 523         target = "OperServ";
 524 };
 525
 526 alias "MS" {
 527         target = "MemoServ";
 528 };
 529
 530 general {
 531         hide_error_messages = opers;
 532         hide_spoof_ips = yes;
 533
 534         /*
 535          * default_umodes: umodes to enable on connect.
 536          * If you have enabled the new ip_cloaking_4.0 module, and you want
 537          * to make use of it, add +x to this option, i.e.:
 538          *      default_umodes = "+ix";
 539          *
 540          * If you have enabled the old ip_cloaking module, and you want
 541          * to make use of it, add +h to this option, i.e.:
 542          *      default_umodes = "+ih";
 543          */
 544         default_umodes = "+i";
 545
 546         default_operstring = "is an IRC Operator";
 547         default_adminstring = "is a Server Administrator";
 548         servicestring = "is a Network Service";
 549
 550         /*
 551          * Nick of the network's SASL agent. Used to check whether services are here,
 552          * SASL credentials are only sent to its server. Needs to be a service.
 553          *
 554          * Defaults to SaslServ if unspecified.
 555          */
 556         sasl_service = "SaslServ";
 557         disable_fake_channels = no;
 558         tkline_expire_notices = no;
 559         default_floodcount = 10;
 560         failed_oper_notice = yes;
 561         dots_in_ident = 2;
 562         min_nonwildcard = 4;
 563         min_nonwildcard_simple = 3;
 564         max_accept = 100;
 565         max_monitor = 100;
 566         anti_nick_flood = yes;
 567         max_nick_time = 20 seconds;
 568         max_nick_changes = 5;
 569         anti_spam_exit_message_time = 5 minutes;
 570         ts_warn_delta = 30 seconds;
 571         ts_max_delta = 5 minutes;
 572         client_exit = yes;
 573         collision_fnc = yes;
 574         resv_fnc = yes;
 575         global_snotices = yes;
 576         dline_with_reason = yes;
 577         kline_delay = 0 seconds;
 578         kline_with_reason = yes;
 579         kline_reason = "K-Lined";
 580         identify_service = "NickServ@services.int";
 581         identify_command = "IDENTIFY";
 582         non_redundant_klines = yes;
 583         warn_no_nline = yes;
 584         use_propagated_bans = yes;
 585         stats_e_disabled = no;
 586         stats_c_oper_only = no;
 587         stats_h_oper_only = no;
 588         stats_y_oper_only = no;
 589         stats_o_oper_only = yes;
 590         stats_P_oper_only = no;
 591         stats_i_oper_only = masked;
 592         stats_k_oper_only = masked;
 593         map_oper_only = no;
 594         operspy_admin_only = no;
 595         operspy_dont_care_user_info = no;
 596         caller_id_wait = 1 minute;
 597         pace_wait_simple = 1 second;
 598         pace_wait = 10 seconds;
 599         short_motd = no;
 600         ping_cookie = no;
 601         connect_timeout = 30 seconds;
 602         default_ident_timeout = 5;
 603         disable_auth = no;
 604         no_oper_flood = yes;
 605         max_targets = 4;
 606         client_flood_max_lines = 20;
 607         use_whois_actually = no;
 608         oper_only_umodes = operwall, locops, servnotice;
 609         oper_umodes = locops, servnotice, operwall, wallop;
 610         oper_snomask = "+s";
 611         burst_away = yes;
 612         nick_delay = 0 seconds; # 15 minutes if you want to enable this
 613         reject_ban_time = 1 minute;
 614         reject_after_count = 3;
 615         reject_duration = 5 minutes;
 616         throttle_duration = 60;
 617         throttle_count = 4;
 618         max_ratelimit_tokens = 30;
 619         away_interval = 30;
 620         certfp_method = spki_sha256;
 621         hide_opers_in_whois = no;
 622 };
 623
 624 modules {
 625         path = "modules";
 626         path = "modules/autoload";
 627 };