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