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