doc/ircd.conf.example

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