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