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