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