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