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