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  * $Id: example.conf 3582 2007-11-17 21:55:48Z jilles $
   8  *
   9  * See reference.conf for more information.
  10  */
  11
  12 /* Extensions */
  13 #loadmodule "extensions/chm_operonly_compat.la";
  14 #loadmodule "extensions/chm_quietunreg_compat.la";
  15 #loadmodule "extensions/chm_sslonly_compat.la";
  16 #loadmodule "extensions/chm_operpeace.la";
  17 #loadmodule "extensions/createauthonly.la";
  18 #loadmodule "extensions/extb_account.la";
  19 #loadmodule "extensions/extb_canjoin.la";
  20 #loadmodule "extensions/extb_channel.la";
  21 #loadmodule "extensions/extb_combi.la";
  22 #loadmodule "extensions/extb_extgecos.la";
  23 #loadmodule "extensions/extb_hostmask.la";
  24 #loadmodule "extensions/extb_oper.la";
  25 #loadmodule "extensions/extb_realname.la";
  26 #loadmodule "extensions/extb_server.la";
  27 #loadmodule "extensions/extb_ssl.la";
  28 #loadmodule "extensions/hurt.la";
  29 #loadmodule "extensions/m_extendchans.la";
  30 #loadmodule "extensions/m_findforwards.la";
  31 #loadmodule "extensions/m_identify.la";
  32 #loadmodule "extensions/no_oper_invis.la";
  33 #loadmodule "extensions/sno_farconnect.la";
  34 #loadmodule "extensions/sno_globalkline.la";
  35 #loadmodule "extensions/sno_globalnickchange.la";
  36 #loadmodule "extensions/sno_globaloper.la";
  37 #loadmodule "extensions/sno_whois.la";
  38 #loadmodule "extensions/override.la";
  39 #loadmodule "extensions/no_kill_services.la";
  40
  41 /*
  42  * IP cloaking extensions: use ip_cloaking_4.0
  43  * if you're linking 3.2 and later, otherwise use
  44  * ip_cloaking, for compatibility with older 3.x
  45  * releases.
  46  */
  47
  48 #loadmodule "extensions/ip_cloaking_4.0.la";
  49 #loadmodule "extensions/ip_cloaking.la";
  50
  51 serverinfo {
  52         name = "hades.arpa";
  53         sid = "42X";
  54         description = "charybdis test server";
  55         network_name = "StaticBox";
  56         hub = yes;
  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_private_key: our ssl private key */
  66         ssl_private_key = "etc/ssl.key";
  67
  68         /* ssl_cert: certificate for our ssl server */
  69         ssl_cert = "etc/ssl.pem";
  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         ssl_dh_params = "etc/dh.pem";
  78
  79         /* ssld_count: number of ssld processes you want to start, if you
  80          * have a really busy server, using N-1 where N is the number of
  81          * cpu/cpu cores you have might be useful. A number greater than one
  82          * can also be useful in case of bugs in ssld and because ssld needs
  83          * two file descriptors per SSL connection.
  84          */
  85         ssld_count = 1;
  86
  87         /* default max clients: the default maximum number of clients
  88          * allowed to connect.  This can be changed once ircd has started by
  89          * issuing:
  90          *   /quote set maxclients <limit>
  91          */
  92         default_max_clients = 1024;
  93
  94         /* nicklen: enforced nickname length (for this server only; must not
  95          * be longer than the maximum length set while building).
  96          */
  97         nicklen = 30;
  98 };
  99
 100 admin {
 101         name = "Lazy admin (lazya)";
 102         description = "StaticBox client server";
 103         email = "nobody@127.0.0.1";
 104 };
 105
 106 log {
 107         fname_userlog = "logs/userlog";
 108         #fname_fuserlog = "logs/fuserlog";
 109         fname_operlog = "logs/operlog";
 110         #fname_foperlog = "logs/foperlog";
 111         fname_serverlog = "logs/serverlog";
 112         #fname_klinelog = "logs/klinelog";
 113         fname_killlog = "logs/killlog";
 114         fname_operspylog = "logs/operspylog";
 115         #fname_ioerrorlog = "logs/ioerror";
 116 };
 117
 118 /* class {} blocks MUST be specified before anything that uses them.  That
 119  * means they must be defined before auth {} and before connect {}.
 120  */
 121 class "users" {
 122         ping_time = 2 minutes;
 123         number_per_ident = 10;
 124         number_per_ip = 10;
 125         number_per_ip_global = 50;
 126         cidr_ipv4_bitlen = 24;
 127         cidr_ipv6_bitlen = 64;
 128         number_per_cidr = 200;
 129         max_number = 3000;
 130         sendq = 400 kbytes;
 131 };
 132
 133 class "opers" {
 134         ping_time = 5 minutes;
 135         number_per_ip = 10;
 136         max_number = 1000;
 137         sendq = 1 megabyte;
 138 };
 139
 140 class "server" {
 141         ping_time = 5 minutes;
 142         connectfreq = 5 minutes;
 143         max_number = 1;
 144         sendq = 4 megabytes;
 145 };
 146
 147 listen {
 148         /* defer_accept: wait for clients to send IRC handshake data before
 149          * accepting them.  if you intend to use software which depends on the
 150          * server replying first, such as BOPM, you should disable this feature.
 151          * otherwise, you probably want to leave it on.
 152          */
 153         defer_accept = yes;
 154
 155         /* If you want to listen on a specific IP only, specify host.
 156          * host definitions apply only to the following port line.
 157          */
 158         #host = "192.0.2.6";
 159         port = 5000, 6665 .. 6669;
 160         sslport = 6697;
 161
 162         /* Listen on IPv6 (if you used host= above). */
 163         #host = "2001:db8:2::6";
 164         #port = 5000, 6665 .. 6669;
 165         #sslport = 9999;
 166 };
 167
 168 /* auth {}: allow users to connect to the ircd (OLD I:)
 169  * auth {} blocks MUST be specified in order of precedence.  The first one
 170  * that matches a user will be used.  So place spoofs first, then specials,
 171  * then general access, then restricted.
 172  */
 173 auth {
 174         /* user: the user@host allowed to connect.  Multiple IPv4/IPv6 user
 175          * lines are permitted per auth block.  This is matched against the
 176          * hostname and IP address (using :: shortening for IPv6 and
 177          * prepending a 0 if it starts with a colon) and can also use CIDR
 178          * masks.
 179          */
 180         user = "*@198.51.100.0/24";
 181         user = "*test@2001:db8:1:*";
 182
 183         /* password: an optional password that is required to use this block.
 184          * By default this is not encrypted, specify the flag "encrypted" in
 185          * flags = ...; below if it is.
 186          */
 187         password = "letmein";
 188
 189         /* spoof: fake the users user@host to be be this.  You may either
 190          * specify a host or a user@host to spoof to.  This is free-form,
 191          * just do everyone a favour and dont abuse it. (OLD I: = flag)
 192          */
 193         spoof = "I.still.hate.packets";
 194
 195         /* Possible flags in auth:
 196          *
 197          * encrypted                  | password is encrypted with mkpasswd
 198          * spoof_notice               | give a notice when spoofing hosts
 199          * exceed_limit (old > flag)  | allow user to exceed class user limits
 200          * kline_exempt (old ^ flag)  | exempt this user from k/g/xlines&dnsbls
 201          * dnsbl_exempt               | exempt this user from dnsbls
 202          * spambot_exempt             | exempt this user from spambot checks
 203          * shide_exempt               | exempt this user from serverhiding
 204          * jupe_exempt                | exempt this user from generating
 205          *                              warnings joining juped channels
 206          * resv_exempt                | exempt this user from resvs
 207          * flood_exempt               | exempt this user from flood limits
 208          *                                     USE WITH CAUTION.
 209          * no_tilde     (old - flag)  | don't prefix ~ to username if no ident
 210          * need_ident   (old + flag)  | require ident for user in this class
 211          * need_ssl                   | require SSL/TLS for user in this class
 212          * need_sasl                  | require SASL id for user in this class
 213          */
 214         flags = kline_exempt, exceed_limit;
 215
 216         /* class: the class the user is placed in */
 217         class = "opers";
 218 };
 219
 220 auth {
 221         user = "*@*";
 222         class = "users";
 223 };
 224
 225 /* privset {} blocks MUST be specified before anything that uses them.  That
 226  * means they must be defined before operator {}.
 227  */
 228 privset "local_op" {
 229         privs = oper:local_kill, oper:operwall;
 230 };
 231
 232 privset "server_bot" {
 233         extends = "local_op";
 234         privs = oper:kline, oper:remoteban, snomask:nick_changes;
 235 };
 236
 237 privset "global_op" {
 238         extends = "local_op";
 239         privs = oper:global_kill, oper:routing, oper:kline, oper:unkline, oper:xline,
 240                 oper:resv, oper:mass_notice, oper:remoteban;
 241 };
 242
 243 privset "admin" {
 244         extends = "global_op";
 245         privs = oper:admin, oper:die, oper:rehash, oper:spy, oper:grant;
 246 };
 247
 248 operator "god" {
 249         /* name: the name of the oper must go above */
 250
 251         /* user: the user@host required for this operator.  CIDR *is*
 252          * supported now. auth{} spoofs work here, other spoofs do not.
 253          * multiple user="" lines are supported.
 254          */
 255         user = "*god@127.0.0.1";
 256
 257         /* password: the password required to oper.  Unless ~encrypted is
 258          * contained in flags = ...; this will need to be encrypted using
 259          * mkpasswd, MD5 is supported
 260          */
 261         password = "etcnjl8juSU1E";
 262
 263         /* rsa key: the public key for this oper when using Challenge.
 264          * A password should not be defined when this is used, see
 265          * doc/challenge.txt for more information.
 266          */
 267         #rsa_public_key_file = "/usr/local/ircd/etc/oper.pub";
 268
 269         /* umodes: the specific umodes this oper gets when they oper.
 270          * If this is specified an oper will not be given oper_umodes
 271          * These are described above oper_only_umodes in general {};
 272          */
 273         #umodes = locops, servnotice, operwall, wallop;
 274
 275         /* fingerprint: if specified, the oper's client certificate
 276          * fingerprint will be checked against the specified fingerprint
 277          * below.
 278          */
 279         #fingerprint = "c77106576abf7f9f90cca0f63874a60f2e40a64b";
 280
 281         /* snomask: specific server notice mask on oper up.
 282          * If this is specified an oper will not be given oper_snomask.
 283          */
 284         snomask = "+Zbfkrsuy";
 285
 286         /* flags: misc options for the operator.  You may prefix an option
 287          * with ~ to disable it, e.g. ~encrypted.
 288          *
 289          * Default flags are encrypted.
 290          *
 291          * Available options:
 292          *
 293          * encrypted:    the password above is encrypted [DEFAULT]
 294          * need_ssl:     must be using SSL/TLS to oper up
 295          */
 296         flags = encrypted;
 297
 298         /* privset: privileges set to grant */
 299         privset = "admin";
 300 };
 301
 302 connect "irc.uplink.com" {
 303         host = "203.0.113.3";
 304         send_password = "password";
 305         accept_password = "anotherpassword";
 306         port = 6666;
 307         hub_mask = "*";
 308         class = "server";
 309         flags = compressed, topicburst;
 310
 311         #fingerprint = "c77106576abf7f9f90cca0f63874a60f2e40a64b";
 312
 313         /* If the connection is IPv6, uncomment below.
 314          * Use 0::1, not ::1, for IPv6 localhost. */
 315         #aftype = ipv6;
 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, and are (presently)
 385  * required for use on StaticBox.
 386  *
 387  * Word to the wise: Do not use blacklists like SPEWS for blocking IRC
 388  * connections.
 389  *
 390  * As of charybdis 2.2, you can do some keyword substitution on the rejection
 391  * reason. The available keyword substitutions are:
 392  *
 393  *   ${ip}           - the user's IP
 394  *   ${host}         - the user's canonical hostname
 395  *   ${dnsbl-host}   - the dnsbl hostname the lookup was done against
 396  *   ${nick}         - the user's nickname
 397  *   ${network-name} - the name of the network
 398  *
 399  * As of charybdis 3.4, a type parameter is supported, which specifies the
 400  * address families the blacklist supports. IPv4 and IPv6 are supported.
 401  * IPv4 is currently the default as few blacklists support IPv6 operation
 402  * as of this writing.
 403  *
 404  * As of charybdis 3.5, a matches parameter is allowed; if omitted, any result
 405  * is considered a match. If included, a comma-separated list of *quoted*
 406  * strings is allowed to match queries. They may be of the format "0" to "255"
 407  * to match the final octet (e.g. 127.0.0.1) or "127.x.y.z" to explicitly match
 408  * an A record. The blacklist is only applied if it matches anything in the
 409  * list. You may freely mix full IP's and final octets.
 410  *
 411  * Consult your blacklist provider for the meaning of these parameters; they
 412  * are usually used to denote different ban types.
 413  */
 414 blacklist {
 415         host = "rbl.efnetrbl.org";
 416         type = ipv4;
 417         reject_reason = "${nick}, your IP (${ip}) is listed in EFnet's RBL. For assistance, see http://efnetrbl.org/?i=${ip}";
 418
 419         /* Example of a blacklist that supports both IPv4 and IPv6 and using matches */
 420 #       host = "foobl.blacklist.invalid";
 421 #       type = ipv4, ipv6;
 422 #       matches = "4", "6", "127.0.0.10";
 423 #       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";
 424 };
 425
 426 alias "NickServ" {
 427         target = "NickServ";
 428 };
 429
 430 alias "ChanServ" {
 431         target = "ChanServ";
 432 };
 433
 434 alias "OperServ" {
 435         target = "OperServ";
 436 };
 437
 438 alias "MemoServ" {
 439         target = "MemoServ";
 440 };
 441
 442 alias "NS" {
 443         target = "NickServ";
 444 };
 445
 446 alias "CS" {
 447         target = "ChanServ";
 448 };
 449
 450 alias "OS" {
 451         target = "OperServ";
 452 };
 453
 454 alias "MS" {
 455         target = "MemoServ";
 456 };
 457
 458 general {
 459         hide_error_messages = opers;
 460         hide_spoof_ips = yes;
 461
 462         /*
 463          * default_umodes: umodes to enable on connect.
 464          * If you have enabled the new ip_cloaking_4.0 module, and you want
 465          * to make use of it, add +x to this option, i.e.:
 466          *      default_umodes = "+ix";
 467          *
 468          * If you have enabled the old ip_cloaking module, and you want
 469          * to make use of it, add +h to this option, i.e.:
 470          *      default_umodes = "+ih";
 471          */
 472         default_umodes = "+i";
 473
 474         default_operstring = "is an IRC Operator";
 475         default_adminstring = "is a Server Administrator";
 476         servicestring = "is a Network Service";
 477
 478         /*
 479          * Nick of the network's SASL agent. Used to check whether services are here,
 480          * SASL credentials are only sent to its server. Needs to be a service.
 481          *
 482          * Defaults to SaslServ if unspecified.
 483          */
 484         sasl_service = "SaslServ";
 485         disable_fake_channels = no;
 486         tkline_expire_notices = no;
 487         default_floodcount = 10;
 488         failed_oper_notice = yes;
 489         dots_in_ident=2;
 490         min_nonwildcard = 4;
 491         min_nonwildcard_simple = 3;
 492         max_accept = 100;
 493         max_monitor = 100;
 494         anti_nick_flood = yes;
 495         max_nick_time = 20 seconds;
 496         max_nick_changes = 5;
 497         anti_spam_exit_message_time = 5 minutes;
 498         ts_warn_delta = 30 seconds;
 499         ts_max_delta = 5 minutes;
 500         client_exit = yes;
 501         collision_fnc = yes;
 502         resv_fnc = yes;
 503         global_snotices = yes;
 504         dline_with_reason = yes;
 505         kline_delay = 0 seconds;
 506         kline_with_reason = yes;
 507         kline_reason = "K-Lined";
 508         identify_service = "NickServ@services.int";
 509         identify_command = "IDENTIFY";
 510         non_redundant_klines = yes;
 511         warn_no_nline = yes;
 512         use_propagated_bans = yes;
 513         stats_e_disabled = no;
 514         stats_c_oper_only=no;
 515         stats_h_oper_only=no;
 516         stats_y_oper_only=no;
 517         stats_o_oper_only=yes;
 518         stats_P_oper_only=no;
 519         stats_i_oper_only=masked;
 520         stats_k_oper_only=masked;
 521         map_oper_only = no;
 522         operspy_admin_only = no;
 523         operspy_dont_care_user_info = no;
 524         caller_id_wait = 1 minute;
 525         pace_wait_simple = 1 second;
 526         pace_wait = 10 seconds;
 527         short_motd = no;
 528         ping_cookie = no;
 529         connect_timeout = 30 seconds;
 530         default_ident_timeout = 5;
 531         disable_auth = no;
 532         no_oper_flood = yes;
 533         max_targets = 4;
 534         client_flood_max_lines = 20;
 535         use_whois_actually = no;
 536         oper_only_umodes = operwall, locops, servnotice;
 537         oper_umodes = locops, servnotice, operwall, wallop;
 538         oper_snomask = "+s";
 539         burst_away = yes;
 540         nick_delay = 0 seconds; # 15 minutes if you want to enable this
 541         reject_ban_time = 1 minute;
 542         reject_after_count = 3;
 543         reject_duration = 5 minutes;
 544         throttle_duration = 60;
 545         throttle_count = 4;
 546         max_ratelimit_tokens = 30;
 547         away_interval = 30;
 548         certfp_method = sha1;
 549         hide_opers_in_whois = no;
 550 };
 551
 552 modules {
 553         path = "modules";
 554         path = "modules/autoload";
 555 };