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