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_ipv4_bitlen = 24;
  99         cidr_ipv6_bitlen = 64;
 100         number_per_cidr = 200;
 101         max_number = 3000;
 102         sendq = 400 kbytes;
 103 };
 104
 105 class "opers" {
 106         ping_time = 5 minutes;
 107         number_per_ip = 10;
 108         max_number = 1000;
 109         sendq = 1 megabyte;
 110 };
 111
 112 class "server" {
 113         ping_time = 5 minutes;
 114         connectfreq = 5 minutes;
 115         max_number = 1;
 116         sendq = 4 megabytes;
 117 };
 118
 119 listen {
 120         /* If you want to listen on a specific IP only, specify host.
 121          * host definitions apply only to the following port line.
 122          */
 123         #host = "192.169.0.1";
 124         port = 5000, 6665 .. 6669;
 125         sslport = 9999;
 126
 127         /* Listen on IPv6 (if you used host= above). */
 128         #host = "3ffe:1234:a:b:c::d";
 129         #port = 5000, 6665 .. 6669;
 130         #sslport = 9999;
 131 };
 132
 133 /* auth {}: allow users to connect to the ircd (OLD I:)
 134  * auth {} blocks MUST be specified in order of precedence.  The first one
 135  * that matches a user will be used.  So place spoofs first, then specials,
 136  * then general access, then restricted.
 137  */
 138 auth {
 139         /* user: the user@host allowed to connect.  Multiple IPv4/IPv6 user
 140          * lines are permitted per auth block.  This is matched against the
 141          * hostname and IP address (using :: shortening for IPv6 and
 142          * prepending a 0 if it starts with a colon) and can also use CIDR
 143          * masks.
 144          */
 145         user = "*@172.16.0.0/12";
 146         user = "*test@123D:B567:*";
 147
 148         /* password: an optional password that is required to use this block.
 149          * By default this is not encrypted, specify the flag "encrypted" in
 150          * flags = ...; below if it is.
 151          */
 152         password = "letmein";
 153
 154         /* spoof: fake the users user@host to be be this.  You may either
 155          * specify a host or a user@host to spoof to.  This is free-form,
 156          * just do everyone a favour and dont abuse it. (OLD I: = flag)
 157          */
 158         spoof = "I.still.hate.packets";
 159
 160         /* Possible flags in auth:
 161          *
 162          * encrypted                  | password is encrypted with mkpasswd
 163          * spoof_notice               | give a notice when spoofing hosts
 164          * exceed_limit (old > flag)  | allow user to exceed class user limits
 165          * kline_exempt (old ^ flag)  | exempt this user from k/g/xlines&dnsbls
 166          * dnsbl_exempt               | exempt this user from dnsbls
 167          * spambot_exempt             | exempt this user from spambot checks
 168          * shide_exempt               | exempt this user from serverhiding
 169          * jupe_exempt                | exempt this user from generating
 170          *                              warnings joining juped channels
 171          * resv_exempt                | exempt this user from resvs
 172          * flood_exempt               | exempt this user from flood limits
 173          *                                     USE WITH CAUTION.
 174          * no_tilde     (old - flag)  | don't prefix ~ to username if no ident
 175          * need_ident   (old + flag)  | require ident for user in this class
 176          * need_ssl                   | require SSL/TLS for user in this class
 177          * need_sasl                  | require SASL id for user in this class
 178          */
 179         flags = kline_exempt, exceed_limit;
 180
 181         /* class: the class the user is placed in */
 182         class = "opers";
 183 };
 184
 185 auth {
 186         user = "*@*";
 187         class = "users";
 188 };
 189
 190 /* privset {} blocks MUST be specified before anything that uses them.  That
 191  * means they must be defined before operator {}.
 192  */
 193 privset "local_op" {
 194         privs = oper:local_kill, oper:operwall;
 195 };
 196
 197 privset "server_bot" {
 198         extends = "local_op";
 199         privs = oper:kline, oper:remoteban, snomask:nick_changes;
 200 };
 201
 202 privset "global_op" {
 203         extends = "local_op";
 204         privs = oper:global_kill, oper:routing, oper:kline, oper:unkline, oper:xline,
 205                 oper:resv, oper:mass_notice, oper:remoteban;
 206 };
 207
 208 privset "admin" {
 209         extends = "global_op";
 210         privs = oper:admin, oper:die, oper:rehash, oper:spy;
 211 };
 212
 213 operator "god" {
 214         /* name: the name of the oper must go above */
 215
 216         /* user: the user@host required for this operator.  CIDR *is*
 217          * supported now. auth{} spoofs work here, other spoofs do not.
 218          * multiple user="" lines are supported.
 219          */
 220         user = "*god@127.0.0.1";
 221
 222         /* password: the password required to oper.  Unless ~encrypted is
 223          * contained in flags = ...; this will need to be encrypted using
 224          * mkpasswd, MD5 is supported
 225          */
 226         password = "etcnjl8juSU1E";
 227
 228         /* rsa key: the public key for this oper when using Challenge.
 229          * A password should not be defined when this is used, see
 230          * doc/challenge.txt for more information.
 231          */
 232         #rsa_public_key_file = "/usr/local/ircd/etc/oper.pub";
 233
 234         /* umodes: the specific umodes this oper gets when they oper.
 235          * If this is specified an oper will not be given oper_umodes
 236          * These are described above oper_only_umodes in general {};
 237          */
 238         #umodes = locops, servnotice, operwall, wallop;
 239
 240         /* snomask: specific server notice mask on oper up.
 241          * If this is specified an oper will not be given oper_snomask.
 242          */
 243         snomask = "+Zbfkrsuy";
 244
 245         /* flags: misc options for the operator.  You may prefix an option
 246          * with ~ to disable it, e.g. ~encrypted.
 247          *
 248          * Default flags are encrypted.
 249          *
 250          * Available options:
 251          *
 252          * encrypted:    the password above is encrypted [DEFAULT]
 253          * need_ssl:     must be using SSL/TLS to oper up
 254          */
 255         flags = encrypted;
 256
 257         /* privset: privileges set to grant */
 258         privset = "admin";
 259 };
 260
 261 connect "irc.uplink.com" {
 262         host = "192.168.0.1";
 263         send_password = "password";
 264         accept_password = "anotherpassword";
 265         port = 6666;
 266         hub_mask = "*";
 267         class = "server";
 268         flags = compressed, topicburst;
 269
 270         /* If the connection is IPv6, uncomment below.
 271          * Use 0::1, not ::1, for IPv6 localhost. */
 272         #aftype = ipv6;
 273 };
 274
 275 connect "ssl.uplink.com" {
 276         host = "192.168.0.1";
 277         send_password = "password";
 278         accept_password = "anotherpassword";
 279         port = 9999;
 280         hub_mask = "*";
 281         class = "server";
 282         flags = ssl, topicburst;
 283 };
 284
 285 service {
 286         name = "services.int";
 287 };
 288
 289 cluster {
 290         name = "*";
 291         flags = kline, tkline, unkline, xline, txline, unxline, resv, tresv, unresv;
 292 };
 293
 294 shared {
 295         oper = "*@*", "*";
 296         flags = all, rehash;
 297 };
 298
 299 /* exempt {}: IPs that are exempt from Dlines and rejectcache. (OLD d:) */
 300 exempt {
 301         ip = "127.0.0.1";
 302 };
 303
 304 channel {
 305         use_invex = yes;
 306         use_except = yes;
 307         use_knock = yes;
 308         use_forward = yes;
 309         knock_delay = 5 minutes;
 310         knock_delay_channel = 1 minute;
 311         max_chans_per_user = 15;
 312         max_bans = 100;
 313         max_bans_large = 500;
 314         default_split_user_count = 0;
 315         default_split_server_count = 0;
 316         no_create_on_split = no;
 317         no_join_on_split = no;
 318         burst_topicwho = yes;
 319         kick_on_split_riding = no;
 320 };
 321
 322 serverhide {
 323         flatten_links = yes;
 324         links_delay = 5 minutes;
 325         hidden = no;
 326         disable_hidden = no;
 327 };
 328
 329 /* These are the blacklist settings.
 330  * You can have multiple combinations of host and rejection reasons.
 331  * They are used in pairs of one host/rejection reason, or multiple hosts/rejection reason.
 332  *
 333  * These settings should be adequate for most networks, and are (presently)
 334  * required for use on AthemeNet.
 335  *
 336  * Word to the wise: Do not use blacklists like SPEWS for blocking IRC
 337  * connections.
 338  *
 339  * As of charybdis 2.1.3, you can do some keyword substitution on the rejection
 340  * reason. The available keyword substitutions are:
 341  *
 342  *   ${ip}           - the user's IP
 343  *   ${host}         - the user's canonical hostname
 344  *   ${dnsbl-host}   - the dnsbl hostname the lookup was done against
 345  *   ${nick}         - the user's nickname
 346  *   ${network-name} - the name of the network
 347  *
 348  * Note: AHBL (the providers of the below *.ahbl.org BLs) request that they be
 349  * contacted, via email, at admins@2mbit.com before using these BLs.
 350  * See <http://www.ahbl.org/services.php> for more information.
 351  */
 352 blacklist {
 353         host = "dnsbl.dronebl.org";
 354         reject_reason = "${nick}, your IP (${ip}) is listed in DroneBL. For assistance, see http://dronebl.org/lookup_branded.do?ip=${ip}&network=${network-name}";
 355
 356 #       host = "ircbl.ahbl.org";
 357 #       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.";
 358 #
 359 #       host = "tor.ahbl.org";
 360 #       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.";
 361 };
 362
 363 alias "NickServ" {
 364         target = "NickServ";
 365 };
 366
 367 alias "ChanServ" {
 368         target = "ChanServ";
 369 };
 370
 371 alias "OperServ" {
 372         target = "OperServ";
 373 };
 374
 375 alias "MemoServ" {
 376         target = "MemoServ";
 377 };
 378
 379 alias "NS" {
 380         target = "NickServ";
 381 };
 382
 383 alias "CS" {
 384         target = "ChanServ";
 385 };
 386
 387 alias "OS" {
 388         target = "OperServ";
 389 };
 390
 391 alias "MS" {
 392         target = "MemoServ";
 393 };
 394
 395 general {
 396         hide_error_messages = opers;
 397         hide_spoof_ips = yes;
 398
 399         /*
 400          * default_umodes: umodes to enable on connect.
 401          * If you have enabled the ip_cloaking module, and you want
 402          * to make use of it, add +h to this option, i.e.:
 403          *      default_umodes = "+ih";
 404          */
 405         default_umodes = "+i";
 406
 407         default_operstring = "is an IRC Operator";
 408         default_adminstring = "is a Server Administrator";
 409         servicestring = "is a Network Service";
 410         disable_fake_channels = no;
 411         tkline_expire_notices = no;
 412         default_floodcount = 10;
 413         failed_oper_notice = yes;
 414         dots_in_ident=2;
 415         min_nonwildcard = 4;
 416         min_nonwildcard_simple = 3;
 417         max_accept = 100;
 418         max_monitor = 100;
 419         anti_nick_flood = yes;
 420         max_nick_time = 20 seconds;
 421         max_nick_changes = 5;
 422         anti_spam_exit_message_time = 5 minutes;
 423         ts_warn_delta = 30 seconds;
 424         ts_max_delta = 5 minutes;
 425         client_exit = yes;
 426         collision_fnc = yes;
 427         global_snotices = yes;
 428         dline_with_reason = yes;
 429         kline_delay = 0 seconds;
 430         kline_with_reason = yes;
 431         kline_reason = "K-Lined";
 432         identify_service = "NickServ@services.int";
 433         identify_command = "IDENTIFY";
 434         non_redundant_klines = yes;
 435         warn_no_nline = yes;
 436         stats_e_disabled = no;
 437         stats_c_oper_only=no;
 438         stats_h_oper_only=no;
 439         stats_y_oper_only=no;
 440         stats_o_oper_only=yes;
 441         stats_P_oper_only=no;
 442         stats_i_oper_only=masked;
 443         stats_k_oper_only=masked;
 444         map_oper_only = no;
 445         operspy_admin_only = no;
 446         operspy_dont_care_user_info = no;
 447         caller_id_wait = 1 minute;
 448         pace_wait_simple = 1 second;
 449         pace_wait = 10 seconds;
 450         short_motd = no;
 451         ping_cookie = no;
 452         connect_timeout = 30 seconds;
 453         disable_auth = no;
 454         no_oper_flood = yes;
 455         max_targets = 4;
 456         client_flood = 20;
 457         use_whois_actually = no;
 458         oper_only_umodes = operwall, locops, servnotice;
 459         oper_umodes = locops, servnotice, operwall, wallop;
 460         oper_snomask = "+s";
 461         burst_away = yes;
 462         nick_delay = 0 seconds; # 15 minutes if you want to enable this
 463         reject_ban_time = 1 minute;
 464         reject_after_count = 3;
 465         reject_duration = 5 minutes;
 466         throttle_duration = 60;
 467         throttle_count = 4;
 468 };
 469
 470 modules {
 471         path = "modules";
 472         path = "modules/autoload";
 473 };