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