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 not
  85          * be longer than the maximum length set while building).
  86          */
  87         nicklen = 30;
  88 };
  89
  90 admin {
  91         name = "Lazy admin (lazya)";
  92         description = "StaticBox client server";
  93         email = "nobody@127.0.0.1";
  94 };
  95
  96 log {
  97         fname_userlog = "logs/userlog";
  98         #fname_fuserlog = "logs/fuserlog";
  99         fname_operlog = "logs/operlog";
 100         #fname_foperlog = "logs/foperlog";
 101         fname_serverlog = "logs/serverlog";
 102         #fname_klinelog = "logs/klinelog";
 103         fname_killlog = "logs/killlog";
 104         fname_operspylog = "logs/operspylog";
 105         #fname_ioerrorlog = "logs/ioerror";
 106 };
 107
 108 /* class {} blocks MUST be specified before anything that uses them.  That
 109  * means they must be defined before auth {} and before connect {}.
 110  */
 111 class "users" {
 112         ping_time = 2 minutes;
 113         number_per_ident = 10;
 114         number_per_ip = 10;
 115         number_per_ip_global = 50;
 116         cidr_ipv4_bitlen = 24;
 117         cidr_ipv6_bitlen = 64;
 118         number_per_cidr = 200;
 119         max_number = 3000;
 120         sendq = 400 kbytes;
 121 };
 122
 123 class "opers" {
 124         ping_time = 5 minutes;
 125         number_per_ip = 10;
 126         max_number = 1000;
 127         sendq = 1 megabyte;
 128 };
 129
 130 class "server" {
 131         ping_time = 5 minutes;
 132         connectfreq = 5 minutes;
 133         max_number = 1;
 134         sendq = 4 megabytes;
 135 };
 136
 137 listen {
 138         /* defer_accept: wait for clients to send IRC handshake data before
 139          * accepting them.  if you intend to use software which depends on the
 140          * server replying first, such as BOPM, you should disable this feature.
 141          * otherwise, you probably want to leave it on.
 142          */
 143         defer_accept = yes;
 144
 145         /* If you want to listen on a specific IP only, specify host.
 146          * host definitions apply only to the following port line.
 147          */
 148         #host = "192.169.0.1";
 149         port = 5000, 6665 .. 6669;
 150         sslport = 6697;
 151
 152         /* Listen on IPv6 (if you used host= above). */
 153         #host = "3ffe:1234:a:b:c::d";
 154         #port = 5000, 6665 .. 6669;
 155         #sslport = 9999;
 156 };
 157
 158 /* auth {}: allow users to connect to the ircd (OLD I:)
 159  * auth {} blocks MUST be specified in order of precedence.  The first one
 160  * that matches a user will be used.  So place spoofs first, then specials,
 161  * then general access, then restricted.
 162  */
 163 auth {
 164         /* user: the user@host allowed to connect.  Multiple IPv4/IPv6 user
 165          * lines are permitted per auth block.  This is matched against the
 166          * hostname and IP address (using :: shortening for IPv6 and
 167          * prepending a 0 if it starts with a colon) and can also use CIDR
 168          * masks.
 169          */
 170         user = "*@172.16.0.0/12";
 171         user = "*test@123D:B567:*";
 172
 173         /* password: an optional password that is required to use this block.
 174          * By default this is not encrypted, specify the flag "encrypted" in
 175          * flags = ...; below if it is.
 176          */
 177         password = "letmein";
 178
 179         /* spoof: fake the users user@host to be be this.  You may either
 180          * specify a host or a user@host to spoof to.  This is free-form,
 181          * just do everyone a favour and dont abuse it. (OLD I: = flag)
 182          */
 183         spoof = "I.still.hate.packets";
 184
 185         /* Possible flags in auth:
 186          *
 187          * encrypted                  | password is encrypted with mkpasswd
 188          * spoof_notice               | give a notice when spoofing hosts
 189          * exceed_limit (old > flag)  | allow user to exceed class user limits
 190          * kline_exempt (old ^ flag)  | exempt this user from k/g/xlines&dnsbls
 191          * dnsbl_exempt               | exempt this user from dnsbls
 192          * spambot_exempt             | exempt this user from spambot checks
 193          * shide_exempt               | exempt this user from serverhiding
 194          * jupe_exempt                | exempt this user from generating
 195          *                              warnings joining juped channels
 196          * resv_exempt                | exempt this user from resvs
 197          * flood_exempt               | exempt this user from flood limits
 198          *                                     USE WITH CAUTION.
 199          * no_tilde     (old - flag)  | don't prefix ~ to username if no ident
 200          * need_ident   (old + flag)  | require ident for user in this class
 201          * need_ssl                   | require SSL/TLS for user in this class
 202          * need_sasl                  | require SASL id for user in this class
 203          */
 204         flags = kline_exempt, exceed_limit;
 205
 206         /* class: the class the user is placed in */
 207         class = "opers";
 208 };
 209
 210 auth {
 211         user = "*@*";
 212         class = "users";
 213 };
 214
 215 /* privset {} blocks MUST be specified before anything that uses them.  That
 216  * means they must be defined before operator {}.
 217  */
 218 privset "local_op" {
 219         privs = oper:local_kill, oper:operwall;
 220 };
 221
 222 privset "server_bot" {
 223         extends = "local_op";
 224         privs = oper:kline, oper:remoteban, snomask:nick_changes;
 225 };
 226
 227 privset "global_op" {
 228         extends = "local_op";
 229         privs = oper:global_kill, oper:routing, oper:kline, oper:unkline, oper:xline,
 230                 oper:resv, oper:mass_notice, oper:remoteban;
 231 };
 232
 233 privset "admin" {
 234         extends = "global_op";
 235         privs = oper:admin, oper:die, oper:rehash, oper:spy;
 236 };
 237
 238 operator "god" {
 239         /* name: the name of the oper must go above */
 240
 241         /* user: the user@host required for this operator.  CIDR *is*
 242          * supported now. auth{} spoofs work here, other spoofs do not.
 243          * multiple user="" lines are supported.
 244          */
 245         user = "*god@127.0.0.1";
 246
 247         /* password: the password required to oper.  Unless ~encrypted is
 248          * contained in flags = ...; this will need to be encrypted using
 249          * mkpasswd, MD5 is supported
 250          */
 251         password = "etcnjl8juSU1E";
 252
 253         /* rsa key: the public key for this oper when using Challenge.
 254          * A password should not be defined when this is used, see
 255          * doc/challenge.txt for more information.
 256          */
 257         #rsa_public_key_file = "/usr/local/ircd/etc/oper.pub";
 258
 259         /* umodes: the specific umodes this oper gets when they oper.
 260          * If this is specified an oper will not be given oper_umodes
 261          * These are described above oper_only_umodes in general {};
 262          */
 263         #umodes = locops, servnotice, operwall, wallop;
 264
 265         /* fingerprint: if specified, the oper's client certificate
 266          * fingerprint will be checked against the specified fingerprint
 267          * below.
 268          */
 269         #fingerprint = "c77106576abf7f9f90cca0f63874a60f2e40a64b";
 270
 271         /* snomask: specific server notice mask on oper up.
 272          * If this is specified an oper will not be given oper_snomask.
 273          */
 274         snomask = "+Zbfkrsuy";
 275
 276         /* flags: misc options for the operator.  You may prefix an option
 277          * with ~ to disable it, e.g. ~encrypted.
 278          *
 279          * Default flags are encrypted.
 280          *
 281          * Available options:
 282          *
 283          * encrypted:    the password above is encrypted [DEFAULT]
 284          * need_ssl:     must be using SSL/TLS to oper up
 285          */
 286         flags = encrypted;
 287
 288         /* privset: privileges set to grant */
 289         privset = "admin";
 290 };
 291
 292 connect "irc.uplink.com" {
 293         host = "192.168.0.1";
 294         send_password = "password";
 295         accept_password = "anotherpassword";
 296         port = 6666;
 297         hub_mask = "*";
 298         class = "server";
 299         flags = compressed, topicburst;
 300
 301         #fingerprint = "c77106576abf7f9f90cca0f63874a60f2e40a64b";
 302
 303         /* If the connection is IPv6, uncomment below.
 304          * Use 0::1, not ::1, for IPv6 localhost. */
 305         #aftype = ipv6;
 306 };
 307
 308 connect "ssl.uplink.com" {
 309         host = "192.168.0.1";
 310         send_password = "password";
 311         accept_password = "anotherpassword";
 312         port = 9999;
 313         hub_mask = "*";
 314         class = "server";
 315         flags = ssl, topicburst;
 316 };
 317
 318 service {
 319         name = "services.int";
 320 };
 321
 322 cluster {
 323         name = "*";
 324         flags = kline, tkline, unkline, xline, txline, unxline, resv, tresv, unresv;
 325 };
 326
 327 shared {
 328         oper = "*@*", "*";
 329         flags = all, rehash;
 330 };
 331
 332 /* exempt {}: IPs that are exempt from Dlines and rejectcache. (OLD d:) */
 333 exempt {
 334         ip = "127.0.0.1";
 335 };
 336
 337 channel {
 338         use_invex = yes;
 339         use_except = yes;
 340         use_forward = yes;
 341         use_knock = yes;
 342         knock_delay = 5 minutes;
 343         knock_delay_channel = 1 minute;
 344         max_chans_per_user = 15;
 345         max_bans = 100;
 346         max_bans_large = 500;
 347         default_split_user_count = 0;
 348         default_split_server_count = 0;
 349         no_create_on_split = no;
 350         no_join_on_split = no;
 351         burst_topicwho = yes;
 352         kick_on_split_riding = no;
 353         only_ascii_channels = no;
 354         resv_forcepart = yes;
 355         channel_target_change = yes;
 356         disable_local_channels = no;
 357 };
 358
 359 serverhide {
 360         flatten_links = yes;
 361         links_delay = 5 minutes;
 362         hidden = no;
 363         disable_hidden = no;
 364 };
 365
 366 /* These are the blacklist settings.
 367  * You can have multiple combinations of host and rejection reasons.
 368  * They are used in pairs of one host/rejection reason.
 369  *
 370  * These settings should be adequate for most networks, and are (presently)
 371  * required for use on StaticBox.
 372  *
 373  * Word to the wise: Do not use blacklists like SPEWS for blocking IRC
 374  * connections.
 375  *
 376  * As of charybdis 2.2, you can do some keyword substitution on the rejection
 377  * reason. The available keyword substitutions are:
 378  *
 379  *   ${ip}           - the user's IP
 380  *   ${host}         - the user's canonical hostname
 381  *   ${dnsbl-host}   - the dnsbl hostname the lookup was done against
 382  *   ${nick}         - the user's nickname
 383  *   ${network-name} - the name of the network
 384  *
 385  * As of charybdis 3.4, a type parameter is supported, which specifies the
 386  * address families the blacklist supports. IPv4 and IPv6 are supported.
 387  * IPv4 is currently the default as few blacklists support IPv6 operation
 388  * as of this writing.
 389  *
 390  * Note: AHBL (the providers of the below *.ahbl.org BLs) request that they be
 391  * contacted, via email, at admins@2mbit.com before using these BLs.
 392  * See <http://www.ahbl.org/services.php> for more information.
 393  */
 394 blacklist {
 395         host = "rbl.efnetrbl.org";
 396         type = ipv4;
 397         reject_reason = "${nick}, your IP (${ip}) is listed in EFnet's RBL. For assistance, see http://efnetrbl.org/?i=${ip}";
 398
 399 #       host = "ircbl.ahbl.org";
 400 #       type = ipv4;
 401 #       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.";
 402 #
 403 #       host = "tor.ahbl.org";
 404 #       type = ipv4;
 405 #       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.";
 406 #
 407         /* Example of a blacklist that supports both IPv4 and IPv6 */
 408 #       host = "foobl.blacklist.invalid";
 409 #       type = ipv4, ipv6;
 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 };