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