conf/inspircd.conf.example

   1 ########################################################################
   2 #                                                                      #
   3 #                     ---------------------------                      #
   4 #                     InspIRCd Configuration File                      #
   5 #                     ---------------------------                      #
   6 #                                                                      #
   7 ##################################||####################################
   8                                  #||#
   9 ##################################||####################################
  10 #                                                                      #
  11 #         This is an example of the config file for InspIRCd.          #
  12 #             Change the options to suit your network                  #
  13 #                                                                      #
  14 #                 Last updated on : 18/12/2005                         #
  15 #                 Written by      : CC  (cc@backchat.co.za)            #
  16 #                 Updated by      : katsklaw (katsklaw@gmail.com)      #
  17 #                 Updated by:     : brain (brain@inspircd.org)         #
  18 ########################################################################
  19
  20
  21
  22 #-#-#-#-#-#-#-#-#-#-#-#-  SERVER DESCRIPTION  -#-#-#-#-#-#-#-#-#-#-#-#-
  23 #                                                                     #
  24 #   Here is where you enter the information about your server.        #
  25 #                                                                     #
  26 #  Syntax is as follows:                                              #
  27 #     <server name="server.name"                                      #
  28 #      description="Server Description"                               #
  29 #      network="MyNetwork">                                           #
  30 #                                                                     #
  31
  32 <server name="penguin.omega.org.za"
  33         description="Waddle World"
  34         network="Omega">
  35
  36
  37 #-#-#-#-#-#-#-#-#-#-#-#-   ADMIN INFORMATION   -#-#-#-#-#-#-#-#-#-#-#-#
  38 #                                                                     #
  39 #   Describes the Server Administrator's real name, nick              #
  40 #   and email address.                                                #
  41 #                                                                     #
  42 #  Syntax is as follows:                                              #
  43 #       <admin name="real name"                                       #
  44 #              nick="nick name"                                       #
  45 #              email="email@address.com">                             #
  46 #                                                                     #
  47
  48 <admin  name="Johnny English"
  49         nick="MI5"
  50         email="MI5@the.best.secret.agent">
  51
  52
  53 #-#-#-#-#-#-#-#-#-#-#-#-   PORT CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-
  54 #                                                                     #
  55 #   Enter the port and address bindings here.                         #
  56 #                                                                     #
  57 #  bind address - specifies which the address which ports bind        #
  58 #  port         - opens an unused port                                #
  59 #  type         - can be 'clients' or 'servers'. The clients type is  #
  60 #                 a standard tcp based socket, the servers type is a  #
  61 #                 also a TCP based connection but of a different      #
  62 #                 format.                                             #
  63 #                                                                     #
  64 #  Leaving address empty binds to all available interfaces            #
  65 #                                                                     #
  66 #  Syntax is as follows:                                              #
  67 #                                                                     #
  68 # <bind address="ip number" port="port" type="clients">               #
  69 # <bind address="ip number" port="port" type="servers">               #
  70 #                                                                     #
  71
  72 <bind address="" port="6660" type="clients">
  73 <bind address="" port="7000" type="servers">
  74 <bind address="" port="7001" type="servers">
  75
  76
  77 #-#-#-#-#-#-#-#-#-#-  DIE/RESTART CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-
  78 #                                                                     #
  79 #   You can configure the passwords here which you wish to use for    #
  80 #   the die and restart commands. Only trusted ircops who will        #
  81 #   need this ability should know the die and restart password.       #
  82 #                                                                     #
  83 #  Syntax is as follows:                                              #
  84 #       <power diepass="die password" restartpass="restart password"  #
  85 #        pause="secs before dying">                                   #
  86 #                                                                     #
  87
  88 <power diepass="diepass" restartpass="restartpass" pause="2">
  89
  90
  91 #-#-#-#-#-#-#-#-#-#  INCLUDE CONFIGURATION  #-#-#-#-#-#-#-#-#-#-#-#-#-#
  92 #                                                                     #
  93 # This optional tag allows you to include another config file         #
  94 # allowing you to keep your configuration tidy. The configuration     #
  95 # file you include will be treated as part of the configuration file  #
  96 # which includes it, in simple terms the inclusion is transparent.    #
  97 #                                                                     #
  98 # All paths to config files are relative to the directory of the main #
  99 # config file inspircd.conf, unless the filename starts with a forward#
 100 # slash (/) in which case it is treated as an absolute path.          #
 101 #                                                                     #
 102 # Syntax is as follows:                                               #
 103 #       <include file="file.conf">                                    #
 104 #                                                                     #
 105
 106 #-#-#-#-#-#-#-#-#-#-  CONNECTIONS CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-
 107 #                                                                     #
 108 #   This is where you can configure which connections are allowed     #
 109 #   and denied access onto your server.                               #
 110 #   The password is optional.                                         #
 111 #   You may have as many of these as you require.                     #
 112 #   To allow/deny all connections use a *                             #
 113 #                                                                     #
 114 #  Syntax is as follows:                                              #
 115 #       <connect allow="ip or host">                                  #
 116 #       <connect allow="ip or host" password="blahblah">              #
 117 #       <connect allow="ip or host" password="blah" timeout="10">     #
 118 #       <connect allow="ip or host" timeout="blah" flood="5">         #
 119 #       <connect allow="ip or host" threshold="8" pingfreq="120">     #
 120 #       <connect allow="ip or host" sendq="99999" revcq="696969">     #
 121 #       <connect deny="ip or host">                                   #
 122 #                                                                     #
 123 #   You may optionally include timeout="x" on any allow line, which   #
 124 #   specifies the amount of time given before an unknown connection   #
 125 #   is closed if USER/NICK/PASS are not given. This value is in secs  #
 126 #                                                                     #
 127 #   You may also optionally include a flood="x" line which indicates  #
 128 #   the number of lines a user may place into their buffer at once    #
 129 #   before they are disconnected for excess flood. The default is to  #
 130 #   DISABLE this feature. A recommended value is 10. A counter is     #
 131 #   maintained for each user which is reset every 'threshold' seconds #
 132 #   and specifying this threshold value with threshold="X" indicates  #
 133 #   how often the counter is reset. For example, with flood="5" and   #
 134 #   threshold="8", the user may not send more than 5 lines in 8 secs. #
 135 #                                                                     #
 136 #   You may optionally specify the sendq size and ping frequency of   #
 137 #   each connect:allow line using the pingfreq="X" and sendq="X"      #
 138 #   settings as shown in the full example below.                      #
 139 #   The ping frequency is specified in seconds, and the sendq size    #
 140 #   in bytes. It is recommended, although not enforced, that you      #
 141 #   should never set your sendq size to less than 8k. Send Queues are #
 142 #   dynamically allocated and can grow as needed up to the maximum    #
 143 #   size specified.                                                   #
 144 #                                                                     #
 145 #   The optional recvq value is the maximum size which users in this  #
 146 #   group may grow their receive queue to. This is recommended to be  #
 147 #   kept pretty low compared to the sendq, as users will always       #
 148 #   recieve more than they send in normal circumstances. The default  #
 149 #   if not specified is 4096.                                         #
 150 #                                                                     #
 151 #   IMPORTANT NOTE, CALL THE CONFUSION POLICE!                        #
 152 #   The sendq is the data waiting to be sent TO THE USER.             #
 153 #   The recvq is the data being received FROM THE USER.               #
 154 #   The names sendq and recvq are from the SERVER'S PERSPECTIVE not   #
 155 #   that of the user... Just to clear up any confusion or complaints  #
 156 #   that these are backwards :p                                       #
 157 #                                                                     #
 158
 159 <connect allow="196.12.*"  password="secret">
 160 <connect allow="*" timeout="60" flood="20" threshold="5" pingfreq="120" sendq="262144" recvq="16384">
 161
 162 <connect deny="69.254.*">
 163
 164
 165 #-#-#-#-#-#-#-#-#-#-#-#-  CLASS CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-
 166 #                                                                     #
 167 #   Classes are a group of commands which are grouped together        #
 168 #   and given a unique name. They used to define which commands       #
 169 #   are available to certain types of Operators.                      #
 170 #                                                                     #
 171 #   Note that you are not restricted just to the class names shown    #
 172 #   here and you can make your own up. That is the idea, this ircd    #
 173 #   is very unrestrictive about configuration.                        #
 174 #                                                                     #
 175 #  Syntax is as follow:                                               #
 176 #       <class name="name" commands="oper commands">                  #
 177 #                                                                     #
 178
 179 <class name="Shutdown" commands="DIE RESTART REHASH">
 180 <class name="ServerLink" commands="CONNECT SQUIT">
 181 <class name="BanControl" commands="KILL GLINE KLINE ZLINE QLINE SHUN">
 182 <class name="OperChat" commands="WALLOPS CHATOPS">
 183 <class name="HostCloak" commands="SETHOST SETIDENT SETNAME">
 184
 185
 186 #-#-#-#-#-#-#-#-#-#-#-#-  OPERATOR COMPOSITION   -#-#-#-#-#-#-#-#-#-#-#
 187 #                                                                     #
 188 #   This is where you specify which types of operators you have on    #
 189 #   your server, as well as the commands they are allowed to use.     #
 190 #   This works alongside with the classes specified above.            #
 191 #                                                                     #
 192 #  type name  - a name for the combined class types                   #
 193 #  classes    - specified above, used for flexibility for the         #
 194 #               server admin to decide on which operators get         #
 195 #               what commands                                         #
 196 #  host       - hostmask operators will recieve on oper-up.           #
 197 # (optional)                                                          #
 198 #                                                                     #
 199 #  Syntax is as follows:                                              #
 200 #       <type name="name" classes="class name" host="oper hostmask">  #
 201 #                                                                     #
 202 # Please note that you are not restricted to just the four oper types #
 203 # shown below. You can make up your own opertypes, that is what its   #
 204 # designed for! Please note that oper types, and classes above, are   #
 205 # case sensitive and may only be one word long, no spaces.            #
 206 #                                                                     #
 207
 208 <type name="NetAdmin" classes="OperChat BanControl HostCloak Shutdown ServerLink" host="netadmin.omega.org.za">
 209 <type name="GlobalOp" classes="OperChat BanControl HostCloak ServerLink" host="ircop.omega.org.za">
 210 <type name="LocalOp" classes="OperChat BanControl HostCloak" host="local.omega.org.za">
 211 <type name="Helper" classes="HostCloak" host="helper.omega.org.za">
 212
 213
 214 #-#-#-#-#-#-#-#-#-#-#-  OPERATOR CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#
 215 #                                                                     #
 216 #   Opers are defined here. This is a very important section.         #
 217 #   Remember to only make operators out of truthworthy people.        #
 218 #                                                                     #
 219 #  name      - oper name, best to use lower-case                      #
 220 #  password  - password to oper-up,                                   #
 221 #              encryption not supported by inspircd. However, there   #
 222 #              are modules that allow for oper password encryption.   #
 223 #                                                                     #
 224 #  host      - host of client allowed to oper-up, more hostmasks      #
 225 #              seperated by spaces, wildcards accepted                #
 226 #  type      - specified above, defines the kind of operator          #
 227 #                                                                     #
 228 #  Syntax is as follows:                                              #
 229 #       <oper name="login"                                            #
 230 #             password="pass"                                         #
 231 #             host="hostmask@of.oper"                                 #
 232 #             type="oper type">                                       #
 233 #                                                                     #
 234
 235 <oper   name="katsklaw"
 236         password="s3cret"
 237         host="*@*"
 238         type="NetAdmin">
 239
 240
 241 #-#-#-#-#-#-#-#-#-#-#-  SERVER LINK CONFIGURATION  -#-#-#-#-#-#-#-#-#-#
 242 #                                                                     #
 243 # Defines which servers can link to this one, and which servers this  #
 244 # server may create outbound links to.                                #
 245 #                                                                     #
 246 # name        - The name is the canocial name of the server, it does  #
 247 #               not have to resolve - but it is expected to be sent   #
 248 #               in the remote servers connection info.                #
 249 # ipaddr      - Valid host or ip address for remote server. *         #
 250 # port        - Valid listening TCP port for remote server.           #
 251 # sendpass    - Password to send to create an outbound connection to  #
 252 #               this server.                                          #
 253 # recvpass    - Password to receive to accept an inbound connection   #
 254 #               from this server.                                     #
 255 # autoconnect - Sets the server to autoconnect. Where x is the number #
 256 # (optional)    of seconds between attempts.  300 = 5 minutes         #
 257 #                                                                     #
 258 # to u:line a server (give it extra privilages required for running   #
 259 # services, Q, etc) you must include the <uline server> tag as shown  #
 260 # in the example below. You can have as many of these as you like.    #
 261 #                                                                     #
 262 # WARNING: Unlike other ircds, u:lining a server allows ALL users on  #
 263 # that server to operoverride modes. This should only be used for     #
 264 # services and protected oper servers!                                #
 265 #                                                                     #
 266 # IMPORTANT NOTE: When specifying the ip address and/or host, the     #
 267 # server software will prioritize RESOLVED hostnames above ip         #
 268 # addresses, so for example if your target server resolves to a.b.com #
 269 # you MUST put a.b.com into your link block, and NOT the IP address   #
 270 # of a.b.com. The system uses reverse resolution.                     #
 271 #                                                                     #
 272
 273 <link name="hub.penguin.org"
 274         ipaddr="penguin.box.com"
 275         port="7000"
 276         autoconnect="300"
 277         sendpass="outgoing!password"
 278         recvpass="incoming!password">
 279
 280 <link name="services.antarctic.com"
 281         ipaddr="localhost"
 282         port="7000"
 283         sendpass="penguins"
 284         recvpass="polarbears">
 285
 286 <uline server="services.antarctic.com">
 287
 288
 289 #-#-#-#-#-#-#-#-#-#-  MISCELLANEOUS CONFIGURATION  -#-#-#-#-#-#-#-#-#-#
 290 #                                                                     #
 291 #   These options let you define the path to your motd and rules      #
 292 #   files.                                                            #
 293 #                                                                     #
 294
 295 <files  motd="/home/cc/inspircd/conf/inspire.motd"
 296         rules="/home/cc/inspircd/conf/inspire.rules">
 297
 298 #-#-#-#-#-#-#-#-#-#-#-#-#-#-# DNS SERVER -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 299 #                                                                     #
 300 # Define your DNS server address here. InspIRCd has its own resolver  #
 301 # and you must define this otherwise nobody's host will resolve. The  #
 302 # timeout value is in seconds.                                        #
 303 #                                                                     #
 304
 305 <dns server="127.0.0.1" timeout="5">
 306
 307 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#  PID FILE  -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 308 #                                                                     #
 309 # Define the path to the PID file here. The PID file can be used to   #
 310 # rehash the ircd from the shell or to terminate the ircd from the    #
 311 # shell using shell scripts, perl scripts etc, and to monitor the     #
 312 # ircd's state via cron jobs.                                         #
 313 #                                                                     #
 314 # This tag is NOT optional and must be defined. Once you have defined #
 315 # it, remove the die tag above it to mark it as valid.                #
 316 #                                                                     #
 317
 318 <die value="Someone did not define their PID file path!">
 319 <pid file="/path/to/inspircd.pid">
 320
 321 #-#-#-#-#-#-#-#-#-#-#-#-#- BANLIST LIMITS #-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 322 #                                                                     #
 323 # Use these tags to customise the ban limits on a per channel basis.  #
 324 # the tags are read from top to bottom, and any tag found which       #
 325 # matches the channels name applies the banlimit to that channel.     #
 326 # It is advisable to put an entry with the channel as '*' at the      #
 327 # bottom of the list. If none are specified or no maxbans tag is      #
 328 # matched, the banlist size defaults to 64 entries.                   #
 329 #                                                                     #
 330
 331 <banlist chan="#morons" limit="128">
 332 <banlist chan="*" limit="69">
 333
 334 #-#-#-#-#-#-#-#-#-#-#-  DISABLED COMMANDS  -#-#-#-#-#-#-#-#-#-#-#-#-#-#
 335 #                                                                     #
 336 # This tag is optional, and specifies one or more commands which are  #
 337 # not available to non-operators. For example you may wish to disable #
 338 # NICK and prevent non-opers from changing their nicknames.           #
 339 # Note that any disabled commands take effect only after the user has #
 340 # 'registered' (e.g. after the initial USER/NICK/PASS on connection)  #
 341 # so for example disabling NICK will not cripple your network.        #
 342 #                                                                     #
 343 #         <disabled commands="TOPIC MODE">                            #
 344 #                                                                     #
 345
 346
 347 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-  RTFM LINE  -#-#-#-#-#-#-#-#-#-#-#-#-#-#
 348 #                                                                     #
 349 #   Just remove this... Its here to make you read ALL of the config   #
 350 #   file options ;)                                                   #
 351
 352 <die value="You should probably edit your config *PROPERLY* and try again.">
 353
 354
 355
 356 #-#-#-#-#-#-#-#-#-#-#-#-#-  SERVER OPTIONS   -#-#-#-#-#-#-#-#-#-#-#-#-#
 357 #                                                                     #
 358 #   Settings to define which features are useable on your server.     #
 359 #                                                                     #
 360 #  prefixquit    - a prefix for a client's quit message               #
 361 #  loglevel      - specifies what detail of messages to log in the    #
 362 #                  log file. You may select from debug, verbose,      #
 363 #                  default, sparse and none.                          #
 364 #  allowhalfop   - allows the +h channel mode                         #
 365 #  noservices    - If noservices is true, yes, or 1, then the first   #
 366 #                  user into a channel gets founder status. This is   #
 367 #                  only useful on networks running the m_chanprotect  #
 368 #                  module without services.                           #
 369 #  netbuffersize - size of the buffer used to receive data from       #
 370 #                  clients. The ircd may only read() this amount      #
 371 #                  of text in one go at any time. (OPTIONAL)          #
 372 #  maxwho        - The maximum number of results returned by a /WHO   #
 373 #                  query. This is to prevent /WHO being used as a     #
 374 #                  spam vector or means of flooding an ircd. The      #
 375 #                  default is 128, it is not recommended to raise it  #
 376 #                  above 1024. Values up to 65535 are permitted.      #
 377 #  somaxconn     - The maximum number of sockets that may be waiting  #
 378 #                  in the accept queue. This usually allows the ircd  #
 379 #                  to soak up more connections in a shorter space of  #
 380 #                  time when increased but please be aware there is a #
 381 #                  system defined maximum value to this, the same way #
 382 #                  there is a system defined maximum number of file   #
 383 #                  descriptors. Some systems may only allow this to   #
 384 #                  be up to 5 (ugh) while others such as FreeBSD will #
 385 #                  default to a much nicer 128.                       #
 386 #  moduledir     - This optional value indicates a runtime change of  #
 387 #                  the location where modules are to be found. This   #
 388 #                  does not add a supplementary directory. There can  #
 389 #                  only be one module path.                           #
 390 #  softlimit     - This optional feature allows a defined softlimit.  #
 391 #                  if defined sets a soft maxconnections value, has   #
 392 #                  to be less than the ./configure maxclients         #
 393 #                                                                     #
 394
 395 <options prefixquit="Quit: "
 396          loglevel="default"
 397          netbuffersize="10240"
 398          maxwho="128"
 399          noservices="0"
 400          allowhalfop="yes">
 401
 402
 403 #-#-#-#-#-#-#-#-#-#-#-#-#-  MODULE OPTIONS   -#-#-#-#-#-#-#-#-#-#-#-#-#
 404 #                                                                     #
 405 #  These tags define which modules will be loaded on startup by your  #
 406 #  server. Add modules without any paths. When you make your ircd     #
 407 #  using the 'make' command, all compiled modules will be moved into  #
 408 #  the folder you specified when you ran ./configure. The module tag  #
 409 #  automatically looks for modules in this location.                  #
 410 #  If you attempt to load a module outside of this location, either   #
 411 #  in the config, or via /LOADMODULE, you will receive an error.      #
 412 #                                                                     #
 413 #  By default, ALL modules are commented out. You must uncomment them #
 414 #  or add lines to your config to load modules. Please refer to       #
 415 #  http://www.inspircd.org/wiki/Modules_List for a list of modules and#
 416 #  each modules link for any additional conf tags they require.       #
 417 #                                                                     #
 418 #  WINDOWS USERS PLEASE NOTE: You can still load these modules! They  #
 419 #  are incorporated into the executable and can be loaded and removed #
 420 #  similarly to if they were in a ramdisk.                            #
 421
 422
 423 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 424 #  ____  _____    _    ____    _____ _   _ ___ ____    ____ ___ _____ _
 425 # |  _ \| ____|  / \  |  _ \  |_   _| | | |_ _/ ___|  | __ )_ _|_   _| |
 426 # | |_) |  _|   / _ \ | | | |   | | | |_| || |\___ \  |  _ \| |  | | | |
 427 # |  _ <| |___ / ___ \| |_| |   | | |  _  || | ___) | | |_) | |  | | |_|
 428 # |_| \_\_____/_/   \_\____/    |_| |_| |_|___|____/  |____/___| |_| (_)
 429 #
 430 # Please note that as of 1.0 Beta 6 and onwards, linking is modular.
 431 # This means that unless you load m_spanningtree.so (as commented out
 432 # below) you will be UNABLE TO LINK ANY SERVERS (including services!).
 433 # Uncommenting the tag below loads basic linking support.
 434 #
 435 #<module name="m_spanningtree.so">
 436
 437 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 438 # Foobar module - does nothing. This is a test module for coders.
 439 #<module name="m_foobar.so">
 440
 441 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 442 # Chanprotect module: gives +q and +a channel modes
 443 #<module name="m_chanprotect.so">
 444
 445 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 446 # Globops module: gives /GLOBOPS and usermode +g
 447 #<module name="m_globops.so">
 448
 449 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 450 # Noinvite module: Gives channel mode +V
 451 #<module name="m_noinvite.so">
 452
 453 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 454 # Oper MD5 module: Allows MD5 hashed oper passwords
 455 #<module name="m_opermd5.so">
 456
 457 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 458 # Restricted channels module: Allows only opers to create channels
 459 #<module name="m_restrictchans.so">
 460
 461 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 462 # Deny Channels: Deny Channels from being used by users
 463 #<module name="m_denychans.so">
 464
 465 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 466 # Services support module: Adds several usermodes such as +R and +M
 467 #<module name="m_services.so">
 468
 469 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 470 # Userip module: Adds the /USERIP command
 471 #<module name="m_userip.so">
 472
 473 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 474 # Alias module: Allows you to define server-side command aliases
 475 #<module name="m_alias.so">
 476
 477 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 478 # CHGHOST module: Adds the /CHGHOST command
 479 #<module name="m_chghost.so">
 480
 481 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 482 # HELPOP module: Provides the /HELPOP command
 483 #<module name="m_helpop.so">
 484
 485 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 486 # No kicks module: Adds the +Q channel mode
 487 #<module name="m_nokicks.so">
 488
 489 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 490 # Oper MOTD module: Provides support for seperate message of the day
 491 # on oper-up
 492 #<module name="m_opermotd.so">
 493
 494 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 495 # Restrict message module: Allows users to only message opers
 496 #<module name="m_restrictmsg.so">
 497
 498 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 499 # Sethost module: Adds the /SETHOST command
 500 #<module name="m_sethost.so">
 501
 502 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 503 # Antibottler module: Labels bottler leech bots
 504 #<module name="m_antibottler.so">
 505
 506 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 507 # Watch module: Adds the WATCH command, which is used by clients to
 508 # maintain notify lists.
 509 #<module name="m_watch.so">
 510
 511 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 512 # Cloaking module: Adds usermode +x and cloaking support
 513 #<module name="m_cloaking.so">
 514
 515 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 516 # Hostchange module: Allows a different style of cloaking
 517 #<module name="m_hostchange.so">
 518
 519 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 520 # No nicks module: Adds the +N channel mode
 521 #<module name="m_nonicks.so">
 522
 523 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 524 # Override module: Adds support for oper override
 525 #<module name="m_override.so">
 526
 527 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 528 # SAJOIN module: Adds the /SAJOIN command
 529 #<module name="m_sajoin.so">
 530
 531 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 532 # Set Idle module: Adds a command for opers to change their
 533 # idle time (mainly a toy)
 534 #<module name="m_setidle.so">
 535
 536 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 537 # Block colour module: Adds the +c channel mode
 538 #<module name="m_blockcolor.so">
 539
 540 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 541 # Conn-Lusers: Shows the LUSERS output on connect
 542 #<module name="m_conn_lusers.so">
 543
 544 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 545 # Ident: Provides RFC 1413 ident lookup support
 546 #<module name="m_ident.so">
 547
 548 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 549 # No Notice module: adds the channel mode +T
 550 #<module name="m_nonotice.so">
 551
 552 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 553 # Parking module: Adds parking support and /PARK and /UNPARK
 554 #<module name="m_park.so">
 555
 556 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 557 # SAMODE module: Adds the oper /SAMODE command
 558 #<module name="m_samode.so">
 559
 560 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 561 # SETNAME module: Adds the /SETNAME command
 562 #<module name="m_setname.so">
 563
 564 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 565 # Botmode module: Adds the user mode +B
 566 #<module name="m_botmode.so">
 567
 568 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 569 # Filter module: Provides glob-based message filtering
 570 #<module name="m_filter.so">
 571
 572 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 573 # Knock module: adds the /KNOCK command and +K channel mode
 574 #<module name="m_knock.so">
 575
 576 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 577 # Oper channels mode: Adds the +O channel mode
 578 #<module name="m_operchans.so">
 579
 580 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 581 # Random Quote module: provides a random quote on connect
 582 #<module name="m_randquote.so">
 583
 584 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 585 # SANICK module: Allows opers to change user's nicks
 586 #<module name="m_sanick.so">
 587
 588 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 589 # Show Whois module: Adds the +W usermode which allows opers
 590 # to see when they are whois'ed
 591 #<module name="m_showwhois.so">
 592
 593 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 594 # Strip colour module: Adds the channel mode +S
 595 #<module name="m_stripcolor.so">
 596
 597 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 598 # Censor module: Adds the channel mode +G
 599 #<module name="m_censor.so">
 600
 601 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 602 # Nick locking module: Adds the oper-only /NICKLOCK command
 603 #<module name="m_nicklock.so">
 604
 605 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 606 # Oper Join module: Forces opers to join a channel on oper-up
 607 #<module name="m_operjoin.so">
 608
 609 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 610 # Redirect module: Adds channel redirection (mode +L)
 611 #<module name="m_redirect.so">
 612
 613 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 614 # SAPART module: Adds the oper /SAPART command
 615 #<module name="m_sapart.so">
 616
 617 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 618 # SILENCE module: Adds support for /SILENCE
 619 #<module name="m_silence.so">
 620
 621 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 622 # Test command module: Does nothing significant
 623 #<module name="m_testcommand.so">
 624
 625 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 626 # Channel filter module: Allows channel-op defined message
 627 # filtering using simple string matches (channel mode +g)
 628 #<module name="m_chanfilter.so">
 629
 630 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 631 # No ctcp module: Adds the channel mode +C to block CTCPs
 632 #<module name="m_noctcp.so">
 633
 634 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 635 # Oper levels module: Gives each oper a level and prevents
 636 # actions being taken against higher level opers
 637 #<module name="m_operlevels.so">
 638
 639 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 640 # Remove module: Adds the /REMOVE command which is a peaceful
 641 # alternative to /KICK
 642 #<module name="m_remove.so">
 643
 644 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 645 # SAQUIT module: Adds the oper /SAQUIT command (abusable!!!)
 646 #<module name="m_saquit.so">
 647
 648 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 649 # Timed bans module: Adds timed bans and the /TBAN command
 650 #<module name="m_timedbans.so">
 651
 652 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 653 # Oper modes module: Allows you to specify modes to add/remove on oper
 654 #<module name="m_opermodes.so">
 655
 656 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 657 # SWHOIS module. Allows opers to place arbitary text in their WHOIS.
 658 #<module name="m_swhois.so">
 659
 660
 661 #-#-#-#-#-#-#-#-#-#-#-  FILTER  CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#-#
 662 #                                                                     #
 663 # Optional - If you specify to use the m_filter.so module, then       #
 664 # specfiy below the path to the filter.conf file.                     #
 665
 666 #<filter file="/path/to/inspircd/filter.conf">
 667
 668
 669 #-#-#-#-#-#-#-#-#-#-#-#-  HELPOP  CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#
 670 #                                                                     #
 671 # Optional - If you specify to use the m_helpop.so module, then       #
 672 # specify below the path to the helpop.conf file.                     #
 673
 674 <die value="If you used the helpop include above then do *NOT* use this tag.">
 675 #<helpop file="/path/to/inspircd/helpop.conf">
 676
 677
 678 #-#-#-#-#-#-#-#-#-#-  RANDOMQUOTES CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
 679 #                                                                     #
 680 # Optional - If you specify to use the m_randquotes.so module, then   #
 681 # specify below the path to the randquotes.conf file.                 #
 682
 683 #<randquote file="/path/to/inspircd/randquotes.conf">
 684
 685 #-#-#-#-#-#-#-#-#-#-#-#-#-#-  BAN OPTIONS  -#-#-#-#-#-#-#-#-#-#-#-#-#-#
 686 #                                                                     #
 687 # The ban tags define nick masks, host masks and ip ranges which are  #
 688 # banned from your server. All details in these tags are local to     #
 689 # Your server.                                                        #
 690 #                                                                     #
 691 #                                                                     #
 692 # badip lines ban an ip range (same as a zline)                       #
 693 #                                                                     #
 694 # ipmask       -          The ip range to ban (wildcards possible)    #
 695 # reason       -          Reason to display when disconnected         #
 696 #                                                                     #
 697 # badnick lines ban a nick mask (same as a qline)                     #
 698 #                                                                     #
 699 # nick         -          Nick mask to ban (wildcards possible)       #
 700 # reason       -          Reason to display on /NICK                  #
 701 #                                                                     #
 702 # badhost lines ban a user@host mask (same as a kline)                #
 703 #                                                                     #
 704 # host         -          ident@hostname (wildcards possible)         #
 705 # reason       -          Reason to display on disconnection          #
 706 #                                                                     #
 707 # exception lines define a hostmask that is excempt from [kzg]lines   #
 708 #                                                                     #
 709 # host         -          ident@hostname (wildcards possible)         #
 710 # reason       -          Reason, shown only in /stats e              #
 711 #                                                                     #
 712
 713 <badip ipmask="69.69.69.69" reason="No porn here thanks.">
 714
 715 <badnick nick="ChanServ" reason="Reserved For Services">
 716 <badnick nick="NickServ" reason="Reserved For Services">
 717 <badnick nick="OperServ" reason="Reserved For Services">
 718 <badnick nick="MemoServ" reason="Reserved For Services">
 719
 720 <badhost host="*@hundredz.n.hundredz.o.1337.kiddies.com" reason="Too many 1337 kiddiots">
 721 <badhost host="*@localhost" reason="No irc from localhost!">
 722
 723 <exception host="*@ircop.host.com" reason="Opers hostname">
 724
 725 #-#-#-#-#-#-#-#-#-#-#-  ALIAS DEFINITIONS  -#-#-#-#-#-#-#-#-#-#-#-#-#-#
 726 #                                                                     #
 727 # If you have the m_alias.so module loaded, you may also define       #
 728 # aliases as shown below. They are commonly used to provide shortcut  #
 729 # commands to services, however they are not limited to jsut this use.#
 730 # An alias tag requires the following values to be defined in it:     #
 731 #                                                                     #
 732 # text        -      The text to detect at the start of the line,     #
 733 #                    must be at the start of the line to trigger the  #
 734 #                    alias. May contain spaces, but case insensitive. #
 735 # replace     -      The text to replace 'text' with. Usually this    #
 736 #                    will be "PRIVMSG ServiceName :" or similar.      #
 737 # requires    -      If you provide a value for 'requires' this means #
 738 #                    the given nickname MUST be online for the alias  #
 739 #                    to successfully trigger. If they are not, then   #
 740 #                    the user receives a 'no such nick' 401 numeric.  #
 741 # uline       -      Defining this value with 'yes', 'true' or '1'    #
 742 #                    will ensure that the user given in 'requires'    #
 743 #                    must also be on a u-lined server, as well as     #
 744 #                    actually being on the network. If the user is    #
 745 #                    online, but not on a u-lined server, then an     #
 746 #                    oper-alert is sent out as this is possibly signs #
 747 #                    of a user trying to impersonate a service.       #
 748 #                                                                     #
 749
 750 <alias text="NICKSERV" replace="PRIVMSG NickServ :" requires="NickServ" uline="yes">
 751 <alias text="CHANSERV" replace="PRIVMSG ChanServ :" requires="ChanServ" uline="yes">
 752 <alias text="NS" replace="PRIVMSG NickServ :" requires="NickServ" uline="yes">
 753 <alias text="CS" replace="PRIVMSG ChanServ :" requires="ChanServ" uline="yes">
 754
 755 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#- YAWN  -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 756 #                                                                     #
 757 #   You should already know what to do here :)                        #
 758
 759 <die value="You should probably edit your config *PROPERLY* and try again.">
 760
 761
 762 #########################################################################
 763 #                                                                       #
 764 #                -InspIRCd Development and Coding Team-                 #
 765 #                          www.inspircd.org                             #
 766 #                                                                       #
 767 #########################################################################