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