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