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