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