summaryrefslogtreecommitdiff
path: root/docs/inspircd.conf.example
blob: 089079bd1d7081d035c20cac7aba01cb27cceefe (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
########################################################################
#								       #
#		      ---------------------------		       #
#  		      InspIRCd Configuration File		       #
#		      ---------------------------		       #
#								       #
##################################||####################################
				 #||#
##################################||####################################
#								       #
#         This is an example of the config file for InspIRCd.          #
#             Change the options to suit your network                  #
#								       #
#                 Last updated on : 01/05/2004                         #
#                 Written by      : CC  (cc@backchat.co.za)            #
#                 Updated by      : BlackDeathX (james@dreamirc.org)   #
########################################################################



#-#-#-#-#-#-#-#-#-#-#-#-  SERVER DESCRIPTION  -#-#-#-#-#-#-#-#-#-#-#-#-
#								      #
#   Here is where you enter the information about your server.        #
#								      #
#  Syntax is as follows:					      #
#     <server name="server.name"				      #
#      description="Server Description"				      #
#      network="MyNetwork">					      #
#								      #

<server name="penguin.omega.org.za"
        description="Waddle World"
        network="Omega">


#-#-#-#-#-#-#-#-#-#-#-#-   ADMIN INFORMATION   -#-#-#-#-#-#-#-#-#-#-#-#
#								      #
#   Describes the Server Administrator's real name, nick	      #
#   and email address.                   			      #
#								      #
#  Syntax is as follows:					      #
#	<admin name="real name"					      #
#	       nick="nick name"					      #
#              email="email@address.com">			      #
#								      #

<admin  name="Johnny Casino"
        nick="CC"
        email="cc@monkeynut.co.za">


#-#-#-#-#-#-#-#-#-#-#-#-   PORT CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-
#								      #
#   Enter the port and address bindings here.	                      #
#								      #
#  bind address - specifies which the address which ports bind	      #	
#  port		- opens an unused port				      #
#  type         - can be 'clients' or 'servers'. The clients type is  #
#                 a standard tcp based socket, the servers type is a  #
#                 also a TCP based connection but of a different      #
#                 format.                                             #
#  default      - if the port type is 'servers' then this can be      #
#                 specified. If set to 'yes', it indicates that this  #
#                 port is the default route for all /connect commands.#
#                 if you do not bind your default route to an         #
#                 external ip, or all ip's, you may have connection   #
#                 problems.                                           #
#								      #
#  Leaving address empty binds to all available interfaces            #
#								      #
#  Syntax is as follows:                                              #
#                                                                     #
# <bind address="ip number" port="port" type="clients">	      	      #
# <bind address="ip number" port="port" type="servers">	      	      #
# <bind address="ip number" port="port" type="servers" default="yes"> #
#								      #

<bind address="" port="6660" type="clients">
<bind address="" port="7000" type="servers" default="yes">
<bind address="" port="7001" type="servers">


#-#-#-#-#-#-#-#-#-#-  DIE/RESTART CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-
#                                                                     #
#   You can configure the passwords here which you wish to use for    #
#   the die and restart commands. Only trusted ircops who will        #
#   need this ability should know the die and restart password.       #
#                                                                     #
#  Syntax is as follows:                                              #
#       <power diepass="die password" restartpass="restart password"  #
#	 pause="secs before dying">			      	      #
#                                                                     #

<power diepass="diepass" restartpass="restartpass" pause="2">


#-#-#-#-#-#-#-#-#-#-  CONNECTIONS CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-
#								      #
#   This is where you can configure which connections are allowed     #
#   and denied access onto your server.				      #
#   The password is optional.					      #
#   You may have as many of these as you require.                     #
#   To allow/deny all connections use a *                             #
#								      #
#  Syntax is as follows:					      #
#	<connect allow="ip or host">				      #
#	<connect allow="ip or host" password="blahblah">              #
#       <connect allow="ip or host" password="blah" timeout="10">     #
#	<connect allow="ip or host" timeout="blah" flood="5">         #
#       <connect allow="ip or host" threshold="8" pingfreq="120">     #
#       <connect allow="ip or host" sendq="99999" revcq="696969">     #
#	<connect deny="ip or host">				      #
#                                                                     #
#   You may optionally include timeout="x" on any allow line, which   #
#   specifies the amount of time given before an unknown connection   #
#   is closed if USER/NICK/PASS are not given. This value is in secs  #
#								      #
#   You may also optionally include a flood="x" line which indicates  #
#   the number of lines a user may place into their buffer at once    #
#   before they are disconnected for excess flood. The default is to  #
#   DISABLE this feature. A recommended value is 10. A counter is     #
#   maintained for each user which is reset every 'threshold' seconds #
#   and specifying this threshold value with threshold="X" indicates  #
#   how often the counter is reset. For example, with flood="5" and   #
#   threshold="8", the user may not send more than 5 lines in 8 secs. #
#                                                                     #
#   You may optionally specify the sendq size and ping frequency of   #
#   each connect:allow line using the pingfreq="X" and sendq="X"      #
#   settings as shown in the full example below.                      #
#   The ping frequency is specified in seconds, and the sendq size    #
#   in bytes. It is recommended, although not enforced, that you      #
#   should never set your sendq size to less than 8k. Send Queues are #
#   dynamically allocated and can grow as needed up to the maximum    #
#   size specified.                                                   #
#                                                                     #
#   The optional recvq value is the maximum size which users in this  #
#   group may grow their receive queue to. This is recommended to be  #
#   kept pretty low compared to the sendq, as users will always       #
#   recieve more than they send in normal circumstances. The default  #
#   if not specified is 4096.                                         #
#                                                                     #
#   IMPORTANT NOTE, CALL THE CONFUSION POLICE!                        #
#   The sendq is the data waiting to be sent TO THE USER.             #
#   The recvq is the data being received FROM THE USER.               #
#   The names sendq and recvq are from the SERVER'S PERSPECTIVE not   #
#   that of the user... Just to clear up any confusion or complaints  #
#   that these are backwards :p                                       #
#                                                                     #

<connect allow="196.12.*"  password="secret">
<connect allow="*" timeout="60" flood="10" timeout="60" pingfreq="120" sendq="262144" recvq="4096">

<connect deny="69.254.*">


#-#-#-#-#-#-#-#-#-#-#-#-  CLASS CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-
#								      #
#   Classes are a group of commands which are grouped together        #
#   and given a unique name. They used to define which commands       #
#   are available to certain types of Operators.                      #
#								      #
#  Syntax is as follow:						      #
#	<class name="name" commands="oper commands">		      #
#								      #

<class name="Shutdown" commands="DIE RESTART REHASH">
<class name="ServerLink" commands="CONNECT SQUIT">
<class name="BanControl" commands="KILL GLINE KLINE ZLINE QLINE SHUN">
<class name="OperChat" commands="WALLOPS CHATOPS">
<class name="HostCloak" commands="SETHOST SETIDENT SETNAME">


#-#-#-#-#-#-#-#-#-#-#-#-  OPERATOR COMPOSITION   -#-#-#-#-#-#-#-#-#-#-#
#								      #
#   This is where you specify which types of operators you have on    #
#   your server, as well as the commands they are allowed to use.     #
#   This works alongside with the classes specified above.	      #
#								      #
#  type name  - a name for the combined class types		      #
#  classes    - specified above, used for flexibility for the         #
#               server admin to decide on which operators get         #
#		what commands					      #
#  host	      - hostmask operators will recieve on oper-up            #
#								      #
#  Syntax is as follows:					      #
#	<type name="name" classes="class name" host="oper hostmask">  #
#								      #

<type name="NetAdmin" classes="OperChat BanControl HostCloak Shutdown ServerLink" host="netadmin.omega.org.za">
<type name="GlobalOp" classes="OperChat BanControl HostCloak ServerLink" host="ircop.omega.org.za">
<type name="LocalOp" classes="OperChat BanControl HostCloak" host="local.omega.org.za">
<type name="Helper" classes="HostCloak" host="helper.omega.org.za">


#-#-#-#-#-#-#-#-#-#-#-  OPERATOR CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#
#								      #
#   Opers are defined here. This is a very important section.         #
#   Remember to only make operators out of truthworthy people.        #
#								      #
#  name      - oper name, best to use lower-case		      #
#  password  - password to oper-up,	              	              #
#              encryption not yet available			      #
#  host      - host of client allowed to oper-up, more hostmasks      #
#              seperated by spaces, wildcards accepted	              #
#  type      - specified above, defines the kind of operator	      #
#								      #
#  Syntax is as follows:                                              #
#	<oper name="login"					      #
#	      password="pass"					      #
#             host="hostmask@of.oper"				      #
#             type="oper type">					      #
#								      #

<oper   name="cc"
	password="s3cret"
        host="*@*"
        type="NetAdmin">


#-#-#-#-#-#-#-#-#-#-#-  SERVER LINK CONFIGURATION  -#-#-#-#-#-#-#-#-#-#
#                                                                     #
# Defines which servers can link to this one, and which servers this  #
# server may create outbound links to.                                #
#                                                                     #
# name      - The name is the canocial name of the server, it does    #
#             not have to resolve - but it is expected to be sent in  #
#             the remote servers connection info.                     #
# ipaddr    - Valid host or ip address for remote server. *           #
# port      - Valid listening UDP port for remote server.             #
# sendpass  - Password to send to create an outbound connection to    #
#             this server.                                            #
# recvpass  - Password to receive to accept an inbound connection     #
#             from this server.                                       #
#                                                                     #
# to u:line a server (give it extra privilages required for running   #
# services, Q, etc) you must include the <uline server> tag as shown  #
# in the example below. You can have as many of these as you like.    #
#                                                                     #
# WARNING: Unlike other ircds, u:lining a server allows ALL users on  #
# that server to operoverride modes. This should only be used for     #
# services and protected oper servers!                                #
#                                                                     #
# IMPORTANT NOTE: When specifying the ip address and/or host, the     #
# server software will prioritize RESOLVED hostnames above ip         #
# addresses, so for example if your target server resolves to a.b.com #
# you MUST put a.b.com into your link block, and NOT the IP address   #
# of a.b.com. The system uses reverse resolution.                     #
#                                                                     #

<link name="hub.penguin.org"
	ipaddr="penguin.box.com"
	port="7000"
	sendpass="outgoing!password"
	recvpass="incoming!password">

<link name="services.antarctic.com"
	ipaddr="localhost"
	port="7000"
	sendpass="penguins"
	recvpass="polarbears">

<uline server="services.antarctic.com">



#-#-#-#-#-#-#-#-#-#-  MISCELLANEOUS CONFIGURATION  -#-#-#-#-#-#-#-#-#-#
#								      #
#   These options let you define the path to your motd and rules      #
#   files.							      #
#								      #

<files  motd="/home/cc/inspircd-1.0/conf/inspire.motd"
	rules="/home/cc/inspircd-1.0/conf/inspire.rules">

#-#-#-#-#-#-#-#-#-#-#-#-#-#-# DNS SERVER -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
#                                                                     #
# Define your DNS server address here. InspIRCd has its own resolver  #
# and you must define this otherwise nobody's host will resolve. The  #
# timeout value is in seconds.					      #
#                                                                     #

<dns server="127.0.0.1" timeout="5">

#-#-#-#-#-#-#-#-#-#-#-#-#-#-#  PID FILE  -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
#                                                                     #
# Define the path to the PID file here. The PID file can be used to   #
# rehash the ircd from the shell or to terminate the ircd from the    #
# shell using shell scripts, perl scripts etc, and to monitor the     #
# ircd's state via cron jobs.                                         #
#                                                                     #

<pid file="/path/to/inspircd.pid">

#-#-#-#-#-#-#-#-#-#-#-#-#- BANLIST LIMITS #-#-#-#-#-#-#-#-#-#-#-#-#-#-#
#                                                                     #
# Use these tags to customise the ban limits on a per channel basis.  #
# the tags are read from top to bottom, and any tag found which       #
# matches the channels name applies the banlimit to that channel.     #
# It is advisable to put an entry with the channel as '*' at the      #
# bottom of the list. If none are specified or no maxbans tag is      #
# matched, the banlist size defaults to 64 entries.                   #
#                                                                     #

<banlist chan="#morons" limit="128">
<banlist chan="*" limit="69">

#-#-#-#-#-#-#-#-#-#-#-  DISABLED COMMANDS  -#-#-#-#-#-#-#-#-#-#-#-#-#-#
#                                                                     #
# This tag is optional, and specifies one or more commands which are  #
# not available to non-operators. For example you may wish to disable #
# NICK and prevent non-opers from changing their nicknames.           #
# Note that any disabled commands take effect only after the user has #
# 'registered' (e.g. after the initial USER/NICK/PASS on connection)  #
# so for example disabling NICK will not cripple your network.        #
#                                                                     #
#         <disabled commands="TOPIC MODE">                            #
#                                                                     #


#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-  RTFM LINE  -#-#-#-#-#-#-#-#-#-#-#-#-#-#
#                                                                     #
#   Just remove this... Its here to make you read ALL of the config   #
#   file options ;)                                                   #

<die value="And god came down from the heavens and smote down the noob.">



#-#-#-#-#-#-#-#-#-#-#-#-#-  SERVER OPTIONS   -#-#-#-#-#-#-#-#-#-#-#-#-#
#								      #
#   Settings to define which features are useable on your server.     #
#								      #
#  prefixquit    - a prefix for a client's quit message               #
#  loglevel      - specifies what detail of messages to log in the    #
#                  log file. You may select from debug, verbose,      #
#                  default, sparse and none.                          #
#  allowhalfop   - allows the +h channel mode			      #
#  noservices    - If noservices is true, yes, or 1, then the first   #
#                  user into a channel gets founder status. This is   #
#                  only useful on networks running the m_chanprotect  #
#                  module without services.                           #
#  netbuffersize - size of the buffer used to receive data from       #
#                  clients. The ircd may only read() this amount      #
#		   of text in one go at any time. (OPTIONAL)          #
#  maxwho        - The maximum number of results returned by a /WHO   #
#                  query. This is to prevent /WHO being used as a     #
#                  spam vector or means of flooding an ircd. The      #
#                  default is 128, it is not recommended to raise it  #
#                  above 1024. Values up to 65535 are permitted.      #

<options prefixquit="Quit: "
	 loglevel="default"
	 netbuffersize="10240"
         maxwho="128"
	 noservices="0"
	 allowhalfop="yes">



#-#-#-#-#-#-#-#-#-#-#-#-#-  MODULE OPTIONS   -#-#-#-#-#-#-#-#-#-#-#-#-#
#                                                                     #
#  These tags define which modules will be loaded on startup by your  #
#  server. Add modules without any paths. When you make your ircd     #
#  using the 'make' command, all compiled modules will be moved into  #
#  the folder you specified when you ran ./configure. The module tag  #
#  automatically looks for modules in this location.                  #

<module name="m_foobar.so">

#-#-#-#-#-#-#-#-#-#-#-  FILTER  CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#-#
#                                                                     #
# Optional - If you specify to use the m_filter.so module, then       #
# specfiy below the path to the filter.conf file.                     #

<filter file="/path/to/inspircd/filter.conf">


#-#-#-#-#-#-#-#-#-#-#-#-  HELPOP  CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#
#                                                                     #
# Optional - If you specify to use the m_helpop.so module, then       #
# specify below the path to the helpop.conf file.                     #

<helpop file="/path/to/inspircd/helpop.conf">


#-#-#-#-#-#-#-#-#-#-  RANDOMQUOTES CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
#                                                                     #
# Optional - If you specify to use the m_randquotes.so module, then   #
# specify below the path to the randquotes.conf file.                 #

<randquote file="/path/to/inspircd/randquotes.conf">

#-#-#-#-#-#-#-#-#-#-#-#-#-#-  BAN OPTIONS  -#-#-#-#-#-#-#-#-#-#-#-#-#-#
#                                                                     #
# The ban tags define nick masks, host masks and ip ranges which are  #
# banned from your server. All details in these tags are local to     #
# Your server.                                                        #
#                                                                     #
#                                                                     #
# badip lines ban an ip range (same as a zline)                       #
#                                                                     #
# ipmask       -          The ip range to ban (wildcards possible)    #
# reason       -          Reason to display when disconnected         #
#                                                                     #
# badnick lines ban a nick mask (same as a qline)                     #
#                                                                     #
# nick         -          Nick mask to ban (wildcards possible)       #
# reason       -          Reason to display on /NICK                  #
#                                                                     #
# badhost lines ban a user@host mask (same as a kline)                #
#                                                                     #
# host         -          ident@hostname (wildcards possible)         #
# reason       -          Reason to display on disconnection          #
#                                                                     #
# exception lines define a hostmask that is excempt from [kzg]lines   #
#                                                                     #
# host         -          ident@hostname (wildcards possible)         #
# reason       -          Reason, shown only in /stats e              #
#                                                                     #

<badip ipmask="69.69.69.69" reason="No porn here thanks.">

<badnick nick="ChanServ" reason="Reserved For Services">
<badnick nick="NickServ" reason="Reserved For Services">
<badnick nick="OperServ" reason="Reserved For Services">
<badnick nick="MemoServ" reason="Reserved For Services">

<badhost host="*@hundredz.n.hundredz.o.1337.kiddies.com" reason="Too many 1337 kiddiots">
<badhost host="*@localhost" reason="No irc from localhost!">

<exception host="*@ircop.host.com" reason="Opers hostname">

#-#-#-#-#-#-#-#-#-#-#-  ALIAS DEFINITIONS  -#-#-#-#-#-#-#-#-#-#-#-#-#-#
#                                                                     #
# If you have the m_alias.so module loaded, you may also define       #
# aliases as shown below. They are commonly used to provide shortcut  #
# commands to services, however they are not limited to jsut this use.#
# An alias tag requires the following values to be defined in it:     #
#                                                                     #
# text        -      The text to detect at the start of the line,     #
#                    must be at the start of the line to trigger the  #
#                    alias. May contain spaces, but case insensitive. #
# replace     -      The text to replace 'text' with. Usually this    #
#                    will be "PRIVMSG ServiceName :" or similar.      #
# requires    -      If you provide a value for 'requires' this means #
#                    the given nickname MUST be online for the alias  #
#                    to successfully trigger. If they are not, then   #
#                    the user receives a 'no such nick' 401 numeric.  #
# uline       -      Defining this value with 'yes', 'true' or '1'    #
#                    will ensure that the user given in 'requires'    #
#                    must also be on a u-lined server, as well as     #
#                    actually being on the network. If the user is    #
#                    online, but not on a u-lined server, then an     #
#                    oper-alert is sent out as this is possibly signs #
#                    of a user trying to impersonate a service.       #
#                                                                     #

<alias text="NICKSERV" replace="PRIVMSG NickServ :" requires="NickServ" uline="yes">
<alias text="CHANSERV" replace="PRIVMSG ChanServ :" requires="ChanServ" uline="yes">
<alias text="NS" replace="PRIVMSG NickServ :" requires="NickServ" uline="yes">
<alias text="CS" replace="PRIVMSG ChanServ :" requires="ChanServ" uline="yes">

#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#- YAWN  -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
#                                                                     #
#   You should already know what to do here :)                        #

<die value="All l33t noobs must edit their configs.">


#########################################################################
#									#
#		 -InspIRCd Development and Coding Team-			#
#                          www.inspircd.org				#
#	 								#
#########################################################################