conf/inspircd.conf.example

   1 ########################################################################
   2 #                                                                      #
   3 #               ___                ___ ____   ____    _                #
   4 #              |_ _|_ __  ___ _ __|_ _|  _ \ / ___|__| |               #
   5 #               | || '_ \/ __| '_ \| || |_) | |   / _` |               #
   6 #               | || | | \__ \ |_) | ||  _ <| |__| (_| |               #
   7 #              |___|_| |_|___/ .__/___|_| \_\\____\__,_|               #
   8 #                            |_|                                       #
   9 #      ____             __ _                       _   _               #
  10 #     / ___|___  _ __  / _(_) __ _ _   _ _ __ __ _| |_(_) ___  _ __    #
  11 #    | |   / _ \| '_ \| |_| |/ _` | | | | '__/ _` | __| |/ _ \| '_ \   #
  12 #    | |__| (_) | | | |  _| | (_| | |_| | | | (_| | |_| | (_) | | | |  #
  13 #     \____\___/|_| |_|_| |_|\__, |\__,_|_|  \__,_|\__|_|\___/|_| |_|  #
  14 #                            |___/                                     #
  15 #                                                                      #
  16 ##################################||####################################
  17                                  #||#
  18 ##################################||####################################
  19 #                                                                      #
  20 #         This is an example of the config file for InspIRCd.          #
  21 #             Change the options to suit your network                  #
  22 #                                                                      #
  23 #     $Id$
  24 #                                                                      #
  25 #    ____                _   _____ _     _       ____  _ _   _         #
  26 #   |  _ \ ___  __ _  __| | |_   _| |__ (_)___  | __ )(_) |_| |        #
  27 #   | |_) / _ \/ _` |/ _` |   | | | '_ \| / __| |  _ \| | __| |        #
  28 #   |  _ <  __/ (_| | (_| |   | | | | | | \__ \ | |_) | | |_|_|        #
  29 #   |_| \_\___|\__,_|\__,_|   |_| |_| |_|_|___/ |____/|_|\__(_)        #
  30 #                                                                      #
  31 #   Lines prefixed with READ THIS BIT, as shown above, are IMPORTANT   #
  32 #   lines, and you REALLY SHOULD READ THEM. Yes, THIS MEANS YOU. Even  #
  33 #   if you've configured InspIRCd before, these probably indicate      #
  34 #   something new or different to this version and you SHOULD READ IT. #
  35 #                                                                      #
  36 ########################################################################
  37 #                                                                      #
  38 #         Unalphabeticalise the modules list at your own risk          #
  39 #                                                                      #
  40 ########################################################################
  41
  42 #-#-#-#-#-#-#-#-#-#  INCLUDE CONFIGURATION  #-#-#-#-#-#-#-#-#-#-#-#-#-#
  43 #                                                                     #
  44 # This optional tag allows you to include another config file         #
  45 # allowing you to keep your configuration tidy. The configuration     #
  46 # file you include will be treated as part of the configuration file  #
  47 # which includes it, in simple terms the inclusion is transparent.    #
  48 #                                                                     #
  49 # All paths to config files are relative to the directory that the    #
  50 # process runs in.                                                    #
  51 #                                                                     #
  52 # You may also include an executable file, in which case if you do so #
  53 # the output of the executable on the standard output will be added   #
  54 # to your config at the point of the include tag.                     #
  55 #                                                                     #
  56 # Syntax is as follows:                                               #
  57 #<include file="file.conf">                                           #
  58 #<include executable="/path/to/executable parameters">                #
  59 #                                                                     #
  60 # Executable Include Example:                                         #
  61 #<include executable="/usr/bin/wget -q -O - http://mynet.net/inspircd.conf">
  62 #                                                                     #
  63
  64
  65 #-#-#-#-#-#-#-#-#-#-#-#  VARIABLE DEFINITIONS  -#-#-#-#-#-#-#-#-#-#-#-#
  66 #                                                                     #
  67 # You can define variables that will be substituted later in the      #
  68 # configuration file. This can be useful to allow settings to be      #
  69 # easily changed, or to parameterize a remote includes.               #
  70 #                                                                     #
  71 # Variables may be redefined and may reference other variables.       #
  72 # Value expansion happens at the time the tag is read.                #
  73 #                                                                     #
  74 # Using variable definitions REQUIRES that the config format be       #
  75 # changed to "xml" from the default "compat" that uses escape         #
  76 # sequences such as "\"" and "\n", and does not support <define>      #
  77 <config format="xml">
  78 <define name="bindip" value="1.2.2.3">
  79 <define name="localips" value="&bindip;/24">
  80
  81 #-#-#-#-#-#-#-#-#-#-#-#-  SERVER DESCRIPTION  -#-#-#-#-#-#-#-#-#-#-#-#-
  82 #                                                                     #
  83 #   Here is where you enter the information about your server.        #
  84 #                                                                     #
  85
  86 <server
  87         # name: Hostname of your server. Does not need to resolve, but
  88         # does need to be correct syntax (something.somethingelse.tld).
  89         name="penguin.omega.org.za"
  90
  91         # description: Server description. Spaces are allowed.
  92         description="Waddle World"
  93
  94         # id: The SID to use for this server. This should not be uncommented
  95         # unless there is a SID conflict. This must be three characters long.
  96         # The first character must be a digit [0-9], the remaining two chars
  97         # may be letters [A-Z] or digits.
  98         #id="97K"
  99
 100         # network: Network name given on connect to clients.
 101         # Should be the same on all servers on the network and
 102         # not contain spaces.
 103         network="Omega">
 104
 105
 106 #-#-#-#-#-#-#-#-#-#-#-#-   ADMIN INFORMATION   -#-#-#-#-#-#-#-#-#-#-#-#
 107 #                                                                     #
 108 #   Describes the Server Administrator's real name (optionally),      #
 109 #   nick, and email address.                                          #
 110 #                                                                     #
 111
 112 <admin
 113        # name: Real Name
 114        name="Johnny English"
 115
 116        # nick: Nickname (preferably what you use on the network)
 117        nick="MI5"
 118
 119        # email: email address. Does not have to be valid
 120        # but should be for the users to be able to contact you.
 121        email="MI5@the.best.secret.agent">
 122
 123
 124 #-#-#-#-#-#-#-#-#-#-#-#-   PORT CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-
 125 #                                                                     #
 126 #   Enter the port and address bindings here.                         #
 127 #                                                                     #
 128 #                                                                     #
 129 #    ____                _   _____ _     _       ____  _ _   _        #
 130 #   |  _ \ ___  __ _  __| | |_   _| |__ (_)___  | __ )(_) |_| |       #
 131 #   | |_) / _ \/ _` |/ _` |   | | | '_ \| / __| |  _ \| | __| |       #
 132 #   |  _ <  __/ (_| | (_| |   | | | | | | \__ \ | |_) | | |_|_|       #
 133 #   |_| \_\___|\__,_|\__,_|   |_| |_| |_|_|___/ |____/|_|\__(_)       #
 134 #                                                                     #
 135 #  If you want to link servers to InspIRCd you must load the          #
 136 #  m_spanningtree.so module! Please see the modules list below for    #
 137 #  information on how to load this module! If you do not load this    #
 138 #  module, server ports will NOT be bound!                            #
 139 #                                                                     #
 140 # PLEASE NOTE: If you have build InspIRCd with IPv6 support, you MUST #
 141 # specify a bind address if you want the IRCd to bind to a IPv4 IP.   #
 142
 143 <bind
 144       # address: IP address to bind to if the box that you are hosting
 145       # on has more than one IP, else the ircd will try to bind to all
 146       # IP's on the box if this is not defined.
 147       address=""
 148
 149       # port: Port for users or servers to be able to connect to.
 150       # you can select multiple ports by separating them
 151       # with a - character like the example below.
 152       port="6697"
 153
 154       # type: Type of bind block this is. It can either be clients or
 155       # servers. Whichever you select will be the only type able to connect
 156       # to this bind section.
 157       type="clients"
 158
 159       # ssl: If you want this bind section to use SSL, define either
 160       # gnutls or openssl here. The appropriate SSL modules must be loaded
 161       # for ssl to work. If you do not want this bind section to support ssl,
 162       # just remove or comment out this option.
 163       ssl="gnutls"
 164       >
 165
 166 <bind address="" port="6660-6669" type="clients">
 167
 168 # When linking servers, the openssl and gnutls transports are completely
 169 # link-compatible and can be used alongside each other
 170 # on each end of the link without any significant issues.
 171 # Transports can only be used on server blocks.
 172 # Supported Transports are: "ziplinks", "openssl" and "gnutls".
 173 # You must load m_ziplinks module for zip, m_ssl_openssl for openssl
 174 # or m_ssl_gnutls for gnutls.
 175
 176 <bind address="" port="7000,7001" type="servers">
 177 <bind address="1.2.3.4" port="7005" type="servers" ssl="openssl">
 178
 179
 180 #-#-#-#-#-#-#-#-#-#-  DIE/RESTART CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-
 181 #                                                                     #
 182 #   You can configure the passwords here which you wish to use for    #
 183 #   the die and restart commands. Only trusted IRCop's who will       #
 184 #   need this ability should know the die and restart password.       #
 185 #                                                                     #
 186
 187 <power
 188        # hash: what hash these passwords are hashed with. requires the module
 189        # for selected hash (m_md5.so, m_sha256.so or m_ripemd160.so) be
 190        # loaded and the password hashing module (m_password_hash.so)
 191        # loaded. Options here are: "md5", "sha256" and "ripemd160".
 192        # Optional, but recommended. Create hashed password with:
 193        # /mkpasswd <hash> <password>
 194        #hash="sha256"
 195
 196        # diepass: Password for opers to use if they need to shutdown (die)
 197        # a server.
 198        diepass=""
 199
 200        # restartpass: Password for opers to use if they need to restart
 201        # a server.
 202        restartpass="">
 203
 204
 205 #-#-#-#-#-#-#-#-#-#-  CONNECTIONS CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#
 206 #                                                                     #
 207 #   This is where you can configure which connections are allowed     #
 208 #   and denied access onto your server. The password is optional.     #
 209 #   You may have as many of these as you require. To allow/deny all   #
 210 #   connections, use a '*' or 0.0.0.0/0.                              #
 211 #                                                                     #
 212 #  -- It is important to note that connect tags are read from the  -- #
 213 #     TOP DOWN. This means that you should have more specific deny    #
 214 #    and allow tags at the top, progressively more general, followed  #
 215 #        by a <connect allow="*" (should you wish to have one).       #
 216 #                                                                     #
 217 #                                                                     #
 218 <connect
 219          # deny: Will not let people connect if they have specified host/IP.
 220          deny="69.254.*">
 221
 222 <connect deny="3ffe::0/32">
 223
 224 <connect
 225          # name: Name to use for this connect block. Mainly used for
 226          # connect class inheriting.
 227          name="secret"
 228
 229          # parent: This setting is to specify if this connect class
 230          # inherits settings from any other. Put the other class's name
 231          # in here to use its settings as a template - for example,  if
 232          # you only want to adjust sendq and a password
 233          parent="main"
 234
 235          # allow: What IP addresses/hosts to allow for this block.
 236          allow="196.12.*"
 237
 238          # hash: what hash this password is hashed with. requires the module
 239          # for selected hash (m_md5.so, m_sha256.so or m_ripemd160.so) be
 240          # loaded and the password hashing module (m_password_hash.so)
 241          # loaded. Options here are: "md5", "sha256" and "ripemd160".
 242          # Optional, but recommended. Create hashed password with:
 243          # /mkpasswd <hash> <password>
 244          #hash="sha256"
 245
 246          # password: Password to use for this block/user(s)
 247          password="secret"
 248
 249          # maxchans: Maximum number of channels a user in this class
 250          # be in at one time. This overrides every other maxchans setting.
 251          #maxchans="30"
 252
 253          # timeout: How long (in seconds) the server will wait before
 254          # disconnecting a user if they do not do anything on connect.
 255          # (Note, this is a client-side thing, if the client does not
 256          # send /nick, /user or /pass)
 257          timeout="10"
 258
 259          # localmax: Maximum local connections per IP (or CIDR mask, see below).
 260          localmax="3"
 261
 262          # globalmax: Maximum global (network-wide) connections per IP (or CIDR mask, see below).
 263          globalmax="3"
 264
 265          # useident: Defines if users in this class MUST respond to a ident query or not.
 266          useident="no"
 267
 268          # limit: How many users are allowed in this class
 269          limit="5000"
 270
 271          # modes: Usermodes that are set on users in this block on connect.
 272          # Enabling this option requires that the m_conn_umodes module be loaded.
 273          # This entry is highly recommended to use for/with IP Cloaking/masking.
 274          # For the example to work, this also requires that the m_cloaking
 275          # module be loaded as well.
 276          modes="+x"
 277
 278          # port: What port this user is allowed to connect on. (optional)
 279          # The port MUST be set to listen in the bind blocks above.
 280          port="6667">
 281
 282 <connect
 283          # name: Name to use for this connect block. Mainly used for
 284          # connect class inheriting.
 285          name="main"
 286
 287          # allow: What IP addresses/hosts to allow for this block.
 288          allow="*"
 289
 290          # maxchans: Maximum number of channels a user in this class
 291          # be in at one time. This overrides every other maxchans setting.
 292          #maxchans="30"
 293
 294          # timeout: How long (in seconds) the server will wait before
 295          # disconnecting a user if they do not do anything on connect.
 296          # (Note, this is a client-side thing, if the client does not
 297          # send /nick, /user or /pass)
 298          timeout="10"
 299
 300          # pingfreq: How often (in seconds) the server tries to ping connecting clients.
 301          pingfreq="120"
 302
 303          # hardsendq: maximum amount of data allowed in a client's send queue
 304          # before they are dropped. Keep this value higher than the length of
 305          # your network's /LIST or /WHO output, or you will have lots of
 306          # disconnects from sendq overruns!
 307          hardsendq="1048576"
 308
 309          # softsendq: amount of data in a client's send queue before the server
 310          # begins delaying their commands
 311          softsendq="8192"
 312
 313          # recvq: amount of data allowed in a client's queue before they are dropped.
 314          recvq="8192"
 315
 316          # threshold: This specifies the seconds worth of penalty a user is allowed to have
 317          # before fake lag is applied to them.  If this value is set too low, every action will cause throttling.
 318          # Set to 0 to disable.
 319          threshold="10"
 320
 321          # localmax: Maximum local connections per IP.
 322          localmax="3"
 323
 324          # globalmax: Maximum global (network-wide) connections per IP.
 325          globalmax="3"
 326
 327          # useident: Defines if users in this class must respond to a ident query or not.
 328          useident="no"
 329
 330          # limit: How many users are allowed in this class
 331          limit="5000"
 332
 333          # modes: Usermodes that are set on users in this block on connect.
 334          # Enabling this option requires that the m_conn_umodes module be loaded.
 335          # This entry is highly recommended to use for/with IP Cloaking/masking.
 336          # For the example to work, this also requires that the m_cloaking
 337          # module be loaded as well.
 338          modes="+x">
 339
 340
 341 #-#-#-#-#-#-#-#-#-#-#-#-  CIDR CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-
 342 #                                                                     #
 343 # CIDR configuration allows detection of clones and applying of       #
 344 # throttle limits across a CIDR range. (A CIDR range is a group of    #
 345 # IPs, for example, the CIDR range 192.168.1.0-192.168.1.255 may be   #
 346 # represented as 192.168.1.0/24). This means that abuse across an ISP #
 347 # is detected and curtailed much easier. Here is a good chart that    #
 348 # shows how many IPs the different CIDRs correspond to:               #
 349 # http://en.wikipedia.org/wiki/CIDR#Prefix_aggregation                #
 350 #                                                                     #
 351
 352 <cidr
 353           # ipv4clone: specifies how many bits of an IP address should be
 354       # looked at for clones. The default only looks for clones on a
 355       # single IP address of a user. You do not want to set this
 356       # extremely low. (Values are 0-32).
 357       ipv4clone="32"
 358
 359       # ipv6clone: specifies how many bits of an IP address should be
 360       # looked at for clones. The default only looks for clones on a
 361       # single IP address of a user. You do not want to set this
 362       # extremely low. (Values are 0-128).
 363       ipv6clone="128">
 364
 365 # This file has all the information about oper classes, types and o:lines.
 366 # You *MUST* edit it.
 367 <include file="conf/opers.conf.example">
 368
 369 # This file has all the information about server links and ulined servers.
 370 # You *MUST* edit it if you intend to link servers.
 371 <include file="conf/links.conf.example">
 372
 373 #-#-#-#-#-#-#-#-#-#-  MISCELLANEOUS CONFIGURATION  -#-#-#-#-#-#-#-#-#-#
 374 #                                                                     #
 375
 376 <files
 377        # motd: Path to your motd file. Path is relative to the run directory.
 378        motd="conf/inspircd.motd.example"
 379
 380        # rules: Path to your rules file. Path is relative to the run directory.
 381        # This is optional and is displayed when a user does /rules on the network.
 382        rules="conf/inspircd.rules.example">
 383
 384 #-#-#-#-#-#-#-#-#-#-#-# MAXIMUM CHANNELS -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 385 #                                                                     #
 386
 387 <channels
 388           # users: Maximum number of channels a user can be in at once.
 389           users="20"
 390
 391           # opers: Maximum number of channels a oper can be in at once.
 392           opers="60">
 393
 394 #-#-#-#-#-#-#-#-#-#-#-#-#-#-# DNS SERVER -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 395 # If these values are not defined, InspIRCd uses the default DNS resolver
 396 # of your system.
 397
 398 <dns
 399      # server: DNS server to use to attempt to resolve IP's to hostnames.
 400      # in most cases, you won't need to change this, as inspircd will
 401      # automatically detect the nameserver depending on /etc/resolv.conf
 402      # (or, on windows, your set nameservers in the registry.)
 403      # Note that this must be an IP address and not a hostname, because
 404      # there is no resolver to resolve the name until this is defined!
 405      #
 406      # server="127.0.0.1"
 407
 408      # timeout: seconds to wait to try to resolve DNS/hostname.
 409      timeout="5">
 410
 411 # An example of using an IPv6 nameserver
 412 #<dns server="::1" timeout="5">
 413
 414 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#  PID FILE  -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 415 #                                                                     #
 416 # Define the path to the PID file here. The PID file can be used to   #
 417 # rehash the ircd from the shell or to terminate the ircd from the    #
 418 # shell using shell scripts, perl scripts, etc... and to monitor the  #
 419 # ircd's state via cron jobs. If this is a relative path, it will be  #
 420 # relative to the configuration directory, and if it is not defined,  #
 421 # the default of 'inspircd.pid' is used.                              #
 422 #                                                                     #
 423
 424 #<pid file="/path/to/inspircd.pid">
 425
 426 #-#-#-#-#-#-#-#-#-#-#-#-#- BANLIST LIMITS #-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 427 #                                                                     #
 428 # Use these tags to customise the ban limits on a per channel basis.  #
 429 # The tags are read from top to bottom, and any tag found which       #
 430 # matches the channels name applies the banlimit to that channel.     #
 431 # It is advisable to put an entry with the channel as '*' at the      #
 432 # bottom of the list. If none are specified or no maxbans tag is      #
 433 # matched, the banlist size defaults to 64 entries.                   #
 434 #                                                                     #
 435
 436 <banlist chan="#morons" limit="128">
 437 <banlist chan="*" limit="69">
 438
 439 #-#-#-#-#-#-#-#-#-#-#-  DISABLED FEATURES  -#-#-#-#-#-#-#-#-#-#-#-#-#-#
 440 #                                                                     #
 441 # This tag is optional, and specifies one or more features which are  #
 442 # not available to non-operators.                                     #
 443 #                                                                     #
 444 # For example you may wish to disable NICK and prevent non-opers from #
 445 # changing their nicknames.                                           #
 446 # Note that any disabled commands take effect only after the user has #
 447 # 'registered' (e.g. after the initial USER/NICK/PASS on connection)  #
 448 # so for example disabling NICK will not cripple your network.        #
 449 #                                                                     #
 450 # You can also define if you want to disable any channelmodes         #
 451 # or usermodes from your users.                                       #
 452 #                                                                     #
 453 # `fakenonexistant' will make the ircd pretend that nonexistant       #
 454 # commands simply don't exist to non-opers ("no such command").       #
 455 #                                                                     #
 456 #<disabled commands="TOPIC MODE" usermodes="" chanmodes="" fakenonexistant="yes">
 457
 458
 459 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-  RTFM LINE  -#-#-#-#-#-#-#-#-#-#-#-#-#-#
 460 #                                                                     #
 461 #   Just remove this... Its here to make you read ALL of the config   #
 462 #   file options ;)                                                   #
 463
 464 <die value="You should probably edit your config *PROPERLY* and try again.">
 465
 466
 467
 468 #-#-#-#-#-#-#-#-#-#-#-#-#-  SERVER OPTIONS   -#-#-#-#-#-#-#-#-#-#-#-#-#
 469 #                                                                     #
 470 #   Settings to define which features are usable on your server.      #
 471 #                                                                     #
 472
 473 <options
 474          # prefixquit: What (if anything) a users' quit message
 475          # should be prefixed with.
 476          prefixquit="Quit: "
 477
 478          # suffixquit: What (if anything) a users' quit message
 479          # should be suffixed with.
 480          suffixquit=""
 481
 482          # prefixpart: What (if anything) a users' part message
 483          # should be prefixed with.
 484          prefixpart="&quot;"
 485          # NOTE: Use "\"" instead of "&quot;" if not using <config format="xml">
 486
 487          # suffixpart: What (if anything) a users' part message
 488          # should be suffixed with.
 489          suffixpart="&quot;"
 490
 491          # fixedquit: Set all users' quit messages to this value.
 492          #fixedquit=""
 493
 494          # fixedpart: Set all users' part messages in all channels
 495          # to this value.
 496          #fixedpart=""
 497
 498          # syntaxhints: If enabled, if a user fails to send the correct parameters
 499          # for a command, the ircd will give back some help text of what
 500          # the correct parameters are.
 501          syntaxhints="no"
 502
 503          # cyclehosts: If enabled, when a user gets a host set, it will cycle
 504          # them in all their channels. If not, it will simply change their host
 505          # without cycling them.
 506          cyclehosts="yes"
 507
 508          # ircumsgprefix: Use undernet-style message prefixing for NOTICE and
 509          # PRIVMSG. If enabled, it will add users' prefix to the line, if not,
 510          # it will just message the user normally.
 511          ircumsgprefix="no"
 512
 513          # announcets: If set to yes, when the TimeStamp on a channel changes, all users
 514          # in channel will be sent a NOTICE about it.
 515          announcets="yes"
 516
 517          # allowmismatched: Setting this option to yes will allow servers to link even
 518          # if they don't have the same VF_OPTCOMMON modules loaded. Setting this to
 519          # yes may introduce some desyncs and weirdness.
 520          allowmismatched="no"
 521
 522          # hostintopic: If enabled, channels will show the host of the topicsetter
 523          # in the topic. If set to no, it will only show the nick of the topicsetter.
 524          hostintopic="yes"
 525
 526          # pingwarning: If a server does not respond to a ping within x seconds,
 527          # it will send a notice to opers with snomask +l informing that the server
 528          # is about to ping timeout.
 529          pingwarning="15"
 530
 531          # serverpingfreq: How often pings are sent between servers (in seconds).
 532          serverpingfreq="60"
 533
 534          # allowhalfop: Allows the use of +h channelmode (halfops).
 535          allowhalfop="yes"
 536
 537          # defaultmodes: What modes are set on a empty channel when a user
 538          # joins it and it is unregistered. This is similar to Asuka's
 539          # autochanmodes.
 540          defaultmodes="nt"
 541
 542          # moronbanner: This is the text that is sent to a user when they are
 543          # banned from the server.
 544          moronbanner="You're banned! Email haha@abuse.com with the ERROR line below for help."
 545
 546          # invitebypassmodes: This allows /invite to bypass other channel modes.
 547          # (Such as +k, +j, +l, etc)
 548          invitebypassmodes="yes">
 549
 550
 551 #-#-#-#-#-#-#-#-#-#-#-# PERFORMANCE CONFIGURATION #-#-#-#-#-#-#-#-#-#-#
 552 #                                                                     #
 553
 554 <performance
 555              # netbuffersize: Size of the buffer used to recieve data from clients.
 556              # The ircd may only read this amount of text in 1 go at any time.
 557              netbuffersize="10240"
 558
 559              # maxwho: Maximum number of results to show in a /who query.
 560              maxwho="4096"
 561
 562              # somaxconn: The maximum number of connections that may be waiting
 563              # in the accept queue. This is *NOT* the total maximum number of
 564              # connections per server. Some systems may only allow this to be up
 565              # to 5, while others (such as linux and *BSD) default to 128.
 566              somaxconn="128"
 567
 568              # softlimit: This optional feature allows a defined softlimit for
 569              # connections. If defined, it sets a soft max connections value.
 570              # must be lower than ./configure maxclients.
 571              softlimit="12800"
 572
 573              # quietbursts: When syncing or splitting from a network, a server
 574              # can generate a lot of connect and quit messages to opers with
 575              # +C and +Q snomasks. Setting this to yes squelches those messages,
 576              # which makes it easier for opers, but degrades the functionality of
 577              # bots like BOPM during netsplits.
 578              quietbursts="yes"
 579
 580              # nouserdns: If enabled, no DNS lookups will be performed on
 581              # connecting users. This can save a lot of resources on very busy servers.
 582              nouserdns="no">
 583
 584 #-#-#-#-#-#-#-#-#-#-#-# SECURITY CONFIGURATION  #-#-#-#-#-#-#-#-#-#-#-#
 585 #                                                                     #
 586
 587 <security
 588
 589           # announceinvites: If this option is set, then invites are announced
 590           # to the channel when a user invites another user. If you consider
 591           # this to be unnecessary noise, set this to 'none'.
 592           # To announce to all ops, set this to 'ops' and to announce to all users,
 593           # set the value to 'all'. The value 'dynamic' will make the messages
 594           # go to every user who has power of INVITE on the channel. This
 595           # is the recommended setting.
 596           announceinvites="dynamic"
 597
 598           # hidemodes: If enabled, then the listmodes given will be hidden
 599           # from users below halfop. This is not recommended to be set on +b
 600           # as it may break some functionality in popular clients such as mIRC.
 601           hidemodes="eI"
 602
 603           # hideulines: If this value is set to yes, U-lined servers will
 604           # be hidden from non-opers in /links and /map.
 605           hideulines="no"
 606
 607           # flatlinks: If this value is set to yes, /map and /links will
 608           # be flattened when shown to non-opers.
 609           flatlinks="no"
 610
 611           # hidewhois: When defined, the given text will be used in place
 612           # of the server a user is on when whoised by a non-oper. Most
 613           # networks will want to set this to something like "*.netname.net"
 614           # to conceal the actual server a user is on.
 615           hidewhois=""
 616
 617           # hidebans: If this value is set to yes, when a user is banned ([gkz]lined)
 618           # only opers will see the ban message when the user is removed
 619           # from the server.
 620           hidebans="no"
 621
 622           # hidekills: If defined, replaces who set a /kill with a custom string.
 623           hidekills=""
 624
 625           # hidesplits: If enabled, non-opers will not be able to see which
 626           # servers split in a netsplit, they will only be able to see that one
 627           # occurred (If their client has netsplit detection).
 628           hidesplits="no"
 629
 630           # maxtargets: Maximum number of targets per command.
 631           # (Commands like /notice, /privmsg, /kick, etc)
 632           maxtargets="20"
 633
 634           # customversion: Displays a custom string when a user /version's
 635           # the ircd. This may be set for security reasons or vanity reasons.
 636           customversion=""
 637
 638           # operspywhois: If this is set to yes, when a oper /whois 's a user,
 639           # it will show all channels the user is in including +s and +p
 640           # channels.
 641           operspywhois="no"
 642
 643           # runasuser: If this is set, InspIRCd will attempt to setuid
 644           # to run as this user- allows binding of ports under 1024.
 645           # NOT SUPPORTED/NEEDED UNDER WINDOWS.
 646           #runasuser=""
 647
 648           # runasgroup: If this is set, InspIRCd will attempt to set group
 649           # to run under this group, which allows binding of ports under 1024
 650           # NOT SUPPORTED/NEEDED UNDER WINDOWS.
 651           #runasgroup=""
 652
 653           # restrictbannedusers: If this is set to yes, InspIRCd will not allow users
 654           # banned on a channel to change nickname or message channels they are
 655           # banned on.
 656           restrictbannedusers="yes"
 657
 658           # genericoper: Setting this value to yes makes all opers on this server
 659           # appear as 'is an IRC operator' in their WHOIS, regardless of their
 660           # oper type, however oper types are still used internally. This only
 661           # affects the display in WHOIS.
 662           genericoper="no"
 663
 664           # userstats: /stats commands that users can run (opers can run all).
 665           userstats="Pu">
 666
 667 #-#-#-#-#-#-#-#-#-#-#-#-# LIMITS CONFIGURATION  #-#-#-#-#-#-#-#-#-#-#-#
 668 #                                                                     #
 669 # This configuration tag defines the maximum sizes of various types   #
 670 # on IRC, such as the maximum length of a channel name, and the       #
 671 # maximum length of a channel. Note that with the exception of the    #
 672 # identmax value all values given here are the exact values you would #
 673 # expect to see on IRC. This contrasts with the older InspIRCd        #
 674 # releases where these values would be one character shorter than     #
 675 # defined to account for a null terminator on the end of the text.    #
 676 #                                                                     #
 677 # These values should match network-wide otherwise issues will occur. #
 678 #                                                                     #
 679 # The highest safe value you can set any of these options to is 500,  #
 680 # but it is recommended that you keep them somewhat                   #
 681 # near their defaults (or lower).                                     #
 682
 683 <limits
 684         # maxnick: Maximum length of a nickname.
 685         maxnick="31"
 686
 687         # maxchan: Maximum length of a channel name.
 688         maxchan="64"
 689
 690         # maxmodes: Maximum number of mode changes per line.
 691         maxmodes="20"
 692
 693         # maxident: Maximum length of a ident/username.
 694         maxident="11"
 695
 696         # maxquit: Maximum length of a quit message.
 697         maxquit="255"
 698
 699         # maxtopic: Maximum length of a channel topic.
 700         maxtopic="307"
 701
 702         # maxkick: Maximum length of a kick message.
 703         maxkick="255"
 704
 705         # maxgecos: Maximum length of a GECOS (realname).
 706         maxgecos="128"
 707
 708         # maxaway: Maximum length of an away message.
 709         maxaway="200">
 710
 711
 712 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 713 # Logging
 714 # -------
 715 #
 716 # Logging is covered with the <log> tag, which you may use to change
 717 # the behaviour of the logging of the IRCd.
 718 #
 719 # In InspIRCd as of 1.2, logging is pluggable and very extensible.
 720 # Different files can log the same thing, different 'types' of log can
 721 # go to different places, and modules can even extend the log tag
 722 # to do what they want.
 723 #
 724 # An example log tag would be:
 725 #       <log method="file" type="OPER" level="default" target="opers.log">
 726 # which  would log all information on /oper (failed and successful) to
 727 # a file called opers.log.
 728 #
 729 # There are many different types which may be used, and modules may
 730 # generate their own. A list of useful types:
 731 #       - USERS - information relating to user connection and disconnection
 732 #       - CHANNELS - information relating to joining and parting of channels.
 733 # XXX someone doc more on this
 734 #
 735 # You may also log *everything* by using a type of *, and subtract things out
 736 # of that by using -TYPE - for example "* -USERINPUT -USEROUTPUT".
 737 #
 738 # The following log tag is highly default and uncustomised. It is recommended you
 739 # sort out your own log tags. This is just here so you get some output.
 740
 741 <log method="file" type="* -USERINPUT -USEROUTPUT -m_spanningtree" level="default" target="ircd.log">
 742
 743 #-#-#-#-#-#-#-#-#-#-#-#-#-  WHOWAS OPTIONS   -#-#-#-#-#-#-#-#-#-#-#-#-#
 744 #                                                                     #
 745 # This tag lets you define the behaviour of the /whowas command of    #
 746 # your server.                                                        #
 747 #                                                                     #
 748
 749 <whowas
 750         # groupsize: Maximum entries per nick shown when performing
 751         # a /whowas nick.
 752         groupsize="10"
 753
 754         # maxgroups: Maximum number of nickgroups that can be added to
 755         # the list so that /whowas does not use a lot of resources on
 756         # large networks.
 757         maxgroups="100000"
 758
 759         # maxkeep: Maximum time a nick is kept in the whowas list
 760         # before being pruned. Time may be specified in seconds,
 761         # or in the following format: 1y2w3d4h5m6s. Minimum is
 762         # 1 hour.
 763         maxkeep="3d">
 764
 765 #-#-#-#-#-#-#-#-#-#-#-#-#-#-  BAN OPTIONS  -#-#-#-#-#-#-#-#-#-#-#-#-#-#
 766 #                                                                     #
 767 # The ban tags define nick masks, host masks and ip ranges which are  #
 768 # banned from your server. All details in these tags are local to     #
 769 # Your server.                                                        #
 770 #                                                                     #
 771
 772 <badip
 773        # ipmask: IP range to ban. Wildcards and CIDR can be used.
 774        ipmask="69.69.69.69"
 775
 776        # reason: Reason to display when user is disconnected.
 777        reason="No porn here thanks.">
 778
 779 <badnick
 780          # nick: Nick to disallow. Wildcards are supported.
 781          nick="ChanServ"
 782
 783          # reason: Reason to display on /nick.
 784          reason="Reserved For Services">
 785
 786 <badnick nick="NickServ" reason="Reserved For Services">
 787 <badnick nick="OperServ" reason="Reserved For Services">
 788 <badnick nick="MemoServ" reason="Reserved For Services">
 789
 790 <badhost
 791          # host: ident@hostname to ban.
 792          # Wildcards and CIDR (if you specify an IP) can be used.
 793          host="*@hundredz.n.hundredz.o.1337.kiddies.com"
 794
 795          # reason: Reason to display when user is disconnected
 796          reason="Too many 1337 kiddiots">
 797
 798 <badhost host="root@*" reason="Don't irc as root!">
 799 <badhost host="*@172.32.0.0/16" reason="This subnet is bad.">
 800
 801 # exception: Hosts that are exempt from [kgz]lines.
 802 <exception
 803            # host: ident@hostname to exempt.
 804            # Wildcards and CIDR (if you specify an IP) can be used.
 805            host="*@ircop.host.com"
 806
 807            # reason: Reason for exception. Only shown in /stats e
 808            reason="Opers hostname">
 809
 810 #-#-#-#-#-#-#-#-#-#-#- INSANE BAN OPTIONS  -#-#-#-#-#-#-#-#-#-#-#-#-#-#
 811 #                                                                     #
 812 # This optional tag allows you to specify how wide a gline, eline,    #
 813 # kline, zline or qline can be before it is forbidden from being      #
 814 # set. By setting hostmasks="yes", you can allow all G, K, E lines,   #
 815 # no matter how many users the ban would cover. This is not           #
 816 # recommended! By setting ipmasks="yes", you can allow all Z lines,   #
 817 # no matter how many users these cover too. Needless to say we        #
 818 # don't recommend you do this, or, set nickmasks="yes", which will    #
 819 # allow any qline.                                                    #
 820 #                                                                     #
 821
 822 <insane
 823         # hostmasks: Allow bans with insane hostmasks. (over-reaching bans)
 824         hostmasks="no"
 825
 826         # ipmasks: Allow bans with insane ipmasks. (over-reaching bans)
 827         ipmasks="no"
 828
 829         # nickmasks: Allow bans with insane nickmasks. (over-reaching bans)
 830         nickmasks="no"
 831
 832         # trigger: What percentage of users on the network to trigger
 833         # specifying an insane ban as. The default is 95.5%, which means
 834         # if you have a 1000 user network, a ban will not be allowed if it
 835         # will be banning 955 or more users.
 836         trigger="95.5">
 837
 838
 839 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#- YAWN  -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 840 #                                                                     #
 841 #   You should already know what to do here :)                        #
 842
 843 <die value="User error. Insert new user and press any key. (you didn't edit your config properly.)">
 844
 845 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# MODULES #-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 846 #    ____                _   _____ _     _       ____  _ _   _        #
 847 #   |  _ \ ___  __ _  __| | |_   _| |__ (_)___  | __ )(_) |_| |       #
 848 #   | |_) / _ \/ _` |/ _` |   | | | '_ \| / __| |  _ \| | __| |       #
 849 #   |  _ <  __/ (_| | (_| |   | | | | | | \__ \ | |_) | | |_|_|       #
 850 #   |_| \_\___|\__,_|\__,_|   |_| |_| |_|_|___/ |____/|_|\__(_)       #
 851 #                                                                     #
 852 # Well done, you've reached the end of the basic configuration, your  #
 853 # ircd should now start if you want to try it out! (./inspircd start) #
 854 #                                                                     #
 855 # We now suggest you read and edit modules.conf, as modules are what  #
 856 # provide almost all the features of InspIRCd. :)                     #
 857 #                                                                     #
 858 # The default does nothing -- we include it for simplicity for you.   #
 859 <include file="conf/modules.conf.example">
 860
 861
 862 #########################################################################
 863 #                                                                       #
 864 #                     - InspIRCd Development Team -                     #
 865 #                        http://www.inspircd.org                        #
 866 #                                                                       #
 867 #########################################################################