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