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