]> git.netwichtig.de Git - user/henk/code/inspircd.git/blob - docs/inspircd.conf.example
5a5a6c7c51f862430febd63204f53d528b078a09
[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 #     $Id$
24 #                                                                      #
25 #    ____                _   _____ _     _       ____  _ _   _         #
26 #   |  _ \ ___  __ _  __| | |_   _| |__ (_)___  | __ )(_) |_| |        #
27 #   | |_) / _ \/ _` |/ _` |   | | | '_ \| / __| |  _ \| | __| |        #
28 #   |  _ <  __/ (_| | (_| |   | | | | | | \__ \ | |_) | | |_|_|        #
29 #   |_| \_\___|\__,_|\__,_|   |_| |_| |_|_|___/ |____/|_|\__(_)        #
30 #                                                                      #
31 #   Lines prefixed with READ THIS BIT, as shown above, are IMPORTANT   #
32 #   lines, and you REALLY SHOULD READ THEM. Yes, THIS MEANS YOU. Even  #
33 #   if you've configured InspIRCd before, these probably indicate      #
34 #   something new or different to this version and you SHOULD READ IT. #
35 #                                                                      #
36 ########################################################################
37 #                                                                      #
38 #         Unalphabeticalise the modules list at your own risk          #
39 #                                                                      #
40 ########################################################################
41
42 #-#-#-#-#-#-#-#-#-#  INCLUDE CONFIGURATION  #-#-#-#-#-#-#-#-#-#-#-#-#-#
43 #                                                                     #
44 # This optional tag allows you to include another config file         #
45 # allowing you to keep your configuration tidy. The configuration     #
46 # file you include will be treated as part of the configuration file  #
47 # which includes it, in simple terms the inclusion is transparent.    #
48 #                                                                     #
49 # All paths to config files are relative to the directory that the    #
50 # process runs in.                                                    #
51 #                                                                     #
52 # You may also include an executable file, in which case if you do so #
53 # the output of the executable on the standard output will be added   #
54 # to your config at the point of the include tag.                     #
55 #                                                                     #
56 # Syntax is as follows:                                               #
57 #<include file="file.conf">                                           #
58 #<include executable="/path/to/executable parameters">                #
59 #                                                                     #
60 # Executable Include Example:                                         #
61 #<include executable="/usr/bin/wget -q -O - http://mynet.net/inspircd.conf">
62 #                                                                     #
63
64
65 #-#-#-#-#-#-#-#-#-#-#-#  VARIABLE DEFINITIONS  -#-#-#-#-#-#-#-#-#-#-#-#
66 #                                                                     #
67 # You can define variables that will be substituted later in the      #
68 # configuration file. This can be useful to allow settings to be      #
69 # easily changed, or to parameterize a remote includes.               #
70 #                                                                     #
71 # Variables may be redefined and may reference other variables.       #
72 # Value expansion happens at the time the tag is read.                #
73 #                                                                     #
74 # Using variable definitions REQUIRES that the config format be       #
75 # changed to "xml" from the default "compat" that uses escape         #
76 # sequences such as "\"" and "\n", and does not support <define>      #
77 <config format="xml">
78 <define name="bindip" value="1.2.2.3">
79 <define name="localips" value="&bindip;/24">
80
81 #-#-#-#-#-#-#-#-#-#-#-#-  SERVER DESCRIPTION  -#-#-#-#-#-#-#-#-#-#-#-#-
82 #                                                                     #
83 #   Here is where you enter the information about your server.        #
84 #                                                                     #
85
86 <server
87         # name: Hostname of your server. Does not need to resolve, but
88         # does need to be correct syntax (something.somethingelse.tld).
89         name="penguin.omega.org.za"
90
91         # description: Server description. Spaces are allowed.
92         description="Waddle World"
93
94         # id: The SID to use for this server. This should not be uncommented
95         # unless there is a SID conflict. This must be three characters long.
96         # The first character must be a digit [0-9], the remaining two chars
97         # may be letters [A-Z] or digits.
98         #id="97K"
99
100         # network: Network name given on connect to clients.
101         # Should be the same on all servers on the network and
102         # not contain spaces.
103         network="Omega">
104
105
106 #-#-#-#-#-#-#-#-#-#-#-#-   ADMIN INFORMATION   -#-#-#-#-#-#-#-#-#-#-#-#
107 #                                                                     #
108 #   Describes the Server Administrator's real name (optionally),      #
109 #   nick, and email address.                                          #
110 #                                                                     #
111
112 <admin
113        # name: Real Name
114        name="Johnny English"
115
116        # nick: Nickname (preferably what you use on the network)
117        nick="MI5"
118
119        # email: email address. Does not have to be valid
120        # but should be for the users to be able to contact you.
121        email="MI5@the.best.secret.agent">
122
123
124 #-#-#-#-#-#-#-#-#-#-#-#-   PORT CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-
125 #                                                                     #
126 #   Enter the port and address bindings here.                         #
127 #                                                                     #
128 #                                                                     #
129 #    ____                _   _____ _     _       ____  _ _   _        #
130 #   |  _ \ ___  __ _  __| | |_   _| |__ (_)___  | __ )(_) |_| |       #
131 #   | |_) / _ \/ _` |/ _` |   | | | '_ \| / __| |  _ \| | __| |       #
132 #   |  _ <  __/ (_| | (_| |   | | | | | | \__ \ | |_) | | |_|_|       #
133 #   |_| \_\___|\__,_|\__,_|   |_| |_| |_|_|___/ |____/|_|\__(_)       #
134 #                                                                     #
135 #  If you want to link servers to InspIRCd you must load the          #
136 #  m_spanningtree.so module! Please see the modules list below for    #
137 #  information on how to load this module! If you do not load this    #
138 #  module, server ports will NOT be bound!                            #
139 #                                                                     #
140 # PLEASE NOTE: If you have build InspIRCd with IPv6 support, you MUST #
141 # specify a bind address if you want the IRCd to bind to a IPv4 IP.   #
142
143 <bind
144       # address: IP address to bind to if the box that you are hosting
145       # on has more than one IP, else the ircd will try to bind to all
146       # IP's on the box if this is not defined.
147       address=""
148
149       # port: Port for users or servers to be able to connect to.
150       # you can select multiple ports by separating them
151       # with a - character like the example below.
152       port="6697"
153
154       # type: Type of bind block this is. It can either be clients or
155       # servers. Whichever you select will be the only type able to connect
156       # to this bind section.
157       type="clients"
158
159       # ssl: If you want this bind section to use SSL, define either
160       # gnutls or openssl here. The appropriate SSL modules must be loaded
161       # for ssl to work. If you do not want this bind section to support ssl,
162       # just remove or comment out this option.
163       ssl="gnutls"
164       >
165
166 <bind address="" port="6660-6669" type="clients">
167
168 # When linking servers, the openssl and gnutls transports are completely
169 # link-compatible and can be used alongside each other
170 # on each end of the link without any significant issues.
171 # Transports can only be used on server blocks.
172 # Supported Transports are: "ziplinks", "openssl" and "gnutls".
173 # You must load m_ziplinks module for zip, m_ssl_openssl for openssl
174 # or m_ssl_gnutls for gnutls.
175
176 <bind address="" port="7000,7001" type="servers">
177 <bind address="1.2.3.4" port="7005" type="servers" ssl="openssl">
178
179
180 #-#-#-#-#-#-#-#-#-#-  DIE/RESTART CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-
181 #                                                                     #
182 #   You can configure the passwords here which you wish to use for    #
183 #   the die and restart commands. Only trusted IRCop's who will       #
184 #   need this ability should know the die and restart password.       #
185 #                                                                     #
186
187 <power
188        # hash: what hash these passwords are hashed with. requires the module
189        # for selected hash (m_md5.so, m_sha256.so or m_ripemd160.so) be
190        # loaded and the password hashing module (m_password_hash.so)
191        # loaded. Options here are: "md5", "sha256" and "ripemd160".
192        # Optional, but recommended. Create hashed password with:
193        # /mkpasswd <hash> <password>
194        #hash="sha256"
195
196        # diepass: Password for opers to use if they need to shutdown (die)
197        # a server.
198        diepass=""
199
200        # restartpass: Password for opers to use if they need to restart
201        # a server.
202        restartpass="">
203
204
205 #-#-#-#-#-#-#-#-#-#-  CONNECTIONS CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#
206 #                                                                     #
207 #   This is where you can configure which connections are allowed     #
208 #   and denied access onto your server. The password is optional.     #
209 #   You may have as many of these as you require. To allow/deny all   #
210 #   connections, use a '*' or 0.0.0.0/0.                              #
211 #                                                                     #
212 #  -- It is important to note that connect tags are read from the  -- #
213 #     TOP DOWN. This means that you should have more specific deny    #
214 #    and allow tags at the top, progressively more general, followed  #
215 #        by a <connect allow="*" (should you wish to have one).       #
216 #                                                                     #
217 #                                                                     #
218 <connect
219          # deny: Will not let people connect if they have specified host/IP.
220          deny="69.254.*">
221
222 <connect deny="3ffe::0/32">
223
224 <connect
225          # name: Name to use for this connect block. Mainly used for
226          # connect class inheriting.
227          name="secret"
228
229          # parent: This setting is to specify if this connect class
230          # inherits settings from any other. Put the other class's name
231          # in here to use its settings as a template - for example,  if
232          # you only want to adjust sendq and a password
233          parent="main"
234
235          # allow: What IP addresses/hosts to allow for this block.
236          allow="196.12.*"
237
238          # hash: what hash this password is hashed with. requires the module
239          # for selected hash (m_md5.so, m_sha256.so or m_ripemd160.so) be
240          # loaded and the password hashing module (m_password_hash.so)
241          # loaded. Options here are: "md5", "sha256" and "ripemd160".
242          # Optional, but recommended. Create hashed password with:
243          # /mkpasswd <hash> <password>
244          #hash="sha256"
245
246          # password: Password to use for this block/user(s)
247          password="secret"
248
249          # maxchans: Maximum number of channels a user in this class
250          # be in at one time. This overrides every other maxchans setting.
251          #maxchans="30"
252
253          # timeout: How long (in seconds) the server will wait before
254          # disconnecting a user if they do not do anything on connect.
255          # (Note, this is a client-side thing, if the client does not
256          # send /nick, /user or /pass)
257          timeout="10"
258
259          # localmax: Maximum local connections per IP (or CIDR mask, see below).
260          localmax="3"
261
262          # globalmax: Maximum global (network-wide) connections per IP (or CIDR mask, see below).
263          globalmax="3"
264
265          # useident: Defines if users in this class MUST respond to a ident query or not.
266          useident="no"
267
268          # limit: How many users are allowed in this class
269          limit="5000"
270
271          # modes: Usermodes that are set on users in this block on connect.
272          # Enabling this option requires that the m_conn_umodes module be loaded.
273          # This entry is highly recommended to use for/with IP Cloaking/masking.
274          # For the example to work, this also requires that the m_cloaking
275          # module be loaded as well.
276          modes="+x"
277
278          # requireident, requiressl, requireaccount: require that users of this
279          # block have a valid ident response, use SSL, or have authenticated.
280          # Requires m_ident, m_sslinfo, or m_services_account respectively.
281          requiressl="on"
282
283          # Alternate MOTD file for this connect class. The contents of this file are
284                  # specified using <files secretmotd="filename"> or <execfiles ...>
285          motd="secretmotd"
286
287          # port: What port this user is allowed to connect on. (optional)
288          # The port MUST be set to listen in the bind blocks above.
289          port="6697">
290
291 <connect
292          # name: Name to use for this connect block. Mainly used for
293          # connect class inheriting.
294          name="main"
295
296          # allow: What IP addresses/hosts to allow for this block.
297          allow="*"
298
299          # maxchans: Maximum number of channels a user in this class
300          # be in at one time. This overrides every other maxchans setting.
301          #maxchans="30"
302
303          # timeout: How long (in seconds) the server will wait before
304          # disconnecting a user if they do not do anything on connect.
305          # (Note, this is a client-side thing, if the client does not
306          # send /nick, /user or /pass)
307          timeout="10"
308
309          # pingfreq: How often (in seconds) the server tries to ping connecting clients.
310          pingfreq="120"
311
312          # hardsendq: maximum amount of data allowed in a client's send queue
313          # before they are dropped. Keep this value higher than the length of
314          # your network's /LIST or /WHO output, or you will have lots of
315          # disconnects from sendq overruns!
316          hardsendq="1048576"
317
318          # softsendq: amount of data in a client's send queue before the server
319          # begins delaying their commands in order to allow the sendq to drain
320          softsendq="8192"
321
322          # recvq: amount of data allowed in a client's queue before they are dropped.
323          recvq="8192"
324
325          # threshold: This specifies the amount of command penalty a user is allowed to have
326          # before being quit or fakelagged due to flood. Normal commands have a penalty of 1,
327          # ones such as /OPER have penalties up to 10.
328          #
329          # If you are not using fakelag, this should be at least 20 to avoid excess flood kills
330          # from processing some commands.
331          threshold="10"
332
333          # commandrate: This specifies the maximum rate that commands can be processed.
334          # If commands are sent more rapidly, the user's penalty will increase and they will
335          # either be fakelagged or killed when they reach the threshold
336          #
337          # Units are millicommands per second, so 1000 means one line per second.
338          commandrate="1000"
339
340          # fakelag: Use fakelag instead of killing users for excessive flood
341          #
342          # Fake lag stops command processing for a user when a flood is detected rather than
343          # immediately killing them; their commands are held in the recvq and processed later
344          # as the user's command penalty drops. Note that if this is enabled, flooders will
345          # quit with "RecvQ exceeded" rather than "Excess Flood".
346          fakelag="on"
347
348          # localmax: Maximum local connections per IP.
349          localmax="3"
350
351          # globalmax: Maximum global (network-wide) connections per IP.
352          globalmax="3"
353
354          # useident: Defines if users in this class must respond to a ident query or not.
355          useident="no"
356
357          # limit: How many users are allowed in this class
358          limit="5000"
359
360          # modes: Usermodes that are set on users in this block on connect.
361          # Enabling this option requires that the m_conn_umodes module be loaded.
362          # This entry is highly recommended to use for/with IP Cloaking/masking.
363          # For the example to work, this also requires that the m_cloaking
364          # module be loaded as well.
365          modes="+x">
366
367
368 #-#-#-#-#-#-#-#-#-#-#-#-  CIDR CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-
369 #                                                                     #
370 # CIDR configuration allows detection of clones and applying of       #
371 # throttle limits across a CIDR range. (A CIDR range is a group of    #
372 # IPs, for example, the CIDR range 192.168.1.0-192.168.1.255 may be   #
373 # represented as 192.168.1.0/24). This means that abuse across an ISP #
374 # is detected and curtailed much easier. Here is a good chart that    #
375 # shows how many IPs the different CIDRs correspond to:               #
376 # http://en.wikipedia.org/wiki/CIDR#Prefix_aggregation                #
377 #                                                                     #
378
379 <cidr
380           # ipv4clone: specifies how many bits of an IP address should be
381       # looked at for clones. The default only looks for clones on a
382       # single IP address of a user. You do not want to set this
383       # extremely low. (Values are 0-32).
384       ipv4clone="32"
385
386       # ipv6clone: specifies how many bits of an IP address should be
387       # looked at for clones. The default only looks for clones on a
388       # single IP address of a user. You do not want to set this
389       # extremely low. (Values are 0-128).
390       ipv6clone="128">
391
392 # This file has all the information about oper classes, types and o:lines.
393 # You *MUST* edit it.
394 <include file="conf/opers.conf.example">
395
396 # This file has all the information about server links and ulined servers.
397 # You *MUST* edit it if you intend to link servers.
398 <include file="conf/links.conf.example">
399
400 #-#-#-#-#-#-#-#-#-#-  MISCELLANEOUS CONFIGURATION  -#-#-#-#-#-#-#-#-#-#
401 #                                                                     #
402
403 # Files block - contains files whose contents are used by the ircd
404 #
405 #   motd - displayed on connect and when a user executes /MOTD
406 #   rules - displayed when the user executes /RULES
407 # Modules can also define their own files
408 <files motd="conf/inspircd.motd.example" rules="conf/inspircd.rules.example">
409
410 # Example of an executable file include. Note this will be read on rehash,
411 # not when the command is run.
412 #<execfiles rules="wget -O - http://www.example.com/rules.txt">
413
414 #-#-#-#-#-#-#-#-#-#-#-# MAXIMUM CHANNELS -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
415 #                                                                     #
416
417 <channels
418           # users: Maximum number of channels a user can be in at once.
419           users="20"
420
421           # opers: Maximum number of channels a oper can be in at once.
422           opers="60">
423
424 #-#-#-#-#-#-#-#-#-#-#-#-#-#-# DNS SERVER -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
425 # If these values are not defined, InspIRCd uses the default DNS resolver
426 # of your system.
427
428 <dns
429      # server: DNS server to use to attempt to resolve IP's to hostnames.
430      # in most cases, you won't need to change this, as inspircd will
431      # automatically detect the nameserver depending on /etc/resolv.conf
432      # (or, on windows, your set nameservers in the registry.)
433      # Note that this must be an IP address and not a hostname, because
434      # there is no resolver to resolve the name until this is defined!
435      #
436      # server="127.0.0.1"
437
438      # timeout: seconds to wait to try to resolve DNS/hostname.
439      timeout="5">
440
441 # An example of using an IPv6 nameserver
442 #<dns server="::1" timeout="5">
443
444 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#  PID FILE  -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
445 #                                                                     #
446 # Define the path to the PID file here. The PID file can be used to   #
447 # rehash the ircd from the shell or to terminate the ircd from the    #
448 # shell using shell scripts, perl scripts, etc... and to monitor the  #
449 # ircd's state via cron jobs. If this is a relative path, it will be  #
450 # relative to the configuration directory, and if it is not defined,  #
451 # the default of 'inspircd.pid' is used.                              #
452 #                                                                     #
453
454 #<pid file="/path/to/inspircd.pid">
455
456 #-#-#-#-#-#-#-#-#-#-#-#-#- BANLIST LIMITS #-#-#-#-#-#-#-#-#-#-#-#-#-#-#
457 #                                                                     #
458 # Use these tags to customise the ban limits on a per channel basis.  #
459 # The tags are read from top to bottom, and any tag found which       #
460 # matches the channels name applies the banlimit to that channel.     #
461 # It is advisable to put an entry with the channel as '*' at the      #
462 # bottom of the list. If none are specified or no maxbans tag is      #
463 # matched, the banlist size defaults to 64 entries.                   #
464 #                                                                     #
465
466 <banlist chan="#morons" limit="128">
467 <banlist chan="*" limit="69">
468
469 #-#-#-#-#-#-#-#-#-#-#-  DISABLED FEATURES  -#-#-#-#-#-#-#-#-#-#-#-#-#-#
470 #                                                                     #
471 # This tag is optional, and specifies one or more features which are  #
472 # not available to non-operators.                                     #
473 #                                                                     #
474 # For example you may wish to disable NICK and prevent non-opers from #
475 # changing their nicknames.                                           #
476 # Note that any disabled commands take effect only after the user has #
477 # 'registered' (e.g. after the initial USER/NICK/PASS on connection)  #
478 # so for example disabling NICK will not cripple your network.        #
479 #                                                                     #
480 # You can also define if you want to disable any channelmodes         #
481 # or usermodes from your users.                                       #
482 #                                                                     #
483 # `fakenonexistant' will make the ircd pretend that nonexistant       #
484 # commands simply don't exist to non-opers ("no such command").       #
485 #                                                                     #
486 #<disabled commands="TOPIC MODE" usermodes="" chanmodes="" fakenonexistant="yes">
487
488
489 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-  RTFM LINE  -#-#-#-#-#-#-#-#-#-#-#-#-#-#
490 #                                                                     #
491 #   Just remove this... Its here to make you read ALL of the config   #
492 #   file options ;)                                                   #
493
494 <die value="You should probably edit your config *PROPERLY* and try again.">
495
496
497
498 #-#-#-#-#-#-#-#-#-#-#-#-#-  SERVER OPTIONS   -#-#-#-#-#-#-#-#-#-#-#-#-#
499 #                                                                     #
500 #   Settings to define which features are usable on your server.      #
501 #                                                                     #
502
503 <options
504          # prefixquit: What (if anything) a users' quit message
505          # should be prefixed with.
506          prefixquit="Quit: "
507
508          # suffixquit: What (if anything) a users' quit message
509          # should be suffixed with.
510          suffixquit=""
511
512          # prefixpart: What (if anything) a users' part message
513          # should be prefixed with.
514          prefixpart="&quot;"
515          # NOTE: Use "\"" instead of "&quot;" if not using <config format="xml">
516
517          # suffixpart: What (if anything) a users' part message
518          # should be suffixed with.
519          suffixpart="&quot;"
520
521          # fixedquit: Set all users' quit messages to this value.
522          #fixedquit=""
523
524          # fixedpart: Set all users' part messages in all channels
525          # to this value.
526          #fixedpart=""
527
528          # syntaxhints: If enabled, if a user fails to send the correct parameters
529          # for a command, the ircd will give back some help text of what
530          # the correct parameters are.
531          syntaxhints="no"
532
533          # cyclehosts: If enabled, when a user gets a host set, it will cycle
534          # them in all their channels. If not, it will simply change their host
535          # without cycling them.
536          cyclehosts="yes"
537
538          # ircumsgprefix: Use undernet-style message prefixing for NOTICE and
539          # PRIVMSG. If enabled, it will add users' prefix to the line, if not,
540          # it will just message the user normally.
541          ircumsgprefix="no"
542
543          # announcets: If set to yes, when the TimeStamp on a channel changes, all users
544          # in channel will be sent a NOTICE about it.
545          announcets="yes"
546
547          # allowmismatched: Setting this option to yes will allow servers to link even
548          # if they don't have the same VF_OPTCOMMON modules loaded. Setting this to
549          # yes may introduce some desyncs and weirdness.
550          allowmismatched="no"
551
552          # hostintopic: If enabled, channels will show the host of the topicsetter
553          # in the topic. If set to no, it will only show the nick of the topicsetter.
554          hostintopic="yes"
555
556          # pingwarning: If a server does not respond to a ping within x seconds,
557          # it will send a notice to opers with snomask +l informing that the server
558          # is about to ping timeout.
559          pingwarning="15"
560
561          # serverpingfreq: How often pings are sent between servers (in seconds).
562          serverpingfreq="60"
563
564          # defaultmodes: What modes are set on a empty channel when a user
565          # joins it and it is unregistered. This is similar to Asuka's
566          # autochanmodes.
567          defaultmodes="nt"
568
569          # moronbanner: This is the text that is sent to a user when they are
570          # banned from the server.
571          moronbanner="You're banned! Email haha@abuse.com with the ERROR line below for help."
572
573          # invitebypassmodes: This allows /invite to bypass other channel modes.
574          # (Such as +k, +j, +l, etc)
575          invitebypassmodes="yes">
576
577
578 #-#-#-#-#-#-#-#-#-#-#-# PERFORMANCE CONFIGURATION #-#-#-#-#-#-#-#-#-#-#
579 #                                                                     #
580
581 <performance
582              # netbuffersize: Size of the buffer used to recieve data from clients.
583              # The ircd may only read this amount of text in 1 go at any time.
584              netbuffersize="10240"
585
586              # maxwho: Maximum number of results to show in a /who query.
587              maxwho="4096"
588
589              # somaxconn: The maximum number of connections that may be waiting
590              # in the accept queue. This is *NOT* the total maximum number of
591              # connections per server. Some systems may only allow this to be up
592              # to 5, while others (such as linux and *BSD) default to 128.
593              somaxconn="128"
594
595              # softlimit: This optional feature allows a defined softlimit for
596              # connections. If defined, it sets a soft max connections value.
597              # must be lower than ./configure maxclients.
598              softlimit="12800"
599
600              # quietbursts: When syncing or splitting from a network, a server
601              # can generate a lot of connect and quit messages to opers with
602              # +C and +Q snomasks. Setting this to yes squelches those messages,
603              # which makes it easier for opers, but degrades the functionality of
604              # bots like BOPM during netsplits.
605              quietbursts="yes"
606
607              # nouserdns: If enabled, no DNS lookups will be performed on
608              # connecting users. This can save a lot of resources on very busy servers.
609              nouserdns="no">
610
611 #-#-#-#-#-#-#-#-#-#-#-# SECURITY CONFIGURATION  #-#-#-#-#-#-#-#-#-#-#-#
612 #                                                                     #
613
614 <security
615
616           # announceinvites: If this option is set, then invites are announced
617           # to the channel when a user invites another user. If you consider
618           # this to be unnecessary noise, set this to 'none'.
619           # To announce to all ops, set this to 'ops' and to announce to all users,
620           # set the value to 'all'. The value 'dynamic' will make the messages
621           # go to every user who has power of INVITE on the channel. This
622           # is the recommended setting.
623           announceinvites="dynamic"
624
625           # hidemodes: If enabled, then the listmodes given will be hidden
626           # from users below halfop. This is not recommended to be set on +b
627           # as it may break some functionality in popular clients such as mIRC.
628           hidemodes="eI"
629
630           # hideulines: If this value is set to yes, U-lined servers will
631           # be hidden from non-opers in /links and /map.
632           hideulines="no"
633
634           # flatlinks: If this value is set to yes, /map and /links will
635           # be flattened when shown to non-opers.
636           flatlinks="no"
637
638           # hidewhois: When defined, the given text will be used in place
639           # of the server a user is on when whoised by a non-oper. Most
640           # networks will want to set this to something like "*.netname.net"
641           # to conceal the actual server a user is on.
642           hidewhois=""
643
644           # hidebans: If this value is set to yes, when a user is banned ([gkz]lined)
645           # only opers will see the ban message when the user is removed
646           # from the server.
647           hidebans="no"
648
649           # hidekills: If defined, replaces who set a /kill with a custom string.
650           hidekills=""
651
652           # hidesplits: If enabled, non-opers will not be able to see which
653           # servers split in a netsplit, they will only be able to see that one
654           # occurred (If their client has netsplit detection).
655           hidesplits="no"
656
657           # maxtargets: Maximum number of targets per command.
658           # (Commands like /notice, /privmsg, /kick, etc)
659           maxtargets="20"
660
661           # customversion: Displays a custom string when a user /version's
662           # the ircd. This may be set for security reasons or vanity reasons.
663           customversion=""
664
665           # operspywhois: If this is set to yes, when a oper /whois 's a user,
666           # it will show all channels the user is in including +s and +p
667           # channels.
668           operspywhois="no"
669
670           # runasuser: If this is set, InspIRCd will attempt to setuid
671           # to run as this user- allows binding of ports under 1024.
672           # NOT SUPPORTED/NEEDED UNDER WINDOWS.
673           #runasuser=""
674
675           # runasgroup: If this is set, InspIRCd will attempt to set group
676           # to run under this group, which allows binding of ports under 1024
677           # NOT SUPPORTED/NEEDED UNDER WINDOWS.
678           #runasgroup=""
679
680           # restrictbannedusers: If this is set to yes, InspIRCd will not allow users
681           # banned on a channel to change nickname or message channels they are
682           # banned on.
683           restrictbannedusers="yes"
684
685           # genericoper: Setting this value to yes makes all opers on this server
686           # appear as 'is an IRC operator' in their WHOIS, regardless of their
687           # oper type, however oper types are still used internally. This only
688           # affects the display in WHOIS.
689           genericoper="no"
690
691           # userstats: /stats commands that users can run (opers can run all).
692           userstats="Pu">
693
694 #-#-#-#-#-#-#-#-#-#-#-#-# LIMITS CONFIGURATION  #-#-#-#-#-#-#-#-#-#-#-#
695 #                                                                     #
696 # This configuration tag defines the maximum sizes of various types   #
697 # on IRC, such as the maximum length of a channel name, and the       #
698 # maximum length of a channel. Note that with the exception of the    #
699 # identmax value all values given here are the exact values you would #
700 # expect to see on IRC. This contrasts with the older InspIRCd        #
701 # releases where these values would be one character shorter than     #
702 # defined to account for a null terminator on the end of the text.    #
703 #                                                                     #
704 # These values should match network-wide otherwise issues will occur. #
705 #                                                                     #
706 # The highest safe value you can set any of these options to is 500,  #
707 # but it is recommended that you keep them somewhat                   #
708 # near their defaults (or lower).                                     #
709
710 <limits
711         # maxnick: Maximum length of a nickname.
712         maxnick="31"
713
714         # maxchan: Maximum length of a channel name.
715         maxchan="64"
716
717         # maxmodes: Maximum number of mode changes per line.
718         maxmodes="20"
719
720         # maxident: Maximum length of a ident/username.
721         maxident="11"
722
723         # maxquit: Maximum length of a quit message.
724         maxquit="255"
725
726         # maxtopic: Maximum length of a channel topic.
727         maxtopic="307"
728
729         # maxkick: Maximum length of a kick message.
730         maxkick="255"
731
732         # maxgecos: Maximum length of a GECOS (realname).
733         maxgecos="128"
734
735         # maxaway: Maximum length of an away message.
736         maxaway="200">
737
738
739 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
740 # Logging
741 # -------
742 #
743 # Logging is covered with the <log> tag, which you may use to change
744 # the behaviour of the logging of the IRCd.
745 #
746 # In InspIRCd as of 1.2, logging is pluggable and very extensible.
747 # Different files can log the same thing, different 'types' of log can
748 # go to different places, and modules can even extend the log tag
749 # to do what they want.
750 #
751 # An example log tag would be:
752 #       <log method="file" type="OPER" level="default" target="opers.log">
753 # which  would log all information on /oper (failed and successful) to
754 # a file called opers.log.
755 #
756 # There are many different types which may be used, and modules may
757 # generate their own. A list of useful types:
758 #       - USERS - information relating to user connection and disconnection
759 #       - CHANNELS - information relating to joining and parting of channels.
760 # XXX someone doc more on this
761 #
762 # You may also log *everything* by using a type of *, and subtract things out
763 # of that by using -TYPE - for example "* -USERINPUT -USEROUTPUT".
764 #
765 # The following log tag is highly default and uncustomised. It is recommended you
766 # sort out your own log tags. This is just here so you get some output.
767
768 <log method="file" type="* -USERINPUT -USEROUTPUT -m_spanningtree" level="default" target="ircd.log">
769
770 #-#-#-#-#-#-#-#-#-#-#-#-#-  WHOWAS OPTIONS   -#-#-#-#-#-#-#-#-#-#-#-#-#
771 #                                                                     #
772 # This tag lets you define the behaviour of the /whowas command of    #
773 # your server.                                                        #
774 #                                                                     #
775
776 <whowas
777         # groupsize: Maximum entries per nick shown when performing
778         # a /whowas nick.
779         groupsize="10"
780
781         # maxgroups: Maximum number of nickgroups that can be added to
782         # the list so that /whowas does not use a lot of resources on
783         # large networks.
784         maxgroups="100000"
785
786         # maxkeep: Maximum time a nick is kept in the whowas list
787         # before being pruned. Time may be specified in seconds,
788         # or in the following format: 1y2w3d4h5m6s. Minimum is
789         # 1 hour.
790         maxkeep="3d">
791
792 #-#-#-#-#-#-#-#-#-#-#-#-#-#-  BAN OPTIONS  -#-#-#-#-#-#-#-#-#-#-#-#-#-#
793 #                                                                     #
794 # The ban tags define nick masks, host masks and ip ranges which are  #
795 # banned from your server. All details in these tags are local to     #
796 # Your server.                                                        #
797 #                                                                     #
798
799 <badip
800        # ipmask: IP range to ban. Wildcards and CIDR can be used.
801        ipmask="69.69.69.69"
802
803        # reason: Reason to display when user is disconnected.
804        reason="No porn here thanks.">
805
806 <badnick
807          # nick: Nick to disallow. Wildcards are supported.
808          nick="ChanServ"
809
810          # reason: Reason to display on /nick.
811          reason="Reserved For Services">
812
813 <badnick nick="NickServ" reason="Reserved For Services">
814 <badnick nick="OperServ" reason="Reserved For Services">
815 <badnick nick="MemoServ" reason="Reserved For Services">
816
817 <badhost
818          # host: ident@hostname to ban.
819          # Wildcards and CIDR (if you specify an IP) can be used.
820          host="*@hundredz.n.hundredz.o.1337.kiddies.com"
821
822          # reason: Reason to display when user is disconnected
823          reason="Too many 1337 kiddiots">
824
825 <badhost host="root@*" reason="Don't irc as root!">
826 <badhost host="*@172.32.0.0/16" reason="This subnet is bad.">
827
828 # exception: Hosts that are exempt from [kgz]lines.
829 <exception
830            # host: ident@hostname to exempt.
831            # Wildcards and CIDR (if you specify an IP) can be used.
832            host="*@ircop.host.com"
833
834            # reason: Reason for exception. Only shown in /stats e
835            reason="Opers hostname">
836
837 #-#-#-#-#-#-#-#-#-#-#- INSANE BAN OPTIONS  -#-#-#-#-#-#-#-#-#-#-#-#-#-#
838 #                                                                     #
839 # This optional tag allows you to specify how wide a gline, eline,    #
840 # kline, zline or qline can be before it is forbidden from being      #
841 # set. By setting hostmasks="yes", you can allow all G, K, E lines,   #
842 # no matter how many users the ban would cover. This is not           #
843 # recommended! By setting ipmasks="yes", you can allow all Z lines,   #
844 # no matter how many users these cover too. Needless to say we        #
845 # don't recommend you do this, or, set nickmasks="yes", which will    #
846 # allow any qline.                                                    #
847 #                                                                     #
848
849 <insane
850         # hostmasks: Allow bans with insane hostmasks. (over-reaching bans)
851         hostmasks="no"
852
853         # ipmasks: Allow bans with insane ipmasks. (over-reaching bans)
854         ipmasks="no"
855
856         # nickmasks: Allow bans with insane nickmasks. (over-reaching bans)
857         nickmasks="no"
858
859         # trigger: What percentage of users on the network to trigger
860         # specifying an insane ban as. The default is 95.5%, which means
861         # if you have a 1000 user network, a ban will not be allowed if it
862         # will be banning 955 or more users.
863         trigger="95.5">
864
865
866 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#- YAWN  -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
867 #                                                                     #
868 #   You should already know what to do here :)                        #
869
870 <die value="User error. Insert new user and press any key. (you didn't edit your config properly.)">
871
872 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# MODULES #-#-#-#-#-#-#-#-#-#-#-#-#-#-#
873 #    ____                _   _____ _     _       ____  _ _   _        #
874 #   |  _ \ ___  __ _  __| | |_   _| |__ (_)___  | __ )(_) |_| |       #
875 #   | |_) / _ \/ _` |/ _` |   | | | '_ \| / __| |  _ \| | __| |       #
876 #   |  _ <  __/ (_| | (_| |   | | | | | | \__ \ | |_) | | |_|_|       #
877 #   |_| \_\___|\__,_|\__,_|   |_| |_| |_|_|___/ |____/|_|\__(_)       #
878 #                                                                     #
879 # Well done, you've reached the end of the basic configuration, your  #
880 # ircd should now start if you want to try it out! (./inspircd start) #
881 #                                                                     #
882 # We now suggest you read and edit modules.conf, as modules are what  #
883 # provide almost all the features of InspIRCd. :)                     #
884 #                                                                     #
885 # The default does nothing -- we include it for simplicity for you.   #
886 <include file="conf/modules.conf.example">
887
888 # Here are some pre-built modules.conf files that closely match the
889 # default configurations of some popular IRCd's. You still may want to
890 # look over them and make sure if everything is correct for you and setup
891 # the proper SSL information.
892 #
893 # *NOTE*: These files have no comments for what the modules do. If you
894 # are interested in that, please read the modules.conf.example. It is also
895 # recommended that you make your own modules file based on modules.conf.example.
896
897 # Settings similar to UnrealIRCd defaults.
898 #<include file="conf/modules/modules.conf.unreal">
899
900 # Settings similar to Charybdis IRCd defaults.
901 #<include file="conf/modules/modules.conf.charybdis">
902
903
904 #########################################################################
905 #                                                                       #
906 #                     - InspIRCd Development Team -                     #
907 #                        http://www.inspircd.org                        #
908 #                                                                       #
909 #########################################################################