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