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 = 6697;
 168
 169         /* wsock: listeners defined with this option enabled will be websocket listeners,
 170          * and will not accept normal clients.
 171          */
 172         wsock = yes;
 173         sslport = 9999;
 174 };
 175
 176 /* auth {}: allow users to connect to the ircd (OLD I:)
 177  * auth {} blocks MUST be specified in order of precedence.  The first one
 178  * that matches a user will be used.  So place spoofs first, then specials,
 179  * then general access, then restricted.
 180  */
 181 auth {
 182         /* user: the user@host allowed to connect.  Multiple IPv4/IPv6 user
 183          * lines are permitted per auth block.  This is matched against the
 184          * hostname and IP address (using :: shortening for IPv6 and
 185          * prepending a 0 if it starts with a colon) and can also use CIDR
 186          * masks.
 187          */
 188         user = "*@198.51.100.0/24";
 189         user = "*test@2001:db8:1:*";
 190
 191         /* password: an optional password that is required to use this block.
 192          * By default this is not encrypted, specify the flag "encrypted" in
 193          * flags = ...; below if it is.
 194          */
 195         password = "letmein";
 196
 197         /* spoof: fake the users user@host to be be this.  You may either
 198          * specify a host or a user@host to spoof to.  This is free-form,
 199          * just do everyone a favour and dont abuse it. (OLD I: = flag)
 200          */
 201         spoof = "I.still.hate.packets";
 202
 203         /* Possible flags in auth:
 204          *
 205          * encrypted                  | password is encrypted with mkpasswd
 206          * spoof_notice               | give a notice when spoofing hosts
 207          * exceed_limit (old > flag)  | allow user to exceed class user limits
 208          * kline_exempt (old ^ flag)  | exempt this user from k/g/xlines,
 209          *                            | dnsbls, and proxies
 210          * proxy_exempt               | exempt this user from proxies
 211          * dnsbl_exempt               | exempt this user from dnsbls
 212          * spambot_exempt             | exempt this user from spambot checks
 213          * shide_exempt               | exempt this user from serverhiding
 214          * jupe_exempt                | exempt this user from generating
 215          *                              warnings joining juped channels
 216          * resv_exempt                | exempt this user from resvs
 217          * flood_exempt               | exempt this user from flood limits
 218          *                              USE WITH CAUTION.
 219          * no_tilde     (old - flag)  | don't prefix ~ to username if no ident
 220          * need_ident   (old + flag)  | require ident for user in this class
 221          * need_ssl                   | require SSL/TLS for user in this class
 222          * need_sasl                  | require SASL id for user in this class
 223          */
 224         flags = kline_exempt, exceed_limit;
 225
 226         /* class: the class the user is placed in */
 227         class = "opers";
 228 };
 229
 230 auth {
 231         user = "*@*";
 232         class = "users";
 233 };
 234
 235 /* privset {} blocks MUST be specified before anything that uses them.  That
 236  * means they must be defined before operator {}.
 237  */
 238 privset "local_op" {
 239         privs = oper:general, oper:privs, oper:testline, oper:kill, oper:operwall, usermode:servnotice,
 240                 auspex:oper, auspex:hostname, auspex:umodes, auspex:cmodes;
 241 };
 242
 243 privset "server_bot" {
 244         extends = "local_op";
 245         privs = oper:kline, oper:remoteban, snomask:nick_changes;
 246 };
 247
 248 privset "global_op" {
 249         extends = "local_op";
 250         privs = oper:routing, oper:kline, oper:unkline, oper:xline,
 251                 oper:resv, oper:cmodes, oper:mass_notice, oper:remoteban;
 252 };
 253
 254 privset "admin" {
 255         extends = "global_op";
 256         privs = oper:admin, oper:die, oper:rehash, oper:spy, oper:grant;
 257 };
 258
 259 operator "god" {
 260         /* name: the name of the oper must go above */
 261
 262         /* user: the user@host required for this operator.  CIDR *is*
 263          * supported now. auth{} spoofs work here, other spoofs do not.
 264          * multiple user="" lines are supported.
 265          */
 266         user = "*god@127.0.0.1";
 267
 268         /* password: the password required to oper.  Unless ~encrypted is
 269          * contained in flags = ...; this will need to be encrypted using
 270          * mkpasswd, MD5 is supported
 271          */
 272         password = "etcnjl8juSU1E";
 273
 274         /* rsa key: the public key for this oper when using Challenge.
 275          * A password should not be defined when this is used, see
 276          * doc/challenge.txt for more information.
 277          */
 278         #rsa_public_key_file = "/usr/local/ircd/etc/oper.pub";
 279
 280         /* umodes: the specific umodes this oper gets when they oper.
 281          * If this is specified an oper will not be given oper_umodes
 282          * These are described above oper_only_umodes in general {};
 283          */
 284         #umodes = locops, servnotice, operwall, wallop;
 285
 286         /* fingerprint: if specified, the oper's client certificate
 287          * fingerprint will be checked against the specified fingerprint
 288          * below.
 289          */
 290         #fingerprint = "c77106576abf7f9f90cca0f63874a60f2e40a64b";
 291
 292         /* snomask: specific server notice mask on oper up.
 293          * If this is specified an oper will not be given oper_snomask.
 294          */
 295         snomask = "+Zbfkrsuy";
 296
 297         /* flags: misc options for the operator.  You may prefix an option
 298          * with ~ to disable it, e.g. ~encrypted.
 299          *
 300          * Default flags are encrypted.
 301          *
 302          * Available options:
 303          *
 304          * encrypted:    the password above is encrypted [DEFAULT]
 305          * need_ssl:     must be using SSL/TLS to oper up
 306          */
 307         flags = encrypted;
 308
 309         /* privset: privileges set to grant */
 310         privset = "admin";
 311 };
 312
 313 connect "irc.uplink.com" {
 314         host = "203.0.113.3";
 315         send_password = "password";
 316         accept_password = "anotherpassword";
 317         port = 6666;
 318         hub_mask = "*";
 319         class = "server";
 320         flags = compressed, topicburst;
 321
 322         #fingerprint = "c77106576abf7f9f90cca0f63874a60f2e40a64b";
 323 };
 324
 325 connect "ssl.uplink.com" {
 326         host = "203.0.113.129";
 327         send_password = "password";
 328         accept_password = "anotherpassword";
 329         port = 9999;
 330         hub_mask = "*";
 331         class = "server";
 332         flags = ssl, topicburst;
 333 };
 334
 335 service {
 336         name = "services.int";
 337 };
 338
 339 cluster {
 340         name = "*";
 341         flags = kline, tkline, unkline, xline, txline, unxline, resv, tresv, unresv;
 342 };
 343
 344 shared {
 345         oper = "*@*", "*";
 346         flags = all, rehash;
 347 };
 348
 349 secure {
 350         ip = "127.0.0.1";
 351 };
 352
 353 /* exempt {}: IPs that are exempt from Dlines and rejectcache. (OLD d:) */
 354 exempt {
 355         ip = "127.0.0.1";
 356 };
 357
 358 channel {
 359         use_invex = yes;
 360         use_except = yes;
 361         use_forward = yes;
 362         use_knock = yes;
 363         knock_delay = 5 minutes;
 364         knock_delay_channel = 1 minute;
 365         max_chans_per_user = 15;
 366         max_chans_per_user_large = 60;
 367         max_bans = 100;
 368         max_bans_large = 500;
 369         default_split_user_count = 0;
 370         default_split_server_count = 0;
 371         no_create_on_split = no;
 372         no_join_on_split = no;
 373         burst_topicwho = yes;
 374         kick_on_split_riding = no;
 375         only_ascii_channels = no;
 376         resv_forcepart = yes;
 377         channel_target_change = yes;
 378         disable_local_channels = no;
 379         autochanmodes = "+nt";
 380         displayed_usercount = 3;
 381         strip_topic_colors = no;
 382         opmod_send_statusmsg = no;
 383 };
 384
 385 serverhide {
 386         flatten_links = yes;
 387         links_delay = 5 minutes;
 388         hidden = no;
 389         disable_hidden = no;
 390 };
 391
 392 /* These are the DNSBL settings.
 393  * You can have multiple combinations of host and rejection reasons.
 394  * They are used in pairs of one host/rejection reason.
 395  *
 396  * The default settings should be adequate for most networks.
 397  *
 398  * It is not recommended to use DNSBL services designed for e-mail spam
 399  * prevention, such as SPEWS for blocking IRC connections.
 400  *
 401  * As of charybdis 2.2, you can do some keyword substitution on the rejection
 402  * reason. The available keyword substitutions are:
 403  *
 404  *   ${ip}           - the user's IP
 405  *   ${host}         - the user's canonical hostname
 406  *   ${dnsbl-host}   - the dnsbl hostname the lookup was done against
 407  *   ${nick}         - the user's nickname
 408  *   ${network-name} - the name of the network
 409  *
 410  * As of charybdis 3.4, a type parameter is supported, which specifies the
 411  * address families the blacklist supports. IPv4 and IPv6 are supported.
 412  * IPv4 is currently the default as few blacklists support IPv6 operation
 413  * as of this writing.
 414  *
 415  * As of charybdis 3.5, a matches parameter is allowed; if omitted, any result
 416  * is considered a match. If included, a comma-separated list of *quoted*
 417  * strings is allowed to match queries. They may be of the format "0" to "255"
 418  * to match the final octet (e.g. 127.0.0.1) or "127.x.y.z" to explicitly match
 419  * an A record. The DNSBL match is only applied if it matches anything in the
 420  * list. You may freely mix full IP's and final octets.
 421  *
 422  * Consult your DNSBL provider for the meaning of these parameters; they
 423  * are usually used to denote different block reasons.
 424  */
 425 dnsbl {
 426         host = "rbl.efnetrbl.org";
 427         type = ipv4;
 428         reject_reason = "${nick}, your IP (${ip}) is listed in EFnet's RBL. For assistance, see http://efnetrbl.org/?i=${ip}";
 429
 430         /* Example of a blacklist that supports both IPv4 and IPv6 and using matches */
 431 #       host = "foobl.blacklist.invalid";
 432 #       type = ipv4, ipv6;
 433 #       matches = "4", "6", "127.0.0.10";
 434 #       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";
 435 };
 436
 437 /* These are the OPM settings.
 438  * This is similar to the functionality provided by BOPM. It will scan incoming
 439  * connections for open proxies by connecting to clients and attempting several
 440  * different open proxy handshakes. If they connect back to us (via a dedicated
 441  * listening port), and send back the data we send them, they are considered
 442  * an open proxy. For politeness reasons (users may be confused by the incoming
 443  * connection attempts if they are logging incoming connections), the user is
 444  * notified upon connect if they are being scanned.
 445  *
 446  * WARNING:
 447  * These settings are considered experimental. Only the most common proxy types
 448  * are checked for (Charybdis is immune from POST and GET proxies). If you are
 449  * not comfortable with experimental code, do not use this feature.
 450  */
 451 #opm {
 452         /* IPv4 address to listen on. This must be a publicly facing IP address
 453          * to be effective.
 454          * If omitted, it defaults to serverinfo::vhost.
 455          */
 456         #listen_ipv4 = "127.0.0.1";
 457
 458         /* IPv4 port to listen on.
 459          * This should not be the same as any existing listeners.
 460          */
 461         #port_v4 = 32000;
 462
 463         /* IPv6 address to listen on. This must be a publicly facing IP address
 464          * to be effective.
 465          * If omitted, it defaults to serverinfo::vhost6.
 466          */
 467         #listen_ipv6 = "::1";
 468
 469         /* IPv6 port to listen on.
 470          * This should not be the same as any existing listeners.
 471          */
 472         #port_v6 = 32000;
 473
 474         /* You can also set the listen_port directive which will set both the
 475          * IPv4 and IPv6 ports at once.
 476          */
 477         #listen_port = 32000;
 478
 479         /* This sets the timeout in seconds before ending open proxy scans.
 480          * Values less than 1 or greater than 60 are ignored.
 481          * It is advisable to keep it as short as feasible, so clients do not
 482          * get held up by excessively long scan times.
 483          */
 484         #timeout = 5;
 485
 486         /* These are the ports to scan for SOCKS4 proxies on. They may overlap
 487          * with other scan types. Sensible defaults are given below.
 488          */
 489         #socks4_ports = 1080, 10800, 443, 80, 8080, 8000;
 490
 491         /* These are the ports to scan for SOCKS5 proxies on. They may overlap
 492          * with other scan types. Sensible defaults are given below.
 493          */
 494         #socks5_ports = 1080, 10800, 443, 80, 8080, 8000;
 495
 496         /* These are the ports to scan for HTTP connect proxies on (plaintext).
 497          * They may overlap with other scan types. Sensible defaults are given
 498          * below.
 499          */
 500         #httpconnect_ports = 80, 8080, 8000;
 501
 502         /* These are the ports to scan for HTTPS CONNECT proxies on (SSL).
 503          * They may overlap with other scan types. Sensible defaults are given
 504          * below.
 505          */
 506         #httpsconnect_ports = 443, 4443;
 507 #};
 508
 509 alias "NickServ" {
 510         target = "NickServ";
 511 };
 512
 513 alias "ChanServ" {
 514         target = "ChanServ";
 515 };
 516
 517 alias "OperServ" {
 518         target = "OperServ";
 519 };
 520
 521 alias "MemoServ" {
 522         target = "MemoServ";
 523 };
 524
 525 alias "NS" {
 526         target = "NickServ";
 527 };
 528
 529 alias "CS" {
 530         target = "ChanServ";
 531 };
 532
 533 alias "OS" {
 534         target = "OperServ";
 535 };
 536
 537 alias "MS" {
 538         target = "MemoServ";
 539 };
 540
 541 general {
 542         hide_error_messages = opers;
 543         hide_spoof_ips = yes;
 544
 545         /*
 546          * default_umodes: umodes to enable on connect.
 547          * If you have enabled the new ip_cloaking_4.0 module, and you want
 548          * to make use of it, add +x to this option, i.e.:
 549          *      default_umodes = "+ix";
 550          *
 551          * If you have enabled the old ip_cloaking module, and you want
 552          * to make use of it, add +h to this option, i.e.:
 553          *      default_umodes = "+ih";
 554          */
 555         default_umodes = "+i";
 556
 557         default_operstring = "is an IRC Operator";
 558         default_adminstring = "is a Server Administrator";
 559         servicestring = "is a Network Service";
 560
 561         /*
 562          * Nick of the network's SASL agent. Used to check whether services are here,
 563          * SASL credentials are only sent to its server. Needs to be a service.
 564          *
 565          * Defaults to SaslServ if unspecified.
 566          */
 567         sasl_service = "SaslServ";
 568         disable_fake_channels = no;
 569         tkline_expire_notices = no;
 570         default_floodcount = 10;
 571         failed_oper_notice = yes;
 572         dots_in_ident = 2;
 573         min_nonwildcard = 4;
 574         min_nonwildcard_simple = 3;
 575         max_accept = 100;
 576         max_monitor = 100;
 577         anti_nick_flood = yes;
 578         max_nick_time = 20 seconds;
 579         max_nick_changes = 5;
 580         anti_spam_exit_message_time = 5 minutes;
 581         ts_warn_delta = 30 seconds;
 582         ts_max_delta = 5 minutes;
 583         client_exit = yes;
 584         collision_fnc = yes;
 585         resv_fnc = yes;
 586         global_snotices = yes;
 587         dline_with_reason = yes;
 588         kline_with_reason = yes;
 589         hide_tkdline_duration = no;
 590         kline_reason = "K-Lined";
 591         identify_service = "NickServ@services.int";
 592         identify_command = "IDENTIFY";
 593         non_redundant_klines = yes;
 594         warn_no_nline = yes;
 595         use_propagated_bans = yes;
 596         stats_e_disabled = no;
 597         stats_c_oper_only = no;
 598         stats_h_oper_only = no;
 599         stats_y_oper_only = no;
 600         stats_o_oper_only = yes;
 601         stats_P_oper_only = no;
 602         stats_i_oper_only = masked;
 603         stats_k_oper_only = masked;
 604         map_oper_only = no;
 605         operspy_admin_only = no;
 606         operspy_dont_care_user_info = no;
 607         caller_id_wait = 1 minute;
 608         pace_wait_simple = 1 second;
 609         pace_wait = 10 seconds;
 610         short_motd = no;
 611         ping_cookie = no;
 612         connect_timeout = 30 seconds;
 613         default_ident_timeout = 5;
 614         disable_auth = no;
 615         no_oper_flood = yes;
 616         max_targets = 4;
 617         client_flood_max_lines = 20;
 618         post_registration_delay = 0 seconds;
 619         use_whois_actually = no;
 620         oper_only_umodes = operwall, locops, servnotice;
 621         oper_umodes = locops, servnotice, operwall, wallop;
 622         oper_snomask = "+s";
 623         burst_away = yes;
 624         nick_delay = 0 seconds; # 15 minutes if you want to enable this
 625         reject_ban_time = 1 minute;
 626         reject_after_count = 3;
 627         reject_duration = 5 minutes;
 628         throttle_duration = 60;
 629         throttle_count = 4;
 630         max_ratelimit_tokens = 30;
 631         away_interval = 30;
 632         certfp_method = spki_sha256;
 633         hide_opers_in_whois = no;
 634         tls_ciphers_oper_only = no;
 635 };
 636
 637 modules {
 638         path = "modules";
 639         path = "modules/autoload";
 640 };