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