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