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