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