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