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_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         hub = yes;
  55
  56         /* On multi-homed hosts you may need the following. These define
  57          * the addresses we connect from to other servers. */
  58         /* for IPv4 */
  59         #vhost = "192.169.0.1";
  60         /* for IPv6 */
  61         #vhost6 = "3ffe:80e8:546::2";
  62
  63         /* ssl_private_key: our ssl private key */
  64         ssl_private_key = "etc/test.key";
  65
  66         /* ssl_cert: certificate for our ssl server */
  67         ssl_cert = "etc/test.cert";
  68
  69         /* ssl_dh_params: DH parameters, generate with openssl dhparam -out dh.pem 1024 */
  70         ssl_dh_params = "etc/dh.pem";
  71
  72         /* ssld_count: number of ssld processes you want to start, if you
  73          * have a really busy server, using N-1 where N is the number of
  74          * cpu/cpu cores you have might be useful. A number greater than one
  75          * can also be useful in case of bugs in ssld and because ssld needs
  76          * two file descriptors per SSL connection.
  77          */
  78         ssld_count = 1;
  79
  80         /* default max clients: the default maximum number of clients
  81          * allowed to connect.  This can be changed once ircd has started by
  82          * issuing:
  83          *   /quote set maxclients <limit>
  84          */
  85         default_max_clients = 1024;
  86 };
  87
  88 admin {
  89         name = "Lazy admin (lazya)";
  90         description = "AthemeNET 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 = 9999;
 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         /* autojoin: Channel (or channels, comma-seperated) to join users
 177          * in this auth block to on connect. Note that this won't join
 178          * the user through any bans or otherwise restrictive chmodes.
 179          */
 180         autojoin = "#shadowircd,#test";
 181
 182         /* autojoin_opers : Channel (or channels, comma-seperated) to join
 183          * opers to on oper-up.
 184          */
 185         autojoin_opers = "#opers,#help";
 186
 187         /* Possible flags in auth:
 188          *
 189          * encrypted                  | password is encrypted with mkpasswd
 190          * spoof_notice               | give a notice when spoofing hosts
 191          * exceed_limit (old > flag)  | allow user to exceed class user limits
 192          * kline_exempt (old ^ flag)  | exempt this user from k/g/xlines&dnsbls
 193          * dnsbl_exempt               | exempt this user from dnsbls
 194          * spambot_exempt             | exempt this user from spambot checks
 195          * shide_exempt               | exempt this user from serverhiding
 196          * jupe_exempt                | exempt this user from generating
 197          *                              warnings joining juped channels
 198          * resv_exempt                | exempt this user from resvs
 199          * flood_exempt               | exempt this user from flood limits
 200          *                                     USE WITH CAUTION.
 201          * no_tilde     (old - flag)  | don't prefix ~ to username if no ident
 202          * need_ident   (old + flag)  | require ident for user in this class
 203          * need_ssl                   | require SSL/TLS for user in this class
 204          * need_sasl                  | require SASL id for user in this class
 205          */
 206         flags = kline_exempt, exceed_limit;
 207
 208         /* class: the class the user is placed in */
 209         class = "opers";
 210 };
 211
 212 /* Example WEBIRC authblock */
 213 auth {
 214         /* user: webirc@IP.OF.YOUR.WEBIRC . the webirc@ part is required */
 215         user = "webirc@192.168.1.1";
 216
 217         /* password: password the webirc client sends in the WEBIRC command.
 218          * You can use a encrypted password here (see above auth block).
 219          */
 220         password = "<password>";
 221
 222         /* spoof: This is required to keep it what it is currently if you
 223          * want the webirc client to show the users' real host as their
 224          * host on IRC.
 225          */
 226         spoof = "webirc.";
 227         class = "users";
 228 };
 229
 230 auth {
 231         user = "*@*";
 232         class = "users";
 233 };
 234
 235 /* privset {} blocks MUST be specified before anything that uses them.  That
 236  * means they must be defined before operator {}.
 237  */
 238 privset "local_op" {
 239         privs = oper:local_kill, oper:operwall;
 240 };
 241
 242 privset "server_bot" {
 243         extends = "local_op";
 244         privs = oper:kline, oper:remoteban, snomask:nick_changes;
 245 };
 246
 247 privset "global_op" {
 248         extends = "local_op";
 249         privs = oper:global_kill, oper:routing, oper:kline, oper:unkline, oper:xline,
 250                 oper:resv, oper:mass_notice, oper:remoteban;
 251 };
 252
 253 privset "admin" {
 254         extends = "global_op";
 255         privs = oper:admin, oper:die, oper:rehash, oper:spy, oper:override;
 256 };
 257
 258 operator "god" {
 259         /* name: the name of the oper must go above */
 260
 261         /* user: the user@host required for this operator.  CIDR *is*
 262          * supported now. auth{} spoofs work here, other spoofs do not.
 263          * multiple user="" lines are supported.
 264          */
 265         user = "*god@127.0.0.1";
 266
 267         /* password: the password required to oper.  Unless ~encrypted is
 268          * contained in flags = ...; this will need to be encrypted using
 269          * mkpasswd, MD5 is supported
 270          */
 271         password = "etcnjl8juSU1E";
 272
 273         /* rsa key: the public key for this oper when using Challenge.
 274          * A password should not be defined when this is used, see
 275          * doc/challenge.txt for more information.
 276          */
 277         #rsa_public_key_file = "/usr/local/ircd/etc/oper.pub";
 278
 279         /* umodes: the specific umodes this oper gets when they oper.
 280          * If this is specified an oper will not be given oper_umodes
 281          * These are described above oper_only_umodes in general {};
 282          */
 283         #umodes = locops, servnotice, operwall, wallop;
 284
 285         /* fingerprint: if specified, the oper's client certificate
 286          * fingerprint will be checked against the specified fingerprint
 287          * below.
 288          */
 289         #fingerprint = "c77106576abf7f9f90cca0f63874a60f2e40a64b";
 290
 291         /* snomask: specific server notice mask on oper up.
 292          * If this is specified an oper will not be given oper_snomask.
 293          */
 294         snomask = "+Zbfkrsuy";
 295
 296         /* vhost: defines the vhost that this oper will get on oper up.
 297          * this must be a valid hostmask. If this is specified the oper
 298          * will not be given default_operhost.
 299          */
 300         vhost = "is.an.oper";
 301
 302         /* swhois: defines an additional line that will be displayed
 303          * whenever someone does /whois on the oper in question.
 304          */
 305         swhois = "is wearing pants.";
 306
 307         /* operstring: defines a custom operstring for this oper,
 308          * which will be shown in whois instead of default_operstring
 309          * or default_adminstring.
 310          */
 311         operstring = "is a lazy IRC Operator";
 312
 313         /* flags: misc options for the operator.  You may prefix an option
 314          * with ~ to disable it, e.g. ~encrypted.
 315          *
 316          * Default flags are encrypted.
 317          *
 318          * Available options:
 319          *
 320          * encrypted:    the password above is encrypted [DEFAULT]
 321          * need_ssl:     must be using SSL/TLS to oper up
 322          */
 323         flags = encrypted;
 324
 325         /* privset: privileges set to grant */
 326         privset = "admin";
 327 };
 328
 329 connect "irc.uplink.com" {
 330         host = "192.168.0.1";
 331         send_password = "password";
 332         accept_password = "anotherpassword";
 333         port = 6666;
 334         hub_mask = "*";
 335         class = "server";
 336         flags = compressed, topicburst;
 337
 338         /* If the connection is IPv6, uncomment below.
 339          * Use 0::1, not ::1, for IPv6 localhost. */
 340         #aftype = ipv6;
 341 };
 342
 343 connect "ssl.uplink.com" {
 344         host = "192.168.0.1";
 345         send_password = "password";
 346         accept_password = "anotherpassword";
 347         port = 9999;
 348         hub_mask = "*";
 349         class = "server";
 350         flags = ssl, topicburst;
 351 };
 352
 353 service {
 354         name = "services.int";
 355 };
 356
 357 cluster {
 358         name = "*";
 359         flags = kline, tkline, unkline, xline, txline, unxline, resv, tresv, unresv;
 360 };
 361
 362 shared {
 363         oper = "*@*", "*";
 364         flags = all, rehash;
 365 };
 366
 367 /* exempt {}: IPs that are exempt from Dlines and rejectcache. (OLD d:) */
 368 exempt {
 369         ip = "127.0.0.1";
 370 };
 371
 372 channel {
 373         autochanmodes = "nt";
 374         exemptchanops = "NT";
 375         use_halfop = yes;
 376         use_admin = yes;
 377         use_invex = yes;
 378         use_except = yes;
 379         use_knock = yes;
 380         use_forward = yes;
 381         use_local_channels = yes;
 382         knock_delay = 5 minutes;
 383         knock_delay_channel = 1 minute;
 384         max_chans_per_user = 15;
 385         max_bans = 100;
 386         max_bans_large = 500;
 387         default_split_user_count = 0;
 388         default_split_server_count = 0;
 389         no_create_on_split = no;
 390         no_join_on_split = no;
 391         burst_topicwho = yes;
 392         kick_on_split_riding = no;
 393         only_ascii_channels = no;
 394         cycle_host_change = yes;
 395         host_in_topic = yes;
 396         resv_forcepart = yes;
 397         kick_no_rejoin_time = 30 seconds;
 398 };
 399
 400 serverhide {
 401         flatten_links = yes;
 402         links_delay = 5 minutes;
 403         hidden = no;
 404         disable_hidden = no;
 405 };
 406
 407 /* These are the blacklist settings.
 408  * You can have multiple combinations of host and rejection reasons.
 409  * They are used in pairs of one host/rejection reason.
 410  *
 411  * These settings should be adequate for most networks, and are (presently)
 412  * required for use on AthemeNet.
 413  *
 414  * Word to the wise: Do not use blacklists like SPEWS for blocking IRC
 415  * connections.
 416  *
 417  * As of charybdis 2.1.3, you can do some keyword substitution on the rejection
 418  * reason. The available keyword substitutions are:
 419  *
 420  *   ${ip}           - the user's IP
 421  *   ${host}         - the user's canonical hostname
 422  *   ${dnsbl-host}   - the dnsbl hostname the lookup was done against
 423  *   ${nick}         - the user's nickname
 424  *   ${network-name} - the name of the network
 425  *
 426  * Note: AHBL (the providers of the below *.ahbl.org BLs) request that they be
 427  * contacted, via email, at admins@2mbit.com before using these BLs.
 428  * See <http://www.ahbl.org/services.php> for more information.
 429  */
 430 blacklist {
 431         host = "dnsbl.dronebl.org";
 432         reject_reason = "${nick}, your IP (${ip}) is listed in DroneBL. For assistance, see http://dronebl.org/lookup_branded.do?ip=${ip}&network=${network-name}";
 433
 434 #       host = "ircbl.ahbl.org";
 435 #       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.";
 436 #
 437 #       host = "tor.ahbl.org";
 438 #       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.";
 439 };
 440
 441 alias "NickServ" {
 442         target = "NickServ";
 443 };
 444
 445 alias "ChanServ" {
 446         target = "ChanServ";
 447 };
 448
 449 alias "OperServ" {
 450         target = "OperServ";
 451 };
 452
 453 alias "MemoServ" {
 454         target = "MemoServ";
 455 };
 456
 457 alias "HostServ" {
 458         target = "HostServ";
 459 };
 460
 461 alias "BotServ" {
 462         target = "BotServ";
 463 };
 464
 465 alias "NS" {
 466         target = "NickServ";
 467 };
 468
 469 alias "CS" {
 470         target = "ChanServ";
 471 };
 472
 473 alias "OS" {
 474         target = "OperServ";
 475 };
 476
 477 alias "MS" {
 478         target = "MemoServ";
 479 };
 480
 481 alias "HS" {
 482         target = "HostServ";
 483 };
 484
 485 alias "BS" {
 486         target = "BotServ";
 487 };
 488
 489 general {
 490         hide_error_messages = opers;
 491         hide_spoof_ips = yes;
 492
 493         /*
 494          * default umodes: umodes to set upon connection
 495          * If you have enabled the ip_cloaking extension, and you wish for
 496          * incoming clients to be cloaked upon connection, +x must be in
 497          * the umode string below.
 498          */
 499         default_umodes = "+ix";
 500
 501         default_operstring = "is an IRC Operator";
 502         default_adminstring = "is a Server Administrator";
 503         default_operhost = "staff.testnet.net";
 504         #static_quit = "I like turtles!";
 505         servicestring = "is a Network Service";
 506         disable_fake_channels = no;
 507         tkline_expire_notices = no;
 508         default_floodcount = 10;
 509         failed_oper_notice = yes;
 510         dots_in_ident=2;
 511         min_nonwildcard = 4;
 512         min_nonwildcard_simple = 3;
 513         max_accept = 100;
 514         max_monitor = 100;
 515         anti_nick_flood = yes;
 516         max_nick_time = 20 seconds;
 517         max_nick_changes = 5;
 518         anti_spam_exit_message_time = 5 minutes;
 519         use_part_messages = yes;
 520         ts_warn_delta = 30 seconds;
 521         ts_max_delta = 5 minutes;
 522         client_exit = yes;
 523         collision_fnc = yes;
 524         global_snotices = yes;
 525         dline_with_reason = yes;
 526         kline_delay = 0 seconds;
 527         kline_with_reason = yes;
 528         kline_reason = "K-Lined";
 529         identify_service = "NickServ@services.int";
 530         identify_command = "IDENTIFY";
 531         non_redundant_klines = yes;
 532         warn_no_nline = yes;
 533         stats_e_disabled = no;
 534         stats_c_oper_only=no;
 535         stats_h_oper_only=no;
 536         stats_y_oper_only=no;
 537         stats_o_oper_only=yes;
 538         stats_P_oper_only=no;
 539         stats_i_oper_only=masked;
 540         stats_k_oper_only=masked;
 541         map_oper_only = no;
 542         operspy_admin_only = no;
 543         operspy_dont_care_user_info = no;
 544         secret_channels_in_whois = no;
 545         caller_id_wait = 1 minute;
 546         pace_wait_simple = 1 second;
 547         pace_wait = 10 seconds;
 548         short_motd = no;
 549         ping_cookie = no;
 550         connect_timeout = 30 seconds;
 551         disable_auth = no;
 552         no_oper_flood = yes;
 553         max_targets = 4;
 554         client_flood = 20;
 555         use_whois_actually = no;
 556         oper_only_umodes = operwall, locops, servnotice;
 557         oper_umodes = locops, servnotice, operwall, wallop;
 558         oper_snomask = "+s";
 559         burst_away = yes;
 560         nick_delay = 0 seconds; # 15 minutes if you want to enable this
 561         reject_ban_time = 1 minute;
 562         reject_after_count = 3;
 563         reject_duration = 5 minutes;
 564         throttle_duration = 60;
 565         throttle_count = 4;
 566         expire_override_time = 5 minutes;
 567 };
 568
 569 modules {
 570         path = "modules";
 571         path = "modules/autoload";
 572 };