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