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