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_adminonly.so";
  14 loadmodule "extensions/chm_operonly.so";
  15 #loadmodule "extensions/chm_sslonly.so";
  16 #loadmodule "extensions/chm_operonly_compat.so";
  17 #loadmodule "extensions/chm_quietunreg_compat.so";
  18 #loadmodule "extensions/chm_sslonly_compat.so";
  19 #loadmodule "extensions/createauthonly.so";
  20 loadmodule "extensions/extb_account.so";
  21 loadmodule "extensions/extb_canjoin.so";
  22 loadmodule "extensions/extb_channel.so";
  23 loadmodule "extensions/extb_extgecos.so";
  24 loadmodule "extensions/extb_oper.so";
  25 loadmodule "extensions/extb_realname.so";
  26 #loadmodule "extensions/extb_server.so";
  27 #loadmodule "extensions/extb_ssl.so";
  28 #loadmodule "extensions/hurt.so";
  29 loadmodule "extensions/ip_cloaking.so";
  30 #loadmodule "extensions/m_findforwards.so";
  31 loadmodule "extensions/m_identify.so";
  32 loadmodule "extensions/m_mkpasswd.so";
  33 loadmodule "extensions/m_webirc.so";
  34 #loadmodule "extensions/m_cycle.so";
  35 #loadmodule "extensions/m_oaccept.so";
  36 #loadmodule "extensions/m_opme.so";
  37 #loadmodule "extensions/m_ojoin.so";
  38 #loadmodule "extensions/m_omode.so";
  39 #loadmodule "extensions/m_olist.so";
  40 #loadmodule "extensions/m_okick.so";
  41 #loadmodule "extensions/m_force.so";
  42 #loadmodule "extensions/no_oper_invis.so";
  43 loadmodule "extensions/sno_farconnect.so";
  44 loadmodule "extensions/sno_globalkline.so";
  45 loadmodule "extensions/sno_globaloper.so";
  46 #loadmodule "extensions/sno_whois.so";
  47
  48 serverinfo {
  49         name = "hades.arpa";
  50         sid = "42X";
  51         description = "shadowircd test server";
  52         network_name = "AthemeNET";
  53         network_desc = "Your IRC network.";
  54         helpchan = "#help";
  55         helpurl = "http://www.mynet.net/help";
  56         hub = yes;
  57
  58         /* On multi-homed hosts you may need the following. These define
  59          * the addresses we connect from to other servers. */
  60         /* for IPv4 */
  61         #vhost = "192.169.0.1";
  62         /* for IPv6 */
  63         #vhost6 = "3ffe:80e8:546::2";
  64
  65         /* ssl_private_key: our ssl private key */
  66         ssl_private_key = "etc/test.key";
  67
  68         /* ssl_cert: certificate for our ssl server */
  69         ssl_cert = "etc/test.cert";
  70
  71         /* ssl_dh_params: DH parameters, generate with openssl dhparam -out dh.pem 1024 */
  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
  90 admin {
  91         name = "Lazy admin (lazya)";
  92         description = "AthemeNET 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         /* If you want to listen on a specific IP only, specify host.
 139          * host definitions apply only to the following port line.
 140          */
 141         #host = "192.169.0.1";
 142         port = 5000, 6665 .. 6669;
 143         sslport = 6697;
 144
 145         /* Listen on IPv6 (if you used host= above). */
 146         #host = "3ffe:1234:a:b:c::d";
 147         #port = 5000, 6665 .. 6669;
 148         #sslport = 9999;
 149 };
 150
 151 /* auth {}: allow users to connect to the ircd (OLD I:)
 152  * auth {} blocks MUST be specified in order of precedence.  The first one
 153  * that matches a user will be used.  So place spoofs first, then specials,
 154  * then general access, then restricted.
 155  */
 156 auth {
 157         /* user: the user@host allowed to connect.  Multiple IPv4/IPv6 user
 158          * lines are permitted per auth block.  This is matched against the
 159          * hostname and IP address (using :: shortening for IPv6 and
 160          * prepending a 0 if it starts with a colon) and can also use CIDR
 161          * masks.
 162          */
 163         user = "*@172.16.0.0/12";
 164         user = "*test@123D:B567:*";
 165
 166         /* password: an optional password that is required to use this block.
 167          * By default this is not encrypted, specify the flag "encrypted" in
 168          * flags = ...; below if it is.
 169          */
 170         password = "letmein";
 171
 172         /* spoof: fake the users user@host to be be this.  You may either
 173          * specify a host or a user@host to spoof to.  This is free-form,
 174          * just do everyone a favour and dont abuse it. (OLD I: = flag)
 175          */
 176         spoof = "I.still.hate.packets";
 177
 178         /* autojoin: Channel (or channels, comma-seperated) to join users
 179          * in this auth block to on connect. Note that this won't join
 180          * the user through any bans or otherwise restrictive chmodes.
 181          */
 182         autojoin = "#shadowircd,#test";
 183
 184         /* autojoin_opers : Channel (or channels, comma-seperated) to join
 185          * opers to on oper-up.
 186          */
 187         autojoin_opers = "#opers,#help";
 188
 189         /* Possible flags in auth:
 190          *
 191          * encrypted                  | password is encrypted with mkpasswd
 192          * spoof_notice               | give a notice when spoofing hosts
 193          * exceed_limit (old > flag)  | allow user to exceed class user limits
 194          * kline_exempt (old ^ flag)  | exempt this user from k/g/xlines&dnsbls
 195          * dnsbl_exempt               | exempt this user from dnsbls
 196          * spambot_exempt             | exempt this user from spambot checks
 197          * shide_exempt               | exempt this user from serverhiding
 198          * jupe_exempt                | exempt this user from generating
 199          *                              warnings joining juped channels
 200          * resv_exempt                | exempt this user from resvs
 201          * flood_exempt               | exempt this user from flood limits
 202          *                                     USE WITH CAUTION.
 203          * no_tilde     (old - flag)  | don't prefix ~ to username if no ident
 204          * need_ident   (old + flag)  | require ident for user in this class
 205          * need_ssl                   | require SSL/TLS for user in this class
 206          * need_sasl                  | require SASL id for user in this class
 207          */
 208         flags = kline_exempt, exceed_limit;
 209
 210         /* class: the class the user is placed in */
 211         class = "opers";
 212 };
 213
 214 /* Example WEBIRC authblock */
 215 auth {
 216         /* user: webirc@IP.OF.YOUR.WEBIRC . the webirc@ part is required */
 217         user = "webirc@192.168.1.1";
 218
 219         /* password: password the webirc client sends in the WEBIRC command.
 220          * You can use a encrypted password here (see above auth block).
 221          */
 222         password = "<password>";
 223
 224         /* spoof: This is required to keep it what it is currently if you
 225          * want the webirc client to show the users' real host as their
 226          * host on IRC.
 227          */
 228         spoof = "webirc.";
 229         class = "users";
 230 };
 231
 232 auth {
 233         user = "*@*";
 234         class = "users";
 235 };
 236
 237 /* privset {} blocks MUST be specified before anything that uses them.  That
 238  * means they must be defined before operator {}.
 239  */
 240 privset "local_op" {
 241         privs = oper:local_kill, oper:operwall;
 242 };
 243
 244 privset "server_bot" {
 245         extends = "local_op";
 246         privs = oper:kline, oper:remoteban, snomask:nick_changes;
 247 };
 248
 249 privset "global_op" {
 250         extends = "local_op";
 251         privs = oper:global_kill, oper:routing, oper:kline, oper:unkline, oper:xline,
 252                 oper:resv, oper:mass_notice, oper:remoteban;
 253 };
 254
 255 privset "admin" {
 256         extends = "global_op";
 257         privs = oper:admin, oper:die, oper:rehash, oper:spy, oper:override;
 258 };
 259
 260 operator "god" {
 261         /* name: the name of the oper must go above */
 262
 263         /* user: the user@host required for this operator.  CIDR *is*
 264          * supported now. auth{} spoofs work here, other spoofs do not.
 265          * multiple user="" lines are supported.
 266          */
 267         user = "*god@127.0.0.1";
 268
 269         /* password: the password required to oper.  Unless ~encrypted is
 270          * contained in flags = ...; this will need to be encrypted using
 271          * mkpasswd, MD5 is supported
 272          */
 273         password = "etcnjl8juSU1E";
 274
 275         /* rsa key: the public key for this oper when using Challenge.
 276          * A password should not be defined when this is used, see
 277          * doc/challenge.txt for more information.
 278          */
 279         #rsa_public_key_file = "/usr/local/ircd/etc/oper.pub";
 280
 281         /* umodes: the specific umodes this oper gets when they oper.
 282          * If this is specified an oper will not be given oper_umodes
 283          * These are described above oper_only_umodes in general {};
 284          */
 285         #umodes = locops, servnotice, operwall, wallop;
 286
 287         /* fingerprint: if specified, the oper's client certificate
 288          * fingerprint will be checked against the specified fingerprint
 289          * below.
 290          */
 291         #fingerprint = "c77106576abf7f9f90cca0f63874a60f2e40a64b";
 292
 293         /* snomask: specific server notice mask on oper up.
 294          * If this is specified an oper will not be given oper_snomask.
 295          */
 296         snomask = "+Zbfkrsuy";
 297
 298         /* vhost: defines the vhost that this oper will get on oper up.
 299          * this must be a valid hostmask. If this is specified the oper
 300          * will not be given default_operhost.
 301          */
 302         vhost = "is.an.oper";
 303
 304         /* swhois: defines an additional line that will be displayed
 305          * whenever someone does /whois on the oper in question.
 306          */
 307         swhois = "is wearing pants.";
 308
 309         /* operstring: defines a custom operstring for this oper,
 310          * which will be shown in whois instead of default_operstring
 311          * or default_adminstring.
 312          */
 313         operstring = "is a lazy IRC Operator";
 314
 315         /* flags: misc options for the operator.  You may prefix an option
 316          * with ~ to disable it, e.g. ~encrypted.
 317          *
 318          * Default flags are encrypted.
 319          *
 320          * Available options:
 321          *
 322          * encrypted:    the password above is encrypted [DEFAULT]
 323          * need_ssl:     must be using SSL/TLS to oper up
 324          */
 325         flags = encrypted;
 326
 327         /* privset: privileges set to grant */
 328         privset = "admin";
 329 };
 330
 331 connect "irc.uplink.com" {
 332         host = "192.168.0.1";
 333         send_password = "password";
 334         accept_password = "anotherpassword";
 335         port = 6666;
 336         hub_mask = "*";
 337         class = "server";
 338         flags = compressed, topicburst;
 339
 340         /* If the connection is IPv6, uncomment below.
 341          * Use 0::1, not ::1, for IPv6 localhost. */
 342         #aftype = ipv6;
 343 };
 344
 345 connect "ssl.uplink.com" {
 346         host = "192.168.0.1";
 347         send_password = "password";
 348         accept_password = "anotherpassword";
 349         port = 9999;
 350         hub_mask = "*";
 351         class = "server";
 352         flags = ssl, topicburst;
 353 };
 354
 355 service {
 356         name = "services.int";
 357 };
 358
 359 cluster {
 360         name = "*";
 361         flags = kline, tkline, unkline, xline, txline, unxline, resv, tresv, unresv;
 362 };
 363
 364 shared {
 365         oper = "*@*", "*";
 366         flags = all;
 367 };
 368
 369 /* exempt {}: IPs that are exempt from Dlines and rejectcache. (OLD d:) */
 370 exempt {
 371         ip = "127.0.0.1";
 372 };
 373
 374 channel {
 375         #disabledmodes = "ME";
 376         autochanmodes = "nt";
 377         admin_on_channel_create = no;
 378         exemptchanops = "NT";
 379         use_halfop = yes;
 380         use_admin = yes;
 381         use_knock = yes;
 382         use_local_channels = yes;
 383         knock_delay = 5 minutes;
 384         knock_delay_channel = 1 minute;
 385         max_chans_per_user = 15;
 386         max_bans = 100;
 387         max_bans_large = 500;
 388         default_split_user_count = 0;
 389         default_split_server_count = 0;
 390         no_create_on_split = no;
 391         no_join_on_split = no;
 392         burst_topicwho = yes;
 393         kick_on_split_riding = no;
 394         only_ascii_channels = no;
 395         cycle_host_change = yes;
 396         host_in_topic = yes;
 397         resv_forcepart = yes;
 398         channel_target_change = yes;
 399 };
 400
 401 serverhide {
 402         flatten_links = yes;
 403         links_delay = 5 minutes;
 404         hidden = no;
 405         disable_hidden = no;
 406 };
 407
 408 /* These are the blacklist settings.
 409  * You can have multiple combinations of host and rejection reasons.
 410  * They are used in pairs of one host/rejection reason.
 411  *
 412  * These settings should be adequate for most networks, and are (presently)
 413  * required for use on AthemeNet.
 414  *
 415  * Word to the wise: Do not use blacklists like SPEWS for blocking IRC
 416  * connections.
 417  *
 418  * As of charybdis 2.1.3, you can do some keyword substitution on the rejection
 419  * reason. The available keyword substitutions are:
 420  *
 421  *   ${ip}           - the user's IP
 422  *   ${host}         - the user's canonical hostname
 423  *   ${dnsbl-host}   - the dnsbl hostname the lookup was done against
 424  *   ${nick}         - the user's nickname
 425  *   ${network-name} - the name of the network
 426  *
 427  * Note: AHBL (the providers of the below *.ahbl.org BLs) request that they be
 428  * contacted, via email, at admins@2mbit.com before using these BLs.
 429  * See <http://www.ahbl.org/services.php> for more information.
 430  */
 431 blacklist {
 432         host = "rbl.efnetrbl.org";
 433         reject_reason = "${nick}, your IP (${ip}) is listed in EFnet's RBL. For assistance, see http://efnetrbl.org/?i=${ip}";
 434
 435         host = "dnsbl.dronebl.org";
 436         reject_reason = "${nick}, your IP (${ip}) is listed in DroneBL. For assistance, see http://dronebl.org/lookup_branded.do?ip=${ip}&network=${network-name}";
 437
 438 #       host = "ircbl.ahbl.org";
 439 #       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.";
 440 #
 441 #       host = "tor.ahbl.org";
 442 #       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.";
 443 };
 444
 445 alias "NickServ" {
 446         target = "NickServ";
 447 };
 448
 449 alias "ChanServ" {
 450         target = "ChanServ";
 451 };
 452
 453 alias "OperServ" {
 454         target = "OperServ";
 455 };
 456
 457 alias "MemoServ" {
 458         target = "MemoServ";
 459 };
 460
 461 alias "HostServ" {
 462         target = "HostServ";
 463 };
 464
 465 alias "BotServ" {
 466         target = "BotServ";
 467 };
 468
 469 alias "InfoServ" {
 470         target = "InfoServ";
 471 };
 472
 473 alias "GroupServ" {
 474         target = "GroupServ";
 475 };
 476
 477 alias "NS" {
 478         target = "NickServ";
 479 };
 480
 481 alias "CS" {
 482         target = "ChanServ";
 483 };
 484
 485 alias "OS" {
 486         target = "OperServ";
 487 };
 488
 489 alias "MS" {
 490         target = "MemoServ";
 491 };
 492
 493 alias "HS" {
 494         target = "HostServ";
 495 };
 496
 497 alias "BS" {
 498         target = "BotServ";
 499 };
 500
 501 alias "IS" {
 502         target = "InfoServ";
 503 };
 504
 505 alias "GS" {
 506         target = "GroupServ";
 507 };
 508
 509 general {
 510         hide_error_messages = opers;
 511         hide_spoof_ips = yes;
 512
 513         /*
 514          * default umodes: umodes to set upon connection
 515          * If you have enabled the ip_cloaking extension, and you wish for
 516          * incoming clients to be cloaked upon connection, +x must be in
 517          * the umode string below.
 518          */
 519         default_umodes = "+ix";
 520
 521         default_operstring = "is an IRC Operator";
 522         default_adminstring = "is a Server Administrator";
 523         default_operhost = "staff.testnet.net";
 524         #static_quit = "I like turtles!";
 525         servicestring = "is a Network Service";
 526         disable_fake_channels = no;
 527         hide_channel_below_users = 3;
 528         tkline_expire_notices = no;
 529         default_floodcount = 10;
 530         failed_oper_notice = yes;
 531         dots_in_ident=2;
 532         min_nonwildcard = 4;
 533         min_nonwildcard_simple = 3;
 534         max_accept = 100;
 535         max_monitor = 100;
 536         anti_nick_flood = yes;
 537         max_nick_time = 20 seconds;
 538         max_nick_changes = 5;
 539         anti_spam_exit_message_time = 5 minutes;
 540         use_part_messages = yes;
 541         ts_warn_delta = 30 seconds;
 542         ts_max_delta = 5 minutes;
 543         client_exit = yes;
 544         collision_fnc = yes;
 545         global_snotices = yes;
 546         dline_with_reason = yes;
 547         kline_delay = 0 seconds;
 548         kline_with_reason = yes;
 549         kline_reason = "K-Lined";
 550         identify_service = "NickServ@services.int";
 551         identify_command = "IDENTIFY";
 552         non_redundant_klines = yes;
 553         warn_no_nline = yes;
 554         use_propagated_bans = yes;
 555         stats_e_disabled = no;
 556         stats_c_oper_only=no;
 557         stats_h_oper_only=no;
 558         stats_y_oper_only=no;
 559         stats_o_oper_only=yes;
 560         stats_P_oper_only=no;
 561         stats_i_oper_only=masked;
 562         stats_k_oper_only=masked;
 563         map_oper_only = no;
 564         operspy_admin_only = no;
 565         operspy_dont_care_user_info = no;
 566         secret_channels_in_whois = no;
 567         caller_id_wait = 1 minute;
 568         pace_wait_simple = 1 second;
 569         pace_wait = 10 seconds;
 570         short_motd = no;
 571         ping_cookie = no;
 572         connect_timeout = 30 seconds;
 573         default_ident_timeout = 5;
 574         disable_auth = no;
 575         no_oper_flood = yes;
 576         true_no_oper_flood = no;
 577         max_targets = 4;
 578         client_flood = 20;
 579         use_whois_actually = no;
 580         oper_only_umodes = operwall, locops, servnotice;
 581         oper_umodes = locops, servnotice, operwall, wallop;
 582         oper_snomask = "+s";
 583         burst_away = yes;
 584         nick_delay = 0 seconds; # 15 minutes if you want to enable this
 585         reject_ban_time = 1 minute;
 586         reject_after_count = 3;
 587         reject_duration = 5 minutes;
 588         throttle_duration = 60;
 589         throttle_count = 4;
 590         expire_override_time = 5 minutes;
 591 };
 592
 593 modules {
 594         path = "modules";
 595         path = "modules/autoload";
 596 };