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