doc/example.conf

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