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