docs/inspircd.conf.example

   1 ########################################################################
   2 #                                                                      #
   3 #               ___                ___ ____   ____    _                #
   4 #              |_ _|_ __  ___ _ __|_ _|  _ \ / ___|__| |               #
   5 #               | || '_ \/ __| '_ \| || |_) | |   / _` |               #
   6 #               | || | | \__ \ |_) | ||  _ <| |__| (_| |               #
   7 #              |___|_| |_|___/ .__/___|_| \_\\____\__,_|               #
   8 #                            |_|                                       #
   9 #      ____             __ _                       _   _               #
  10 #     / ___|___  _ __  / _(_) __ _ _   _ _ __ __ _| |_(_) ___  _ __    #
  11 #    | |   / _ \| '_ \| |_| |/ _` | | | | '__/ _` | __| |/ _ \| '_ \   #
  12 #    | |__| (_) | | | |  _| | (_| | |_| | | | (_| | |_| | (_) | | | |  #
  13 #     \____\___/|_| |_|_| |_|\__, |\__,_|_|  \__,_|\__|_|\___/|_| |_|  #
  14 #                            |___/                                     #
  15 #                                                                      #
  16 ##################################||####################################
  17                                  #||#
  18 ##################################||####################################
  19 #                                                                      #
  20 #         This is an example of the config file for InspIRCd.          #
  21 #             Change the options to suit your network                  #
  22 #                                                                      #
  23 #                 Last updated on : 09/01/2006                         #
  24 #                 Written by      : CC  (cc@backchat.co.za)            #
  25 #                 Updated by      : katsklaw (katsklaw@gmail.com)      #
  26 #                 Updated by      : brain (brain@inspircd.org)         #
  27 #                                                                      #
  28 #    ____                _   _____ _     _       ____  _ _   _         #
  29 #   |  _ \ ___  __ _  __| | |_   _| |__ (_)___  | __ )(_) |_| |        #
  30 #   | |_) / _ \/ _` |/ _` |   | | | '_ \| / __| |  _ \| | __| |        #
  31 #   |  _ <  __/ (_| | (_| |   | | | | | | \__ \ | |_) | | |_|_|        #
  32 #   |_| \_\___|\__,_|\__,_|   |_| |_| |_|_|___/ |____/|_|\__(_)        #
  33 #                                                                      #
  34 #   Lines prefixed with READ THIS BIT, as shown above, are IMPORTANT   #
  35 #   lines, and you REALLY SHOULD READ THEM. Yes, THIS MEANS YOU. Even  #
  36 #   if you've configured InspIRCd before, these probably indicate      #
  37 #   something new or different to this version and you SHOULD READ IT. #
  38 #                                                                      #
  39 ########################################################################
  40
  41
  42
  43 #-#-#-#-#-#-#-#-#-#-#-#-  SERVER DESCRIPTION  -#-#-#-#-#-#-#-#-#-#-#-#-
  44 #                                                                     #
  45 #   Here is where you enter the information about your server.        #
  46 #                                                                     #
  47 #  Syntax is as follows:                                              #
  48 #                                                                     #
  49 #     <server name="server.name"                                      #
  50 #      description="Server Description"                               #
  51 #      network="MyNetwork">                                           #
  52 #                                                                     #
  53
  54 <server name="penguin.omega.org.za"
  55         description="Waddle World"
  56         network="Omega">
  57
  58
  59 #-#-#-#-#-#-#-#-#-#-#-#-   ADMIN INFORMATION   -#-#-#-#-#-#-#-#-#-#-#-#
  60 #                                                                     #
  61 #   Describes the Server Administrator's real name, nick              #
  62 #   and email address.                                                #
  63 #                                                                     #
  64 #  Syntax is as follows:                                              #
  65 #       <admin name="real name"                                       #
  66 #              nick="nick name"                                       #
  67 #              email="email@address.com">                             #
  68 #                                                                     #
  69
  70 <admin  name="Johnny English"
  71         nick="MI5"
  72         email="MI5@the.best.secret.agent">
  73
  74
  75 #-#-#-#-#-#-#-#-#-#-#-#-   PORT CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-
  76 #                                                                     #
  77 #   Enter the port and address bindings here.                         #
  78 #                                                                     #
  79 #  bind address - specifies which the address which ports bind        #
  80 #  port         - opens an unused port                                #
  81 #  type         - can be 'clients' or 'servers'. The clients type is  #
  82 #                 a standard tcp based socket, the servers type is a  #
  83 #                 also a TCP based connection but of a different      #
  84 #                 format.                                             #
  85 #    ____                _   _____ _     _       ____  _ _   _        #
  86 #   |  _ \ ___  __ _  __| | |_   _| |__ (_)___  | __ )(_) |_| |       #
  87 #   | |_) / _ \/ _` |/ _` |   | | | '_ \| / __| |  _ \| | __| |       #
  88 #   |  _ <  __/ (_| | (_| |   | | | | | | \__ \ | |_) | | |_|_|       #
  89 #   |_| \_\___|\__,_|\__,_|   |_| |_| |_|_|___/ |____/|_|\__(_)       #
  90 #                                                                     #
  91 #  If you want to link servers to InspIRCd you must load the          #
  92 #  m_spanningtree module! Please see the modules list below for       #
  93 #  information on how to load this module! If you do not load this    #
  94 #  module, server ports will NOT be bound!                            #
  95 #                                                                     #
  96 #  Leaving address empty binds to all available interfaces            #
  97 #                                                                     #
  98 #  Syntax is as follows:                                              #
  99 #                                                                     #
 100 # <bind address="ip number" port="port" type="clients">               #
 101 # <bind address="ip number" port="port" type="servers">               #
 102 #                                                                     #
 103
 104 <bind address="" port="6660" type="clients">
 105 <bind address="" port="7000" type="servers">
 106 <bind address="" port="7001" type="servers">
 107
 108
 109 #-#-#-#-#-#-#-#-#-#-  DIE/RESTART CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-
 110 #                                                                     #
 111 #   You can configure the passwords here which you wish to use for    #
 112 #   the die and restart commands. Only trusted ircops who will        #
 113 #   need this ability should know the die and restart password.       #
 114 #                                                                     #
 115 #  Syntax is as follows:                                              #
 116 #       <power diepass="die password" restartpass="restart password"  #
 117 #        pause="secs before dying">                                   #
 118 #                                                                     #
 119
 120 <power diepass="diepass" restartpass="restartpass" pause="2">
 121
 122
 123 #-#-#-#-#-#-#-#-#-#  INCLUDE CONFIGURATION  #-#-#-#-#-#-#-#-#-#-#-#-#-#
 124 #                                                                     #
 125 # This optional tag allows you to include another config file         #
 126 # allowing you to keep your configuration tidy. The configuration     #
 127 # file you include will be treated as part of the configuration file  #
 128 # which includes it, in simple terms the inclusion is transparent.    #
 129 #                                                                     #
 130 # All paths to config files are relative to the directory of the main #
 131 # config file inspircd.conf, unless the filename starts with a forward#
 132 # slash (/) in which case it is treated as an absolute path.          #
 133 #                                                                     #
 134 # Syntax is as follows:                                               #
 135 #       <include file="file.conf">                                    #
 136 #                                                                     #
 137
 138 #-#-#-#-#-#-#-#-#-#-  CONNECTIONS CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#
 139 #                                                                     #
 140 #   This is where you can configure which connections are allowed     #
 141 #   and denied access onto your server.                               #
 142 #   The password is optional.                                         #
 143 #   You may have as many of these as you require.                     #
 144 #   To allow/deny all connections use a *                             #
 145 #                                                                     #
 146 #  Syntax is as follows:                                              #
 147 #                                                                     #
 148 #       <connect allow="ip mask">                                     #
 149 #       <connect allow="ip mask" password="blahblah">                 #
 150 #       <connect allow="ip mask" password="blah" timeout="10">        #
 151 #       <connect allow="ip mask" timeout="blah" flood="5">            #
 152 #       <connect allow="ip mask" threshold="8" pingfreq="120">        #
 153 #       <connect allow="ip mask" sendq="99999" revcq="696969">        #
 154 #       <connect allow="ip mask" maxlocal="3" maxglobal="3">          #
 155 #       <connect deny="ip mask">                                      #
 156 #                                                                     #
 157 #   You may optionally include timeout="x" on any allow line, which   #
 158 #   specifies the amount of time given before an unknown connection   #
 159 #   is closed if USER/NICK/PASS are not given. This value is in secs  #
 160 #                                                                     #
 161 #   You should also include a flood="x" line which indicates          #
 162 #   the number of lines a user may place into their buffer at once    #
 163 #   before they are disconnected for excess flood. The default is to  #
 164 #   DISABLE this feature. A recommended value is 10. A counter is     #
 165 #   maintained for each user which is reset every 'threshold' seconds #
 166 #   and specifying this threshold value with threshold="X" indicates  #
 167 #   how often the counter is reset. For example, with flood="5" and   #
 168 #   threshold="8", the user may not send more than 5 lines in 8 secs. #
 169 #                                                                     #
 170 #   You may optionally specify the sendq size and ping frequency of   #
 171 #   each connect:allow line using the pingfreq="X" and sendq="X"      #
 172 #   settings as shown in the full example below.                      #
 173 #   The ping frequency is specified in seconds, and the sendq size    #
 174 #   in bytes. It is recommended, although not enforced, that you      #
 175 #   should never set your sendq size to less than 8k. Send Queues are #
 176 #   dynamically allocated and can grow as needed up to the maximum    #
 177 #   size specified.                                                   #
 178 #                                                                     #
 179 #   The optional recvq value is the maximum size which users in this  #
 180 #   group may grow their receive queue to. This is recommended to be  #
 181 #   kept pretty low compared to the sendq, as users will always       #
 182 #   recieve more than they send in normal circumstances. The default  #
 183 #   if not specified is 4096.                                         #
 184 #                                                                     #
 185 #   IMPORTANT NOTE, CALL THE CONFUSION POLICE!                        #
 186 #   The sendq is the data waiting to be sent TO THE USER.             #
 187 #   The recvq is the data being received FROM THE USER.               #
 188 #   The names sendq and recvq are from the SERVER'S PERSPECTIVE not   #
 189 #   that of the user... Just to clear up any confusion or complaints  #
 190 #   that these are backwards :p                                       #
 191 #                                                                     #
 192 #   The maxlocal and maxglobal values can be used to enforce local    #
 193 #   and global session limits on connections. The session limits are  #
 194 #   counted against all users, but applied only to users within the   #
 195 #   class. For example, if you had a class 'A' which has a session    #
 196 #   limit of 3, and a class 'B' which has a session limit of 5, and   #
 197 #   somehow, two users managed to get into class B which also match   #
 198 #   class A, there is only one connection left for this IP now in A,  #
 199 #   but if they can connect again to B, there are three. You get the  #
 200 #   idea (i hope).                                                    #
 201 #                                                                     #
 202
 203 <connect allow="196.12.*"  password="secret">
 204 <connect allow="*" timeout="60" flood="10" threshold="60" pingfreq="120" sendq="262144" recvq="4096" maxlocal="3" maxglobal="3">
 205
 206 <connect deny="69.254.*">
 207
 208
 209 #-#-#-#-#-#-#-#-#-#-#-#-  CLASS CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-
 210 #                                                                     #
 211 #   Classes are a group of commands which are grouped together        #
 212 #   and given a unique name. They used to define which commands       #
 213 #   are available to certain types of Operators.                      #
 214 #                                                                     #
 215 #  Syntax is as follows:                                              #
 216 #                                                                     #
 217 #       <class name="name" commands="oper commands">                  #
 218 #                                                                     #
 219 #    ____                _   _____ _     _       ____  _ _   _        #
 220 #   |  _ \ ___  __ _  __| | |_   _| |__ (_)___  | __ )(_) |_| |       #
 221 #   | |_) / _ \/ _` |/ _` |   | | | '_ \| / __| |  _ \| | __| |       #
 222 #   |  _ <  __/ (_| | (_| |   | | | | | | \__ \ | |_) | | |_|_|       #
 223 #   |_| \_\___|\__,_|\__,_|   |_| |_| |_|_|___/ |____/|_|\__(_)       #
 224 #                                                                     #
 225 #  You are not forced to give these classes the names given below.    #
 226 #  You can create your own named classes, if you want, in fact that   #
 227 #  is the whole idea of this system!                                  #
 228 #                                                                     #
 229
 230 <class name="Shutdown" commands="DIE RESTART REHASH">
 231 <class name="ServerLink" commands="CONNECT SQUIT">
 232 <class name="BanControl" commands="KILL GLINE KLINE ZLINE QLINE ELINE">
 233 <class name="OperChat" commands="WALLOPS GLOBOPS">
 234 <class name="HostCloak" commands="SETHOST SETIDENT SETNAME">
 235
 236
 237 #-#-#-#-#-#-#-#-#-#-#-#-  OPERATOR COMPOSITION   -#-#-#-#-#-#-#-#-#-#-#
 238 #                                                                     #
 239 #   This is where you specify which types of operators you have on    #
 240 #   your server, as well as the commands they are allowed to use.     #
 241 #   This works alongside with the classes specified above.            #
 242 #                                                                     #
 243 #  type name  - a name for the combined class types                   #
 244 #                                                                     #
 245 #  classes    - specified above, used for flexibility for the         #
 246 #               server admin to decide on which operators get         #
 247 #               what commands                                         #
 248 #                                                                     #
 249 #  host       - optional hostmask operators will recieve on oper-up.  #
 250 #                                                                     #
 251 #  Syntax is as follows:                                              #
 252 #                                                                     #
 253 #       <type name="name" classes="class name" host="oper hostmask">  #
 254 #                                                                     #
 255 #    ____                _   _____ _     _       ____  _ _   _        #
 256 #   |  _ \ ___  __ _  __| | |_   _| |__ (_)___  | __ )(_) |_| |       #
 257 #   | |_) / _ \/ _` |/ _` |   | | | '_ \| / __| |  _ \| | __| |       #
 258 #   |  _ <  __/ (_| | (_| |   | | | | | | \__ \ | |_) | | |_|_|       #
 259 #   |_| \_\___|\__,_|\__,_|   |_| |_| |_|_|___/ |____/|_|\__(_)       #
 260 #                                                                     #
 261 #  You are not forced to give these types the names given below.      #
 262 #  You can create your own named types, if you want, in fact that     #
 263 #  is the whole idea of this system!                                  #
 264 #                                                                     #
 265
 266 <type name="NetAdmin" classes="OperChat BanControl HostCloak Shutdown ServerLink" host="netadmin.omega.org.za">
 267 <type name="GlobalOp" classes="OperChat BanControl HostCloak ServerLink" host="ircop.omega.org.za">
 268 <type name="Helper" classes="HostCloak" host="helper.omega.org.za">
 269
 270
 271 #-#-#-#-#-#-#-#-#-#-#-  OPERATOR CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#
 272 #                                                                     #
 273 #   Opers are defined here. This is a very important section.         #
 274 #   Remember to only make operators out of truthworthy people.        #
 275 #                                                                     #
 276 #  name      - oper name, best to use lower-case                      #
 277 #                                                                     #
 278 #  password  - password to oper-up,                                   #
 279 #              encryption not supported by inspircd. However, there   #
 280 #              are modules that allow for oper password encryption.   #
 281 #                                                                     #
 282 #  host      - host of client allowed to oper-up.                     #
 283 #              wildcards accepted                                     #
 284 #                                                                     #
 285 #  type      - specified above, defines the kind of operator          #
 286 #                                                                     #
 287 #  Syntax is as follows:                                              #
 288 #       <oper name="login"                                            #
 289 #             password="pass"                                         #
 290 #             host="hostmask@of.oper"                                 #
 291 #             type="oper type">                                       #
 292 #                                                                     #
 293
 294 <oper   name="katsklaw"
 295         password="s3cret"
 296         host="*@*"
 297         type="NetAdmin">
 298
 299
 300 #-#-#-#-#-#-#-#-#-#-#-  SERVER LINK CONFIGURATION  -#-#-#-#-#-#-#-#-#-#
 301 #                                                                     #
 302 # Defines which servers can link to this one, and which servers this  #
 303 # server may create outbound links to.                                #
 304 #                                                                     #
 305 # name        -   The name is the canocial name of the server, does   #
 306 #                 not have to resolve - but it is expected to be sent #
 307 #                 in the remote servers connection info.              #
 308 # ipaddr      -   Valid host or ip address for remote server. *       #
 309 #                                                                     #
 310 # port        -   The TCP port for the remote server.                 #
 311 #                                                                     #
 312 # sendpass    -   Password to send to create an outbound connection   #
 313 #                 to this server.                                     #
 314 #                                                                     #
 315 # recvpass    -   Password to receive to accept an inbound connection #
 316 #                 from this server.                                   #
 317 #                                                                     #
 318 # autoconnect -   Sets the server to autoconnect. Where x is the num. #
 319 # (optional)      of seconds between attempts. e.g. 300 = 5 minutes.  #
 320 #                                                                     #
 321 # encryptionkey - Encryption key to be used for AES encryption, where #
 322 #                 supported. Links using the spanning tree protocol   #
 323 #                 support AES. The encryption key must be EXACTLY 8,  #
 324 #                 16 or 32 characters in length for a 64, 128 or 256  #
 325 #                 bit key, respectively.                              #
 326 #                                                                     #
 327 # hidden        - When using m_spanningtree.so for linking. you may   #
 328 #                 set this to 'yes', and if you do, the IP address/   #
 329 #                 hostname of this connection will NEVER be shown to  #
 330 #                 any opers on the network. In /STATS c its address   #
 331 #                 will show as *@<hidden>, and during CONNECT and     #
 332 #                 inbound connections, its IP will show as <hidden>   #
 333 #                 UNLESS the connection fails (e.g. due to a bad      #
 334 #                 password or servername)                             #
 335 #                                                                     #
 336 # to u:line a server (give it extra privilages required for running   #
 337 # services, Q, etc) you must include the <uline server> tag as shown  #
 338 # in the example below. You can have as many of these as you like.    #
 339 #                                                                     #
 340 # WARNING: Unlike other ircds, u:lining a server allows ALL users on  #
 341 # that server to operoverride modes. This should only be used for     #
 342 # services and protected oper servers!                                #
 343 #                                                                     #
 344 # IMPORTANT NOTE: When specifying the ip address and/or host, the     #
 345 # server software will prioritize RESOLVED hostnames above ip         #
 346 # addresses, so for example if your target server resolves to a.b.com #
 347 # you MUST put a.b.com into your link block, and NOT the IP address   #
 348 # of a.b.com. The system uses reverse resolution.                     #
 349 #                                                                     #
 350 #    ____                _   _____ _     _       ____  _ _   _        #
 351 #   |  _ \ ___  __ _  __| | |_   _| |__ (_)___  | __ )(_) |_| |       #
 352 #   | |_) / _ \/ _` |/ _` |   | | | '_ \| / __| |  _ \| | __| |       #
 353 #   |  _ <  __/ (_| | (_| |   | | | | | | \__ \ | |_) | | |_|_|       #
 354 #   |_| \_\___|\__,_|\__,_|   |_| |_| |_|_|___/ |____/|_|\__(_)       #
 355 #                                                                     #
 356 #  If you want to link servers to InspIRCd you must load the          #
 357 #  m_spanningtree module! Please see the modules list below for       #
 358 #  information on how to load this module! If you do not load this    #
 359 #  module, server links will NOT work!                                #
 360 #                                                                     #
 361
 362 <link name="hub.penguin.org"
 363         ipaddr="penguin.box.com"
 364         port="7000"
 365         autoconnect="300"
 366         sendpass="outgoing!password"
 367         recvpass="incoming!password">
 368
 369 <link name="services.antarctic.com"
 370         ipaddr="localhost"
 371         port="7000"
 372         sendpass="penguins"
 373         recvpass="polarbears">
 374
 375 <uline server="services.antarctic.com">
 376
 377
 378 #-#-#-#-#-#-#-#-#-#-  MISCELLANEOUS CONFIGURATION  -#-#-#-#-#-#-#-#-#-#
 379 #                                                                     #
 380 #   These options let you define the path to your motd and rules      #
 381 #   files.                                                            #
 382 #                                                                     #
 383
 384 <files  motd="/home/cc/inspircd/conf/inspire.motd"
 385         rules="/home/cc/inspircd/conf/inspire.rules">
 386
 387 #-#-#-#-#-#-#-#-#-#-#-#-#-#-# DNS SERVER -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 388 #                                                                     #
 389 # Define your DNS server address here. InspIRCd has its own resolver  #
 390 # and you must define this otherwise nobody's host will resolve. The  #
 391 # timeout value is in seconds.                                        #
 392 #                                                                     #
 393 #    ____                _   _____ _     _       ____  _ _   _        #
 394 #   |  _ \ ___  __ _  __| | |_   _| |__ (_)___  | __ )(_) |_| |       #
 395 #   | |_) / _ \/ _` |/ _` |   | | | '_ \| / __| |  _ \| | __| |       #
 396 #   |  _ <  __/ (_| | (_| |   | | | | | | \__ \ | |_) | | |_|_|       #
 397 #   |_| \_\___|\__,_|\__,_|   |_| |_| |_|_|___/ |____/|_|\__(_)       #
 398 #                                                                     #
 399 # When choosing a server, be sure to choose one which will do a       #
 400 # RECURSIVE LOOKUP. InspIRCd's resolver does not currently do these   #
 401 # recursive lookups itself, to save time and resources. The dns       #
 402 # server recommended by the InspIRCd team is bind, available from the #
 403 # ISC website. If your DNS server does not do a recursive lookup, you #
 404 # will be able to notice this by the fact that none of your users are #
 405 # resolving even though the DNS server appears to be up! Most ISP and #
 406 # hosting provider DNS servers support recursive lookups.             #
 407 #                                                                     #
 408
 409 <dns server="127.0.0.1" timeout="5">
 410
 411 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#  PID FILE  -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 412 #                                                                     #
 413 # Define the path to the PID file here. The PID file can be used to   #
 414 # rehash the ircd from the shell or to terminate the ircd from the    #
 415 # shell using shell scripts, perl scripts etc, and to monitor the     #
 416 # ircd's state via cron jobs.                                         #
 417 #                                                                     #
 418
 419 <pid file="/path/to/inspircd.pid">
 420
 421 #-#-#-#-#-#-#-#-#-#-#-#-#- BANLIST LIMITS #-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 422 #                                                                     #
 423 # Use these tags to customise the ban limits on a per channel basis.  #
 424 # the tags are read from top to bottom, and any tag found which       #
 425 # matches the channels name applies the banlimit to that channel.     #
 426 # It is advisable to put an entry with the channel as '*' at the      #
 427 # bottom of the list. If none are specified or no maxbans tag is      #
 428 # matched, the banlist size defaults to 64 entries.                   #
 429 #                                                                     #
 430
 431 <banlist chan="#morons" limit="128">
 432 <banlist chan="*" limit="69">
 433
 434 #-#-#-#-#-#-#-#-#-#-#-  DISABLED COMMANDS  -#-#-#-#-#-#-#-#-#-#-#-#-#-#
 435 #                                                                     #
 436 # This tag is optional, and specifies one or more commands which are  #
 437 # not available to non-operators. For example you may wish to disable #
 438 # NICK and prevent non-opers from changing their nicknames.           #
 439 # Note that any disabled commands take effect only after the user has #
 440 # 'registered' (e.g. after the initial USER/NICK/PASS on connection)  #
 441 # so for example disabling NICK will not cripple your network.        #
 442 #                                                                     #
 443 #         <disabled commands="TOPIC MODE">                            #
 444 #                                                                     #
 445
 446
 447 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-  RTFM LINE  -#-#-#-#-#-#-#-#-#-#-#-#-#-#
 448 #                                                                     #
 449 #   Just remove this... Its here to make you read ALL of the config   #
 450 #   file options ;)                                                   #
 451
 452 <die value="You should probably edit your config *PROPERLY* and try again.">
 453
 454
 455
 456 #-#-#-#-#-#-#-#-#-#-#-#-#-  SERVER OPTIONS   -#-#-#-#-#-#-#-#-#-#-#-#-#
 457 #                                                                     #
 458 #   Settings to define which features are useable on your server.     #
 459 #                                                                     #
 460 #  prefixquit    - a prefix for a client's quit message               #
 461 #                                                                     #
 462 #  loglevel      - specifies what detail of messages to log in the    #
 463 #                  log file. You may select from debug, verbose,      #
 464 #                  default, sparse and none.                          #
 465 #  allowhalfop   - allows the +h channel mode                         #
 466 #                                                                     #
 467 #  noservices    - If noservices is true, yes, or 1, then the first   #
 468 #                  user into a channel gets founder status. This is   #
 469 #                  only useful on networks running the m_chanprotect  #
 470 #                  module without services.                           #
 471 #                                                                     #
 472 #  netbuffersize - size of the buffer used to receive data from       #
 473 #                  clients. The ircd may only read() this amount      #
 474 #                  of text in one go at any time. (OPTIONAL)          #
 475 #                                                                     #
 476 #  maxwho        - The maximum number of results returned by a /WHO   #
 477 #                  query. This is to prevent /WHO being used as a     #
 478 #                  spam vector or means of flooding an ircd. The      #
 479 #                  default is 128, it is not recommended to raise it  #
 480 #                  above 1024. Values up to 65535 are permitted.      #
 481 #                                                                     #
 482 #  somaxconn     - The maximum number of sockets that may be waiting  #
 483 #                  in the accept queue. This usually allows the ircd  #
 484 #                  to soak up more connections in a shorter space of  #
 485 #                  time when increased but please be aware there is a #
 486 #                  system defined maximum value to this, the same way #
 487 #                  there is a system defined maximum number of file   #
 488 #                  descriptors. Some systems may only allow this to   #
 489 #                  be up to 5 (ugh) while others such as FreeBSD will #
 490 #                  default to a much nicer 128.                       #
 491 #                                                                     #
 492 #  moduledir     - This optional value indicates a runtime change of  #
 493 #                  the location where modules are to be found. This   #
 494 #                  does not add a supplementary directory. There can  #
 495 #                  only be one module path.                           #
 496 #                                                                     #
 497 #  softlimit     - This optional feature allows a defined softlimit.  #
 498 #                  if defined sets a soft maxconnections value, has   #
 499 #                  to be less than the ./configure maxclients         #
 500 #                                                                     #
 501 #  operonlystats - The operonlystats field is optional and specifies  #
 502 #                  which stats characters in /STATS may only be       #
 503 #                  requested by an IRC operator. Stats characters in  #
 504 #                  this field are case sensitive and enforced as      #
 505 #                  oper-only independent of if they are in a module   #
 506 #                  or the core.                                       #
 507 #                                                                     #
 508 #  customversion - If you specify this configuration item, and it is  #
 509 #                  not set to an empty value, then when a user does   #
 510 #                  a /VERSION command on the ircd, this string will   #
 511 #                  be displayed as the second portion of the output,  #
 512 #                  replacing the system 'uname', compile flags and    #
 513 #                  socket engine/dns engine names. You may use this   #
 514 #                  to enhance security, or simply for vanity.         #
 515 #                                                                     #
 516 #  maxtargets    - The maxtargets field is optional, and if not       #
 517 #                  defined, defaults to 20. It indicates the maximum  #
 518 #                  number of targets which may be given to commands   #
 519 #                  such as PRIVMSG, KICK etc.                         #
 520 #                                                                     #
 521 #  hidesplits    - When set to 'yes', will hide split server names    #
 522 #                  from non-opers. Non-opers will see '*.net *.split' #
 523 #                  instead of the server names in the quit message,   #
 524 #                  identical to the way IRCu displays them.           #
 525 #                                                                     #
 526
 527 <options prefixquit="Quit: "
 528          loglevel="default"
 529          netbuffersize="10240"
 530          maxwho="128"
 531          noservices="0"
 532          somaxconn="128"
 533          softlimit="128"
 534          operonlystats="oclgkz"
 535          customversion=""
 536          maxtargets="20"
 537          hidesplits="no"
 538          allowhalfop="yes">
 539
 540
 541
 542 #-#-#-#-#-#-#-#-#-#-#-#-#-  MODULE OPTIONS   -#-#-#-#-#-#-#-#-#-#-#-#-#
 543 #                                                                     #
 544 #  These tags define which modules will be loaded on startup by your  #
 545 #  server. Add modules without any paths. When you make your ircd     #
 546 #  using the 'make' command, all compiled modules will be moved into  #
 547 #  the folder you specified when you ran ./configure. The module tag  #
 548 #  automatically looks for modules in this location.                  #
 549 #  If you attempt to load a module outside of this location, either   #
 550 #  in the config, or via /LOADMODULE, you will receive an error.      #
 551 #                                                                     #
 552 #  By default, ALL modules are commented out. You must uncomment them #
 553 #  or add lines to your config to load modules. Please refer to       #
 554 #  http://www.inspircd.org/wiki/Modules_List for a list of modules and#
 555 #  each modules link for any additional conf tags they require.       #
 556 #                                                                     #
 557 #  WINDOWS USERS PLEASE NOTE: You can still load these modules! They  #
 558 #  are incorporated into the executable and can be loaded and removed #
 559 #  similarly to if they were in a ramdisk.                            #
 560 #    ____                _   _____ _     _       ____  _ _   _        #
 561 #   |  _ \ ___  __ _  __| | |_   _| |__ (_)___  | __ )(_) |_| |       #
 562 #   | |_) / _ \/ _` |/ _` |   | | | '_ \| / __| |  _ \| | __| |       #
 563 #   |  _ <  __/ (_| | (_| |   | | | | | | \__ \ | |_) | | |_|_|       #
 564 #   |_| \_\___|\__,_|\__,_|   |_| |_| |_|_|___/ |____/|_|\__(_)       #
 565 #                                                                     #
 566 # To link servers to InspIRCd, you MUST load the m_spanningtree       #
 567 # module, as shown below. If you DO NOT do this, server links will    #
 568 # NOT work at all. ie. The ports will NOT bind, and /connect will not #
 569 # work properly. This is by design, to allow for the implementation   #
 570 # of other linking protocols in modules in the future.                #
 571
 572 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 573 # Spanning Tree module - allows linking of servers using the spanning
 574 # tree protocol (see the READ THIS BIT section above).
 575 #
 576 #<module name="m_spanningtree.so">
 577
 578 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 579 # Alias module: Allows you to define server-side command aliases
 580 #<module name="m_alias.so">
 581 #
 582 #-#-#-#-#-#-#-#-#-#-#-  ALIAS DEFINITIONS  -#-#-#-#-#-#-#-#-#-#-#-#-#-#
 583 #                                                                     #
 584 # If you have the m_alias.so module loaded, you may also define       #
 585 # aliases as shown below. They are commonly used to provide shortcut  #
 586 # commands to services, however they are not limited to jsut this use.#
 587 # An alias tag requires the following values to be defined in it:     #
 588 #                                                                     #
 589 # text        -      The text to detect at the start of the line,     #
 590 #                    must be at the start of the line to trigger the  #
 591 #                    alias. May contain spaces, but case insensitive. #
 592 # replace     -      The text to replace 'text' with. Usually this    #
 593 #                    will be "PRIVMSG ServiceName" or similar.        #
 594 # requires    -      If you provide a value for 'requires' this means #
 595 #                    the given nickname MUST be online for the alias  #
 596 #                    to successfully trigger. If they are not, then   #
 597 #                    the user receives a 'no such nick' 401 numeric.  #
 598 # uline       -      Defining this value with 'yes', 'true' or '1'    #
 599 #                    will ensure that the user given in 'requires'    #
 600 #                    must also be on a u-lined server, as well as     #
 601 #                    actually being on the network. If the user is    #
 602 #                    online, but not on a u-lined server, then an     #
 603 #                    oper-alert is sent out as this is possibly signs #
 604 #                    of a user trying to impersonate a service.       #
 605 #                                                                     #
 606 #<alias text="NICKSERV" replace="PRIVMSG NickServ" requires="NickServ" uline="yes">
 607 #<alias text="CHANSERV" replace="PRIVMSG ChanServ" requires="ChanServ" uline="yes">
 608 #<alias text="NS" replace="PRIVMSG NickServ" requires="NickServ" uline="yes">
 609 #<alias text="CS" replace="PRIVMSG ChanServ" requires="ChanServ" uline="yes">
 610
 611 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 612 # Antibottler module: Labels bottler leech bots
 613 #<module name="m_antibottler.so">
 614
 615 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 616 # Ban except module: Adds support for channel ban exceptions (+e)
 617 #<module name="m_banexception.so">
 618
 619 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 620 # Block colour module: Blocking colour-coded messages with cmode +c
 621 #<module name="m_blockcolor.so">
 622
 623 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 624 # Botmode module: Adds the user mode +B
 625 #<module name="m_botmode.so">
 626
 627 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 628 # CBAN module: Lets you disallow channels from being used at runtime.
 629 #<module name="m_cban.so">
 630
 631 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 632 # Censor module: Adds the channel mode +G
 633 #<module name="m_censor.so">
 634 #
 635 #-#-#-#-#-#-#-#-#-#-#-  CENSOR  CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#-#
 636 #                                                                     #
 637 # Optional - If you specify to use the m_censor module, then specfiy  #
 638 # below the path to the censor.conf file. See also:                   #
 639 # Censor file, see http://www.inspircd.org/wiki/Censor_Module         #
 640 #
 641 #<censor file="/path/to/censor.conf">
 642
 643 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 644 # Channel filter module: Allows channel-op defined message
 645 # filtering using simple string matches (channel mode +g)
 646 #<module name="m_chanfilter.so">
 647
 648 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 649 # Chanprotect module: gives +q and +a channel modes
 650 #<module name="m_chanprotect.so">
 651
 652 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 653 # CHGHOST module: Adds the /CHGHOST command
 654 #<module name="m_chghost.so">
 655
 656 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 657 # CHGIDENT module: Adds the /CHGIDENT command
 658 #<module name="m_chgident.so">
 659
 660 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 661 # Cloaking module: Adds usermode +x and cloaking support
 662 #<module name="m_cloaking.so">
 663
 664 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 665 # Conn-Lusers: Shows the LUSERS output on connect
 666 #<module name="m_conn_lusers.so">
 667
 668 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 669 # Conn-Wait-for-Pong: Don't let a user connect until they PONG
 670 #<module name="m_conn_waitpong.so">
 671
 672 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 673 # Deny Channels: Deny Channels from being used by users
 674 #<module name="m_denychans.so">
 675 #
 676 #-#-#-#-#-#-#-#-#-#-#-   DENYCHAN DEFINITIONS  -#-#-#-#-#-#-#-#-#-#-#-#
 677 #                                                                     #
 678 # If you have the m_denychans.so module loaded, you need to specify   #
 679 # the channels to deny:
 680 #                                                                     #
 681 # name        -      The channel name to deny.                        #
 682 # allowopers  -      If operators are allowed to override the deny.   #
 683 # reason      -      Reason given for the deny.                       #
 684 #
 685 #<badchan name="#gods" allowopers="yes" reason="Tortoises!">
 686
 687 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 688 # Devoice Module: Let users devoice themselves.
 689 #<module name="m_devoice.so">
 690
 691 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 692 # Filter module: Provides glob-based message filtering
 693 #<module name="m_filter.so">
 694 #OR
 695 # PCRE filter module: Filters messages using regular expressions
 696 #<module name="m_filter_pcre.so">
 697 #
 698 #-#-#-#-#-#-#-#-#-#-#-  FILTER  CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#-#
 699 #                                                                     #
 700 # Optional - If you specify to use the m_filter or m_filter_pcre      #
 701 # modules, then specfiy below the path to the filter.conf file.       #
 702 #
 703 #<filter file="/path/to/inspircd/filter.conf">
 704
 705 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 706 # Foobar module - does nothing - historical relic
 707 #<module name="m_foobar.so">
 708
 709 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 710 # Globops module: gives /GLOBOPS and usermode +g
 711 #<module name="m_globops.so">
 712
 713 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 714 # HELPOP module: Provides the /HELPOP command
 715 #<module name="m_helpop.so">
 716 #
 717 #-#-#-#-#-#-#-#-#-#-#-#-  HELPOP  CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#
 718 #                                                                     #
 719 # Optional - If you specify to use the m_helpop.so module, then       #
 720 # specify below the path to the helpop.conf file.                     #
 721 #
 722 #<helpop file="/path/to/inspircd/helpop.conf">
 723
 724 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 725 # Hostchange module: Allows a different style of cloaking
 726 #<module name="m_hostchange.so">
 727 #
 728 #-#-#-#-#-#-#-#-#-#-#-  HOSTCHANGE  CONFIGURATION  -#-#-#-#-#-#-#-#-#-#
 729 #                                                                     #
 730 # Optional - If you choose to use the m_hostchange.so module.         #
 731 # Config Help -  See http://www.inspircd.org/wiki/Host_Changer_Module #
 732 #
 733 #<host suffix="polarbears.org">
 734 #<hostchange mask="*@fbi.gov" action="addnick">
 735 #<hostchange mask="*r00t@*" action="suffix">
 736 #<hostchange mask="a@b.com" action="set" value="blah.blah.blah">
 737
 738 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 739 # Ident: Provides RFC 1413 ident lookup support
 740 #<module name="m_ident.so">
 741 #
 742 #-#-#-#-#-#-#-#-#-#-#-#-   IDENT CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#
 743 #                                                                     #
 744 # Optional - If you are using the m_ident.so module, then you can     #
 745 # specify the timeout for ident lookups here. If not defined, it will #
 746 # default to one second. This is a non-blocking timeout which holds   #
 747 # the user in a 'connecting' state until the lookup is complete.      #
 748 #
 749 #<ident timeout="5">
 750
 751 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 752 # Invite except module: Adds support for channel invite exceptions (+I)
 753 #<module name="m_inviteexception.so">
 754
 755 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 756 # Join flood module: Adds support for join flood protection (+j)
 757 #<module name="m_joinflood.so">
 758
 759 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 760 # Anti-Auto-Rejoin: Adds support for prevention of auto-rejoin (+J)
 761 #<module name="m_kicknorejoin.so">
 762
 763 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 764 # Knock module: adds the /KNOCK command and +K channel mode
 765 #<module name="m_knock.so">
 766
 767 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 768 # Msg flood module: Adds message/notice flood protection (+f)
 769 #<module name="m_messageflood.so">
 770
 771 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 772 # Nicklock module: Let opers change a user's nick and then stop that
 773 # user from changing their nick again. /NICKLOCK and /NICKUNLOCK
 774 #<module name="m_nicklock.so">
 775
 776 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 777 # No ctcp module: Adds the channel mode +C to block CTCPs
 778 #<module name="m_noctcp.so">
 779
 780 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 781 # Noinvite module: Gives channel mode +V
 782 #<module name="m_noinvite.so">
 783
 784 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 785 # No kicks module: Adds the +Q channel mode
 786 #<module name="m_nokicks.so">
 787
 788 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 789 # No nicks module: Adds the +N channel mode
 790 #<module name="m_nonicks.so">
 791
 792 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 793 # No Notice module: adds the channel mode +T
 794 #<module name="m_nonotice.so">
 795
 796 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 797 # Oper channels mode: Adds the +O channel mode
 798 #<module name="m_operchans.so">
 799
 800 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 801 # Oper Join module: Forces opers to join a channel on oper-up
 802 #<module name="m_operjoin.so">
 803 #
 804 #-#-#-#-#-#-#-#-#-#-#   OPERJOIN CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#
 805 #                                                                     #
 806 # If you are using the m_operjoin.so module, specify the channel here #
 807 #
 808 #<operjoin channel="#channel">
 809
 810 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 811 # Oper MOTD module: Provides support for seperate message of the day
 812 # on oper-up
 813 #<module name="m_opermotd.so">
 814 #
 815 #-#-#-#-#-#-#-#-#-#-#   OPERMOTD CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#
 816 #                                                                     #
 817 # If you are using the m_opermotd.so module, specify the motd here    #
 818 #
 819 #<opermotd file="/path/to/oper.motd">
 820
 821 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 822 # Override module: Adds support for oper override
 823 #<module name="m_override.so">
 824 #
 825 #-#-#-#-#-#-#-#-#-#-#   OVERRIDE CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#
 826 #                                                                     #
 827 # m_override.so is too complex it describe here, see the wiki:        #
 828 # http://www.inspircd.org/wiki/Oper_Override_Module                   #
 829
 830 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 831 # Oper levels module: Gives each oper a level and prevents
 832 # actions being taken against higher level opers
 833 # Specify the level as the 'level' parameter of the <type> tag
 834 #<module name="m_operlevels.so">
 835
 836 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 837 # Oper MD5 module: Allows MD5 hashed oper passwords
 838 #<module name="m_opermd5.so">
 839
 840 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 841 # Oper SHA256 module: Allows SHA256 hashed oper passwords
 842 # This module is in src/modules/extra
 843 #<module name="m_opersha256.so">
 844
 845 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 846 # Oper modes module: Allows you to specify modes to add/remove on oper
 847 # Specify the modes as the 'modes' parameter of the <type> tag
 848 #<module name="m_opermodes.so">
 849
 850 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 851 # Parking module: Adds parking support and /PARK and /UNPARK
 852 #<module name="m_park.so">
 853 #
 854 #-#-#-#-#-#-#-#-#-#-#-#   PARK CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#
 855 #                                                                     #
 856 # m_park.so is too complex it describe here, see the wiki:            #
 857 # http://www.inspircd.org/wiki/User_Parking_Module                    #
 858
 859 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 860 # Random Quote module: provides a random quote on connect
 861 #<module name="m_randquote.so">
 862 #
 863 #-#-#-#-#-#-#-#-#-#-  RANDOMQUOTES CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
 864 #                                                                     #
 865 # Optional - If you specify to use the m_randquote.so module, then    #
 866 # specify below the path to the randquotes.conf file.                 #
 867 #
 868 #<randquote file="/path/to/inspircd/randquotes.conf">
 869
 870 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 871 # Redirect module: Adds channel redirection (mode +L)
 872 #<module name="m_redirect.so">
 873
 874 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 875 # Remove module: Adds the /REMOVE command which is a peaceful
 876 # alternative to /KICK
 877 #<module name="m_remove.so">
 878
 879 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 880 # Restricted channels module: Allows only opers to create channels
 881 #<module name="m_restrictchans.so">
 882
 883 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 884 # Restrict message module: Allows users to only message opers
 885 #<module name="m_restrictmsg.so">
 886
 887 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 888 # SAJOIN module: Adds the /SAJOIN command
 889 #<module name="m_sajoin.so">
 890
 891 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 892 # SAMODE module: Adds the oper /SAMODE command
 893 #<module name="m_samode.so">
 894
 895 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 896 # SANICK module: Allows opers to change user's nicks
 897 #<module name="m_sanick.so">
 898
 899 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 900 # SAPART module: Adds the oper /SAPART command
 901 #<module name="m_sapart.so">
 902
 903 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 904 # SAQUIT module: Adds the oper /SAQUIT command (abusable!!!)
 905 #<module name="m_saquit.so">
 906
 907 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 908 # Set Idle module: Adds a command for opers to change their
 909 # idle time (mainly a toy)
 910 #<module name="m_setidle.so">
 911
 912 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 913 # Services support module: Adds several usermodes such as +R and +M
 914 #<module name="m_services.so">
 915
 916 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 917 # Sethost module: Adds the /SETHOST command
 918 #<module name="m_sethost.so">
 919
 920 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 921 # Setident module: Adds the /SETIDENT command
 922 #<module name="m_setident.so">
 923
 924 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 925 # SETNAME module: Adds the /SETNAME command
 926 #<module name="m_setname.so">
 927
 928 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 929 # Show Whois module: Adds the +W usermode which allows opers
 930 # to see when they are whois'ed
 931 #<module name="m_showwhois.so">
 932
 933 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 934 # Spy module: Adds the commands SPYLIST and SPYNAMES that let opers
 935 # see who is in a +s channel, and list +s channels, show keys of keyed
 936 # channels the oper is not a member of etc. (standard 'abusive' features
 937 # of unrealircd, modulized here in InspIRCd).
 938 #<module name="m_spy.so">
 939
 940 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 941 # SSL channel mode module: Adds support for SSL-only channels (+z).
 942 # does not do anything useful without a working SSL module (see below)
 943 #<module name="m_sslmodes.so">
 944
 945 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 946 # GnuTLS ssl module: Adds support for client-server SSL using GnuTLS,
 947 # if enabled. You must copy the source for this module from the directory
 948 # src/modules/extra, or answer 'yes' in ./configure when asked if you
 949 # want to enable this, or it will not load.
 950 #<module name="m_ssl_gnutls.so">
 951 #
 952 #-#-#-#-#-#-#-#-#-#-#-  GNUTLS CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#
 953 #                                                                     #
 954 # m_ssl_gnutls.so is too complex it describe here, see the wiki:      #
 955 # http://www.inspircd.org/wiki/GnuTLS_SSL_Module                      #
 956
 957 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 958 # OpenSSL ssl module: Adds support for client-server SSL using OpenSSL,
 959 # if enabled. You must copy the source for this module from the directory
 960 # src/modules/extra, or answer 'yes' in ./configure when asked if you
 961 # want to enable this, or it will not load.
 962 #<module name="m_ssl_openssl.so">
 963 #
 964 #-#-#-#-#-#-#-#-#-#-#- OPENSSL CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#
 965 #                                                                     #
 966 # m_ssl_openssl.so is too complex it describe here, see the wiki:     #
 967 # http://www.inspircd.org/wiki/OpenSSL_SSL_Module                     #
 968
 969 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 970 # Strip colour module: Adds the channel mode +S
 971 #<module name="m_stripcolor.so">
 972
 973 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 974 # SILENCE module: Adds support for /SILENCE
 975 #<module name="m_silence.so">
 976
 977 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 978 # SQL module: Allows other SQL modules to access SQL databases
 979 # through a unified API. You must copy the source for this module
 980 # from the directory src/modules/extra
 981 #<module name="m_sql.so">
 982 #
 983 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#-#
 984 #                                                                     #
 985 # m_sql.so is more complex than described here, see the wiki for more:#
 986 # http://www.inspircd.org/wiki/SQL_Service_Provider_Module            #
 987 #
 988 #<database name="mydb" username="myuser" password="mypass" hostname="localhost" id="1">
 989
 990 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 991 # SQL authentication module: Allows IRCd connections to be tied into
 992 # a database table (for example a forum). You must copy the source for
 993 # this module from the directory src/modules/extra
 994 #<module name="m_sqlauth.so">
 995 #
 996 #-#-#-#-#-#-#-#-#-#-#- SQLAUTH CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#
 997 #                                                                     #
 998 # m_sqlauth.so is too complex it describe here, see the wiki:         #
 999 # http://www.inspircd.org/wiki/SQL_Authentication_Module              #
1000
1001 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1002 # SQL logging module: Allows you to log network-wide data for your
1003 # network in a fully normalized set of SQL tables. You must copy the
1004 # source for this module from the directory src/modules/extra
1005 #<module name="m_sqllog.so">
1006 #
1007 #-#-#-#-#-#-#-#-#-#-#-  SQLLOG CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#
1008 #                                                                     #
1009 # dbid       - Database ID to use (see m_sql)                         #
1010 #                                                                     #
1011 # See also: http://www.inspircd.org/wiki/SQL_Logging_Module           #
1012 #                                                                     #
1013 #<sqllog dbid="1">
1014
1015 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1016 # SQL oper module: Allows you to store oper credentials in an SQL table
1017 # You must copy the source for this module from the directory src/modules/extra
1018 #<module name="m_sqloper.so">
1019 #
1020 #-#-#-#-#-#-#-#-#-#-#- SQLOPER CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#
1021 #                                                                     #
1022 # dbid       - Database ID to use (see m_sql)                         #
1023 #                                                                     #
1024 # See also: http://www.inspircd.org/wiki/SQL_Oper_Storage_Module      #
1025 #                                                                     #
1026 #<sqloper dbid="1">
1027
1028 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1029 # SWHOIS module: Allows you to add arbitary lines to user WHOIS.
1030 #<module name="m_swhois.so">
1031
1032 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1033 # Test command module: Does nothing significant. Read: pointless.
1034 #<module name="m_testcommand.so">
1035
1036 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1037 # Timed bans module: Adds timed bans and the /TBAN command
1038 #<module name="m_timedbans.so">
1039
1040 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1041 # Userip module: Adds the /USERIP command
1042 #<module name="m_userip.so">
1043
1044 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1045 # Vhost module: Adds the VHOST command which allows for adding virtual
1046 # hosts which are accessible using a username and password in the config.
1047 #<module name="m_vhost.so">
1048 #
1049 #-#-#-#-#-#-#-#-#-#-#- VHOST CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#-#
1050 #                                                                     #
1051 # user       - Username for the vhost.                                #
1052 #                                                                     #
1053 # pass       - Password for the vhost.                                #
1054 #                                                                     #
1055 # host       - Vhost to set.                                          #
1056 #
1057 #<vhost user="some_username" pass="some_password" host="some.host">
1058
1059 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1060 # Watch module: Adds the WATCH command, which is used by clients to
1061 # maintain notify lists.
1062 #<module name="m_watch.so">
1063
1064 #-#-#-#-#-#-#-#-#-#-#-#-#-#-  BAN OPTIONS  -#-#-#-#-#-#-#-#-#-#-#-#-#-#
1065 #                                                                     #
1066 # The ban tags define nick masks, host masks and ip ranges which are  #
1067 # banned from your server. All details in these tags are local to     #
1068 # Your server.                                                        #
1069 #                                                                     #
1070 #                                                                     #
1071 # badip lines ban an ip range (same as a zline)                       #
1072 #                                                                     #
1073 # ipmask       -          The ip range to ban (wildcards possible)    #
1074 # reason       -          Reason to display when disconnected         #
1075 #                                                                     #
1076 # badnick lines ban a nick mask (same as a qline)                     #
1077 #                                                                     #
1078 # nick         -          Nick mask to ban (wildcards possible)       #
1079 # reason       -          Reason to display on /NICK                  #
1080 #                                                                     #
1081 # badhost lines ban a user@host mask (same as a kline)                #
1082 #                                                                     #
1083 # host         -          ident@hostname (wildcards possible)         #
1084 # reason       -          Reason to display on disconnection          #
1085 #                                                                     #
1086 # exception lines define a hostmask that is excempt from [kzg]lines   #
1087 #                                                                     #
1088 # host         -          ident@hostname (wildcards possible)         #
1089 # reason       -          Reason, shown only in /stats e              #
1090 #                                                                     #
1091
1092 <badip ipmask="69.69.69.69" reason="No porn here thanks.">
1093
1094 <badnick nick="ChanServ" reason="Reserved For Services">
1095 <badnick nick="NickServ" reason="Reserved For Services">
1096 <badnick nick="OperServ" reason="Reserved For Services">
1097 <badnick nick="MemoServ" reason="Reserved For Services">
1098
1099 <badhost host="*@hundredz.n.hundredz.o.1337.kiddies.com" reason="Too many 1337 kiddiots">
1100 <badhost host="*@localhost" reason="No irc from localhost!">
1101
1102 <exception host="*@ircop.host.com" reason="Opers hostname">
1103
1104 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#- YAWN  -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1105 #                                                                     #
1106 #   You should already know what to do here :)                        #
1107
1108 <die value="You should probably edit your config *PROPERLY* and try again.">
1109
1110
1111 #########################################################################
1112 #                                                                       #
1113 #                     - InspIRCd Development Team -                     #
1114 #                        http://www.inspircd.org                        #
1115 #                                                                       #
1116 #########################################################################