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