]> git.netwichtig.de Git - user/henk/code/inspircd.git/blob - docs/conf/inspircd.conf.example
Rename `<bind:ssl>` to `<bind:sslprofile>`.
[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 #-#-#-#-#-#-#-#-#-#  CONFIGURATION FORMAT  #-#-#-#-#-#-#-#-#-#-#-#-#-#-
38 #                                                                     #
39 # In order to maintain compatibility with older configuration files,  #
40 # you can change the configuration parser to parse as it did in       #
41 # previous releases. When using the "compat" format, you need to use  #
42 # C++ escape sequences (e.g. \n) instead of XML ones (e.g. &nl;) and  #
43 # can not use <define> to create macros.                              #
44 #<config format="compat">
45
46 #-#-#-#-#-#-#-#-#-#  INCLUDE CONFIGURATION  #-#-#-#-#-#-#-#-#-#-#-#-#-#
47 #                                                                     #
48 # This optional tag allows you to include another config file         #
49 # allowing you to keep your configuration tidy. The configuration     #
50 # file you include will be treated as part of the configuration file  #
51 # which includes it, in simple terms the inclusion is transparent.    #
52 #                                                                     #
53 # All paths to config files are relative to the config directory.     #
54 #                                                                     #
55 # You may also include an executable file, in which case if you do so #
56 # the output of the executable on the standard output will be added   #
57 # to your config at the point of the include tag.                     #
58 #                                                                     #
59 # Syntax is as follows:                                               #
60 #<include file="file.conf">                                           #
61 #<include directory="modules">                                        #
62 #<include executable="/path/to/executable parameters">                #
63 #                                                                     #
64 # Executable include example:                                         #
65 #<include executable="/usr/bin/wget -q -O - https://example.com/inspircd.conf">
66 #                                                                     #
67
68
69 #-#-#-#-#-#-#-#-#-#-#-#  VARIABLE DEFINITIONS  -#-#-#-#-#-#-#-#-#-#-#-#
70 #                                                                     #
71 # You can define variables that will be substituted later in the      #
72 # configuration file. This can be useful to allow settings to be      #
73 # easily changed, or to parameterize a remote includes.               #
74 #                                                                     #
75 # Variables may be redefined and may reference other variables.       #
76 # Value expansion happens at the time the tag is read.                #
77 <define name="bindip" value="1.2.2.3">
78 <define name="localips" value="&bindip;/24">
79
80 #-#-#-#-#-#-#-#-#-#-#-#-  SERVER DESCRIPTION  -#-#-#-#-#-#-#-#-#-#-#-#-
81 #                                                                     #
82 #   Here is where you enter the information about your server.        #
83 #                                                                     #
84
85 <server
86         # name: Hostname of your server. Does not need to resolve, but
87         # does need to be correct syntax (something.somethingelse.tld).
88         name="penguin.omega.example.org"
89
90         # description: Server description. Spaces are allowed.
91         description="Waddle World"
92
93         # id: The SID to use for this server. This should not be uncommented
94         # unless there is a SID conflict. This must be three characters long.
95         # The first character must be a digit [0-9], the remaining two chars
96         # may be letters [A-Z] or digits.
97         #id="97K"
98
99         # network: Network name given on connect to clients.
100         # Should be the same on all servers on the network.
101         network="Omega">
102
103
104 #-#-#-#-#-#-#-#-#-#-#-#-   ADMIN INFORMATION   -#-#-#-#-#-#-#-#-#-#-#-#
105 #                                                                     #
106 #   Describes the Server Administrator's real name (optionally),      #
107 #   nick, and email address.                                          #
108 #                                                                     #
109
110 <admin
111        # name: Real Name
112        name="Johnny English"
113
114        # nick: Nickname (preferably what you use on the network)
115        nick="MI5"
116
117        # email: email address. Does not have to be valid
118        # but should be for the users to be able to contact you.
119        email="MI5@the.best.secret.agent">
120
121
122 #-#-#-#-#-#-#-#-#-#-#-#-   PORT CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-
123 #                                                                     #
124 #   Configure the port and address bindings here.                     #
125 #                                                                     #
126
127 # TLS (SSL) listener that binds on a TCP/IP endpoint:
128 <bind
129       # address: IP address to bind to if the box that you are hosting
130       # on has more than one IP, else the ircd will try to bind to all
131       # IP's on the box if this is not defined.
132       address=""
133
134       # port: Port for users or servers to be able to connect to.
135       # you can select multiple ports by separating them
136       # with a - character like the example below.
137       port="6697"
138
139       # type: Type of bind block this is. It can either be clients or
140       # servers. Whichever you select will be the only type able to connect
141       # to this bind section.
142       type="clients"
143
144       # sslprofile: If you want the port(s) in this bind tag to use TLS (SSL), set this
145       # to the name of a custom <sslprofile> tag that you have defined. See the
146       # docs page for the TLS (SSL) module you are using for more details:
147       #
148       # GnuTLS:  https://docs.inspircd.org/3/modules/ssl_gnutls#sslprofile
149       # mbedTLS: https://docs.inspircd.org/3/modules/ssl_mbedtls#sslprofile
150       # OpenSSL: https://docs.inspircd.org/3/modules/ssl_openssl#sslprofile
151       #
152       # You will need to load the ssl_openssl module for OpenSSL, ssl_gnutls
153       # for GnuTLS and ssl_mbedtls for mbedTLS.
154       sslprofile="Clients"
155
156       # defer: When this is non-zero, connections will not be handed over to
157       # the daemon from the operating system before data is ready.
158       # In Linux, the value indicates the time period we'll wait for a
159       # connection to come up with data. Don't set it too low!
160       # In BSD the value is ignored; only zero and non-zero is possible.
161       # Windows ignores this parameter completely.
162       # Note: This does not take effect on rehash.
163       # To change it on a running bind, you'll have to comment it out,
164       # rehash, comment it in and rehash again.
165       defer="0"
166
167       # free: When this is enabled the listener will be created regardless of
168       # whether the interface that provides the bind address is available. This
169       # is useful for if you are starting InspIRCd on boot when the server may
170       # not have brought the network interfaces up yet.
171       free="no">
172
173 # Plaintext listener that binds on a TCP/IP endpoint:
174 <bind address="" port="6667" type="clients">
175
176
177 # Listener that binds on a UNIX endpoint (not supported on Windows):
178 #<bind
179
180     # path: The location to store the UNIX socket
181     #path="/tmp/inspircd.sock"
182
183     # type: Type of bind block this is. It can either be clients or
184     # servers. Whichever you select will be the only type able to connect
185     # to this bind section.
186     #type="clients"
187
188     # permissions: The octal permissions to set on the UNIX socket after it has
189     # been created. If you are not familiar with octal permissions you should
190     # not define this or refer to http://permissions-calculator.org for help.
191     # Note: This does not take effect on rehash.
192     # To change it on a running bind, you'll have to comment it out,
193     # rehash, comment it in and rehash again.
194     #permissions=""
195
196     # replace: if the UNIX socket path already exists then remove it before
197     # attempting to create the new one. This is strongly recommended as it
198     # allows InspIRCd to create sockets in cases where it previously did not
199     # shut down cleanly and left a zombie socket behind.
200     #replace="yes">
201
202
203 # Listener accepting HTML5 WebSocket connections.
204 # Requires the websocket module and SHA-1 hashing support (provided by the sha1
205 # module).
206 #<bind address="" port="7002" type="clients" hook="websocket">
207
208
209 # You can define a custom <sslprofile> tag which defines the TLS (SSL) configuration
210 # for these listeners. See the docs page for the TLS (SSL) module you are using for
211 # more details.
212 #
213 # Alternatively, you can use one of the default TLS (SSL) profiles which are created
214 # when you have not defined any:
215 #   "openssl" (requires the ssl_openssl module)
216 #   "gnutls" (requires the ssl_gnutls module)
217 #   "mbedtls" (requires the ssl_mbedtls module)
218 #
219 # When linking servers, the OpenSSL, GnuTLS, and mbedTLS implementations are
220 # completely link-compatible and can be used alongside each other on each end
221 # of the link without any significant issues.
222
223
224 #-#-#-#-#-#-#-#-#-#-  CONNECTIONS CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#
225 #                                                                     #
226 #   This is where you can configure which connections are allowed     #
227 #   and denied access onto your server. The password is optional.     #
228 #   You may have as many of these as you require. To allow/deny all   #
229 #   connections, use a '*' or 0.0.0.0/0.                              #
230 #                                                                     #
231 #  -- It is important to note that connect tags are read from the  -- #
232 #     TOP DOWN. This means that you should have more specific deny    #
233 #    and allow tags at the top, progressively more general, followed  #
234 #        by a <connect allow="*"> (should you wish to have one).      #
235 #                                                                     #
236 # Connect blocks are searched twice for each user - once when the TCP #
237 # connection is accepted, and once when the user completes their      #
238 # registration. Most of the information (hostname, ident response,    #
239 # password, TLS (SSL) when using STARTTLS, etc) is only available     #
240 # during the second search. If you are trying to make a closed server #
241 # you will probably need a connect block just for user registration.  #
242 # This can be done by using <connect registered="no">                 #
243
244 # To enable IRCCloud on your network uncomment this:
245 #<include file="examples/providers/irccloud.conf.example">
246
247 # A connect class with <connect:deny> set denies connections from the specified host/IP range.
248 <connect
249          # deny: Will not let people connect if they have specified host/IP.
250          deny="3ffe::0/32"
251
252          # reason: The message that users will see if they match a deny block.
253          reason="The 6bone address space is deprecated">
254
255 # A connect class with <connect:allow> set allows c from the specified host/IP range.
256 <connect
257          # name: Name to use for this connect block. Mainly used for
258          # connect class inheriting.
259          name="secret"
260
261          # parent: This setting is to specify if this connect class
262          # inherits settings from any other. Put the other class's name
263          # in here to use its settings as a template - for example,  if
264          # you only want to adjust sendq and a password
265          parent="main"
266
267          # allow: The IP address or hostname of clients that can use this
268          # class. You can specify either an exact match, a glob match, or
269          # a CIDR range here.
270          allow="203.0.113.*"
271
272          # hash: the hash function this password is hashed with. Requires the
273          # module for the selected function (bcrypt, md5, sha1, or sha256) and
274          # the password hashing module (password_hash) to be loaded.
275          #
276          # You may also use any of the above other than bcrypt prefixed with
277          # either "hmac-" or "pbkdf2-hmac-" (requires the pbkdf2 module).
278          # Create hashed passwords with: /MKPASSWD <hashtype> <plaintext>
279          #hash="bcrypt"
280
281          # password: Password to use for this block/user(s)
282          password="secret"
283
284          # maxchans: Maximum number of channels a user in this class
285          # can be in at one time.
286          maxchans="20"
287
288          # timeout: How long the server will wait before disconnecting
289          # a user if they do not do anything on connect.
290          # (Note, this is a client-side thing, if the client does not
291          # send /NICK, /USER or /PASS)
292          timeout="20"
293
294          # localmax: Maximum local connections per IP (or CIDR mask, see below).
295          localmax="3"
296
297          # globalmax: Maximum global (network-wide) connections per IP (or CIDR mask, see below).
298          globalmax="3"
299
300          # maxconnwarn: Enable warnings when localmax or globalmax are reached (defaults to yes)
301          maxconnwarn="no"
302
303          # resolvehostnames: If disabled, no DNS lookups will be performed on connecting users
304          # in this class. This can save a lot of resources on very busy servers.
305          resolvehostnames="yes"
306
307          # useconnectban: Defines if users in this class should be exempt from connectban limits.
308          # This setting only has effect when the connectban module is loaded.
309          #useconnectban="yes"
310
311          # useconnflood: Defines if users in this class should be exempt from connflood limits.
312          # This setting only has effect when the connflood module is loaded.
313          #useconnflood="yes"
314
315          # usednsbl: Defines whether or not users in this class are subject to DNSBL. Default is yes.
316          # This setting only has effect when the dnsbl module is loaded.
317          #usednsbl="yes"
318
319          # useident: Defines if users in this class MUST respond to a ident query or not.
320          useident="no"
321
322          # usests: Whether a STS policy should be advertised to users in this class.
323          # This setting only has effect when the ircv3_sts module is loaded.
324          #usests="no"
325
326          # webirc: Restricts usage of this class to the specified WebIRC gateway.
327          # This setting only has effect when the cgiirc module is loaded.
328          #webirc="name"
329
330          # limit: How many users are allowed in this class
331          limit="5000"
332
333          # modes: User modes that are set on users in this block on connect.
334          # Enabling this option requires that the conn_umodes module be loaded.
335          # This entry is highly recommended to use for/with IP cloaking/masking.
336          # For the example to work, this also requires that the cloaking
337          # module be loaded as well.
338          modes="+x"
339
340          # requireident: Require that users of this block have a valid ident response.
341          # Requires the ident module to be loaded.
342          #requireident="yes"
343
344          # requiressl: Require that users of this block use a TLS (SSL) connection.
345          # This can also be set to "trusted", as to only accept client certificates
346          # issued by a certificate authority that you can configure in the
347          # settings of the TLS (SSL) module that you're using.
348          # Requires the sslinfo module to be loaded.
349          #requiressl="yes"
350
351          # requireaccount: Require that users of this block have authenticated to a
352          # services account.
353          # NOTE: You must complete the signon prior to full connection. Currently,
354          # this is only possible by using SASL authentication; passforward
355          # and PRIVMSG NickServ happen after your final connect block has been found.
356          # Requires the services_account module to be loaded.
357          #requireaccount="yes"
358
359          # Alternate MOTD file for this connect class. The contents of this file are
360          # specified using <files secretmotd="filename"> or <execfiles ...>
361          #
362          # NOTE: the following escape sequences for IRC formatting characters can be
363          # used in your MOTD:
364          # Bold:          \b
365          # Color:         \c<fg>[,<bg>]
366          # Italic:        \i
367          # Monospace:     \m  (not widely supported)
368          # Reset:         \x
369          # Reverse:       \r
370          # Strikethrough: \s  (not widely supported)
371          # Underline:     \u
372          # See https://defs.ircdocs.horse/info/formatting.html for more information
373          # on client support for formatting characters.
374          motd="secretmotd"
375
376          # port: What port range this user is allowed to connect on. (optional)
377          # The ports MUST be set to listen in the bind blocks above.
378          port="6697,9999">
379
380 <connect
381          # name: Name to use for this connect block. Mainly used for
382          # connect class inheriting.
383          name="main"
384
385          # allow: The IP address or hostname of clients that can use this
386          # class. You can specify either an exact match, a glob match, or
387          # a CIDR range here.
388          allow="*"
389
390          # maxchans: Maximum number of channels a user in this class
391          # can be in at one time.
392          maxchans="20"
393
394          # timeout: How long the server will wait before disconnecting
395          # a user if they do not do anything on connect.
396          # (Note, this is a client-side thing, if the client does not
397          # send /NICK, /USER or /PASS)
398          timeout="20"
399
400          # pingfreq: How often the server tries to ping connecting clients.
401          pingfreq="2m"
402
403          # hardsendq: maximum amount of data allowed in a client's send queue
404          # before they are dropped. Keep this value higher than the length of
405          # your network's /LIST or /WHO output, or you will have lots of
406          # disconnects from sendq overruns!
407          # Setting this to "1M" is equivalent to "1048576", "8K" is 8192, etc.
408          hardsendq="1M"
409
410          # softsendq: amount of data in a client's send queue before the server
411          # begins delaying their commands in order to allow the sendq to drain
412          softsendq="10240"
413
414          # recvq: amount of data allowed in a client's queue before they are dropped.
415          # Entering "10K" is equivalent to "10240", see above.
416          recvq="10K"
417
418          # threshold: This specifies the amount of command penalty a user is allowed to have
419          # before being quit or fakelagged due to flood. Normal commands have a penalty of 1,
420          # ones such as /OPER have penalties up to 10.
421          #
422          # If you are not using fakelag, this should be at least 20 to avoid excess flood kills
423          # from processing some commands.
424          threshold="10"
425
426          # commandrate: This specifies the maximum rate that commands can be processed.
427          # If commands are sent more rapidly, the user's penalty will increase and they will
428          # either be fakelagged or killed when they reach the threshold
429          #
430          # Units are millicommands per second, so 1000 means one line per second.
431          commandrate="1000"
432
433          # fakelag: Use fakelag instead of killing users for excessive flood
434          #
435          # Fake lag stops command processing for a user when a flood is detected rather than
436          # immediately killing them; their commands are held in the recvq and processed later
437          # as the user's command penalty drops. Note that if this is enabled, flooders will
438          # quit with "RecvQ exceeded" rather than "Excess Flood".
439          fakelag="yes"
440
441          # localmax: Maximum local connections per IP.
442          localmax="3"
443
444          # globalmax: Maximum global (network-wide) connections per IP.
445          globalmax="3"
446
447          # resolvehostnames: If disabled, no DNS lookups will be performed on connecting users
448          # in this class. This can save a lot of resources on very busy servers.
449          resolvehostnames="yes"
450
451          # useident: Defines if users in this class must respond to a ident query or not.
452          useident="no"
453
454          # usests: Whether a STS policy should be advertised to users in this class.
455          # This setting only has effect when the ircv3_sts module is loaded.
456          #usests="no"
457
458          # limit: How many users are allowed in this class
459          limit="5000"
460
461          # modes: User modes that are set on users in this block on connect.
462          # Enabling this option requires that the conn_umodes module be loaded.
463          # This entry is highly recommended to use for/with IP cloaking/masking.
464          # For the example to work, this also requires that the cloaking
465          # module be loaded as well.
466          modes="+x">
467
468
469
470 #-#-#-#-#-#-#-#-#-#-#-#-  CIDR CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-
471 #                                                                     #
472 # CIDR configuration allows detection of clones and applying of       #
473 # throttle limits across a CIDR range. (A CIDR range is a group of    #
474 # IPs, for example, the CIDR range 192.168.1.0-192.168.1.255 may be   #
475 # represented as 192.168.1.0/24). This means that abuse across an ISP #
476 # is detected and curtailed much easier. Here is a good chart that    #
477 # shows how many IPs the different CIDRs correspond to:               #
478 # https://en.wikipedia.org/wiki/IPv4_subnetting_reference             #
479 # https://en.wikipedia.org/wiki/IPv6_subnetting_reference             #
480 #                                                                     #
481
482 <cidr
483       # ipv4clone: specifies how many bits of an IP address should be
484       # looked at for clones. The default only looks for clones on a
485       # single IP address of a user. You do not want to set this
486       # extremely low. (Values are 0-32).
487       ipv4clone="32"
488
489       # ipv6clone: specifies how many bits of an IP address should be
490       # looked at for clones. The default only looks for clones on a
491       # single IP address of a user. You do not want to set this
492       # extremely low. (Values are 0-128).
493       ipv6clone="128">
494
495 # This file has all the information about oper classes, types and o:lines.
496 # You *MUST* edit it.
497 #<include file="examples/opers.conf.example">
498
499 # This file has all the information about server links and ulined servers.
500 # You *MUST* edit it if you intend to link servers.
501 #<include file="examples/links.conf.example">
502
503 #-#-#-#-#-#-#-#-#-#-  MISCELLANEOUS CONFIGURATION  -#-#-#-#-#-#-#-#-#-#
504 #                                                                     #
505
506 # Files block - contains files whose contents are used by the ircd
507 #
508 #   motd - displayed on connect and when a user executes /MOTD
509 # Modules can also define their own files
510 <files motd="examples/motd.txt.example">
511
512 # Example of an executable file include. Note this will be read on rehash,
513 # not when the command is run.
514 #<execfiles motd="wget -O - https://www.example.com/motd.txt">
515
516 #-#-#-#-#-#-#-#-#-#-#-#-#-#-# DNS SERVER -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
517 # If these values are not defined, InspIRCd uses the default DNS resolver
518 # of your system.
519
520 <dns
521      # server: DNS server to use to attempt to resolve IP's to hostnames.
522      # in most cases, you won't need to change this, as inspircd will
523      # automatically detect the nameserver depending on /etc/resolv.conf
524      # (or, on Windows, your set nameservers in the registry.)
525      # Note that this must be an IP address and not a hostname, because
526      # there is no resolver to resolve the name until this is defined!
527      #
528      # server="127.0.0.1"
529
530      # timeout: time to wait to try to resolve DNS/hostname.
531      timeout="5">
532
533 # An example of using an IPv6 nameserver
534 #<dns server="::1" timeout="5">
535
536 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#  PID FILE  -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
537 #                                                                     #
538 # Define the path to the PID file here. The PID file can be used to   #
539 # rehash the ircd from the shell or to terminate the ircd from the    #
540 # shell using shell scripts, perl scripts, etc... and to monitor the  #
541 # ircd's state via cron jobs. If this is a relative path, it will be  #
542 # relative to the runtime directory, and if it is not defined, the    #
543 # default of 'inspircd.pid' is used.                                  #
544 #                                                                     #
545
546 #<pid file="/path/to/inspircd.pid">
547
548 #-#-#-#-#-#-#-#-#-#-#-#-#- LIST MODE LIMITS #-#-#-#-#-#-#-#-#-#-#-#-#-#
549 #                                                                     #
550 # The <maxlist> tag is used customise the maximum number of each list #
551 # mode that can be set on a channel.                                  #
552 # The tags are read from top to bottom and the list mode limit from   #
553 # the first tag found which matches the channel name and mode type is #
554 # applied to that channel.                                            #
555 # It is advisable to put an entry with the channel as '*' at the      #
556 # bottom of the list. If none are specified or no maxlist tag is      #
557 # matched, the banlist size defaults to 100 entries.                  #
558 #                                                                     #
559
560 # Allows #largechan to have up to 200 ban entries.
561 #<maxlist mode="ban" chan="#largechan" limit="200">
562
563 # Allows #largechan to have up to 200 ban exception entries.
564 #<maxlist mode="e" chan="#largechan" limit="200">
565
566 # Allows all channels and list modes not previously matched to have
567 # up to 100 entries.
568 <maxlist chan="*" limit="100">
569
570 #-#-#-#-#-#-#-#-#-#-#-#-#-  SERVER OPTIONS   -#-#-#-#-#-#-#-#-#-#-#-#-#
571 #                                                                     #
572 #   Settings to define which features are usable on your server.      #
573 #                                                                     #
574
575 <options
576          # prefixquit: What (if anything) users' quit messages
577          # should be prefixed with.
578          prefixquit="Quit: "
579
580          # suffixquit: What (if anything) users' quit messages
581          # should be suffixed with.
582          suffixquit=""
583
584          # prefixpart: What (if anything) users' part messages
585          # should be prefixed with.
586          prefixpart="&quot;"
587          # NOTE: Use "\"" instead of "&quot;" if not using <config format="xml">
588
589          # suffixpart: What (if anything) users' part message
590          # should be suffixed with.
591          suffixpart="&quot;"
592
593          # fixedquit: Set all users' quit messages to this value.
594          #fixedquit=""
595
596          # fixedpart: Set all users' part messages in all channels
597          # to this value.
598          #fixedpart=""
599
600          # syntaxhints: If enabled, if a user fails to send the correct parameters
601          # for a command, the ircd will give back some help text of what
602          # the correct parameters are.
603          syntaxhints="no"
604
605          # casemapping: This sets the case mapping method to be used by the
606          # server. This MUST be the same on all servers. Possible values are:
607          # "ascii" (recommended)
608          # "rfc1459" (default, required for linking to 2.0 servers)
609          # NOTE: if you are using the nationalchars module this setting will be
610          # ignored. You should use <nationalchars:casemapping> instead.
611          casemapping="ascii"
612
613          # cyclehostsfromuser: If enabled, the source of the mode change for
614          # cyclehosts will be the user who cycled. This can look nicer, but
615          # triggers anti-takeover mechanisms of some obsolete bots.
616          cyclehostsfromuser="no"
617
618          # announcets: If set to yes, when the timestamp on a channel changes, all users
619          # in the channel will be sent a NOTICE about it.
620          announcets="yes"
621
622          # allowmismatch: Setting this option to yes will allow servers to link even
623          # if they don't have the same "optionally common" modules loaded. Setting this to
624          # yes may introduce some desyncs and unwanted behaviour.
625          allowmismatch="no"
626
627          # defaultbind: Sets the default for <bind> tags without an address. Choices are
628          # ipv4 or ipv6; if not specified, IPv6 will be used if your system has support,
629          # falling back to IPv4 otherwise.
630          defaultbind="auto"
631
632          # hostintopic: If enabled, channels will show the host of the topic setter
633          # in the topic. If set to no, it will only show the nick of the topic setter.
634          hostintopic="yes"
635
636          # pingwarning: If a server does not respond to a ping within this period,
637          # it will send a notice to opers with snomask +l informing that the server
638          # is about to ping timeout.
639          pingwarning="15"
640
641          # serverpingfreq: How often pings are sent between servers.
642          serverpingfreq="1m"
643
644          # splitwhois: Whether to split private/secret channels from normal channels
645          # in WHOIS responses. Possible values for this are:
646          # 'no' - list all channels together in the WHOIS response regardless of type.
647          # 'split' - split private/secret channels to a separate WHOIS response numeric.
648          # 'splitmsg' - the same as split but also send a message explaining the split.
649          splitwhois="no"
650
651          # defaultmodes: What modes are set on a empty channel when a user
652          # joins it and it is unregistered.
653          defaultmodes="not"
654
655          # xlinemessage: This is the text that is sent to a user when they are
656          # banned from the server.
657          xlinemessage="You're banned! Email irc@example.com with the ERROR line below for help."
658
659          # allowzerolimit: If enabled then allow a limit of 0 to be set on channels.
660          # This is non-standard behaviour and should only be enabled if you need to
661          # link with servers running 2.0. Defaults to yes.
662          allowzerolimit="no"
663
664          # modesinlist: If enabled then the current channel modes will be shown
665          # in the /LIST response. Defaults to yes.
666          modesinlist="no"
667
668          # exemptchanops: Allows users with with a status mode to be exempt
669          # from various channel restrictions. Possible restrictions are:
670          #  - anticaps        Channel mode +B - blocks messages with too many capital
671          #                    letters (requires the anticaps module).
672          #  - auditorium-see  Permission required to see the full user list of
673          #                    a +u channel (requires the auditorium module).
674          #  - auditorium-vis  Permission required to be visible in a +u channel
675          #                    (requires the auditorium module).
676          #  - blockcaps       Channel mode +B - blocks messages with too many capital
677          #                    letters (requires the blockcaps module).
678          #  - blockcolor      Channel mode +c - blocks messages with formatting codes
679          #                    (requires the blockcolor module).
680          #  - censor          Channel mode +G - censors messages based on the network
681          #                    configuration (requires the censor module).
682          #  - filter          Channel mode +g - blocks messages containing the given
683          #                    glob mask (requires the chanfilter module).
684          #  - flood           Channel mode +f - kicks (and bans) on text flood of a
685          #                    specified rate (requires the messageflood module).
686          #  - nickflood       Channel mode +F - blocks nick changes after a specified
687          #                    rate (requires the nickflood module).
688          #  - noctcp          Channel mode +C - blocks any CTCPs to the channel
689          #                    (requires the noctcp module).
690          #  - nonick          Channel mode +N - prevents users on the channel from
691          #                    changing nicks (requires the nonicks module).
692          #  - nonotice        Channel mode +T - blocks /NOTICEs to the channel
693          #                    (requires the nonotice module).
694          #  - regmoderated    Channel mode +M - blocks unregistered users from
695          #                    speaking (requires the services account module).
696          #  - stripcolor      Channel mode +S - strips formatting codes from
697          #                    messages (requires the stripcolor module).
698          #  - topiclock       Channel mode +t - limits changing the topic to (half)ops
699          # You can also configure this on a per-channel basis with a channel mode and
700          # even negate the configured exemptions below.
701          # See exemptchanops in modules.conf.example for more details.
702          exemptchanops="censor:o filter:o nickflood:o nonick:v regmoderated:o"
703
704          # invitebypassmodes: This allows /INVITE to bypass other channel modes.
705          # (Such as +k, +j, +l, etc.)
706          invitebypassmodes="yes"
707
708          # nosnoticestack: This prevents snotices from 'stacking' and giving you
709          # the message saying '(last message repeated X times)'. Defaults to no.
710          nosnoticestack="no">
711
712
713 #-#-#-#-#-#-#-#-#-#-#-# PERFORMANCE CONFIGURATION #-#-#-#-#-#-#-#-#-#-#
714 #                                                                     #
715
716 <performance
717              # netbuffersize: Size of the buffer used to receive data from clients.
718              # The ircd may only read this amount of text in 1 go at any time.
719              netbuffersize="10240"
720
721              # somaxconn: The maximum number of connections that may be waiting
722              # in the accept queue. This is *NOT* the total maximum number of
723              # connections per server. Some systems may only allow this to be up
724              # to 5, while others (such as Linux and *BSD) default to 128.
725              # Setting this above the limit imposed by your OS can have undesired
726              # effects.
727              somaxconn="128"
728
729              # softlimit: This optional feature allows a defined softlimit for
730              # connections. If defined, it sets a soft max connections value.
731              softlimit="12800"
732
733              # clonesonconnect: If this is set to no, we won't check for clones
734              # on initial connection, but only after the DNS check is done.
735              # This can be useful where your main class is more restrictive
736              # than some other class a user can be assigned after DNS lookup is complete.
737              # Turning this option off will make the server spend more time on users we may
738              # potentially not want. Normally this should be negligible, though.
739              # Default value is yes
740              clonesonconnect="yes"
741
742              # timeskipwarn: The time period that a server clock can jump by before
743              # operators will be warned that the server is having performance issues.
744              timeskipwarn="2s"
745
746              # quietbursts: When syncing or splitting from a network, a server
747              # can generate a lot of connect and quit messages to opers with
748              # +C and +Q snomasks. Setting this to yes squelches those messages,
749              # which makes it easier for opers, but degrades the functionality of
750              # bots like BOPM during netsplits.
751              quietbursts="yes">
752
753 #-#-#-#-#-#-#-#-#-#-#-# SECURITY CONFIGURATION  #-#-#-#-#-#-#-#-#-#-#-#
754 #                                                                     #
755
756 <security
757           # allowcoreunload: If this value is set to yes, Opers will be able to
758           # unload core modules (e.g. core_privmsg).
759           allowcoreunload="no"
760
761           # announceinvites: This option controls which members of the channel
762           # receive an announcement when someone is INVITEd. Available values:
763           # 'none' - don't send invite announcements
764           # 'all' - send invite announcements to all members
765           # 'ops' - send invite announcements to ops and higher ranked users
766           # 'dynamic' - send invite announcements to halfops (if available) and
767           #             higher ranked users. This is the recommended setting.
768           announceinvites="dynamic"
769
770           # hideulines: If this value is set to yes, U-lined servers will
771           # be hidden from non-opers in /LINKS and /MAP.
772           hideulines="no"
773
774           # flatlinks: If this value is set to yes, /MAP and /LINKS will
775           # be flattened when shown to non-opers.
776           flatlinks="no"
777
778           # hideserver: When defined, the given text will be used in place
779           # of the server name in public messages. As with <server:name> this
780           # does not need to resolve but does need to be a valid hostname.
781           #
782           # NOTE: enabling this will cause users' idle times to only be shown
783           # when a remote whois (/WHOIS <nick> <nick>) is used.
784           #hideserver="*.example.com"
785
786           # hidebans: If this value is set to yes, when a user is banned ([KGZ]-lined)
787           # only opers will see the ban message when the user is removed
788           # from the server.
789           hidebans="no"
790
791           # hidekills: If defined, replaces who executed a /KILL with a custom string.
792           hidekills=""
793
794           # hideulinekills: Hide kills from clients of ulined servers from server notices.
795           hideulinekills="yes"
796
797           # hidesplits: If enabled, non-opers will not be able to see which
798           # servers split in a netsplit, they will only be able to see that one
799           # occurred (If their client has netsplit detection).
800           hidesplits="no"
801
802           # maxtargets: Maximum number of targets per command.
803           # (Commands like /NOTICE, /PRIVMSG, /KICK, etc)
804           maxtargets="20"
805
806           # customversion: A custom message to be displayed in the comments field
807           # of the VERSION command response. This does not hide the InspIRCd version.
808           customversion=""
809
810           # runasuser: If this is set, InspIRCd will attempt to switch
811           # to run as this user, which allows binding of ports under 1024.
812           # You should NOT set this unless you are starting as root.
813           # NOT SUPPORTED/NEEDED UNDER WINDOWS.
814           #runasuser=""
815
816           # runasgroup: If this is set, InspIRCd will attempt to switch
817           # to run as this group, which allows binding of ports under 1024.
818           # You should NOT set this unless you are starting as root.
819           # NOT SUPPORTED/NEEDED UNDER WINDOWS.
820           #runasgroup=""
821
822           # restrictbannedusers: If this is set to yes, InspIRCd will not allow users
823           # banned on a channel to change nickname or message channels they are
824           # banned on. This can also be set to silent to restrict the user but not
825           # notify them.
826           restrictbannedusers="yes"
827
828           # genericoper: Setting this value to yes makes all opers on this server
829           # appear as 'is a server operator' in their WHOIS, regardless of their
830           # oper type, however oper types are still used internally. This only
831           # affects the display in WHOIS.
832           genericoper="no"
833
834           # userstats: /STATS commands that users can run (opers can run all).
835           userstats="Pu">
836
837 #-#-#-#-#-#-#-#-#-#-#-#-# LIMITS CONFIGURATION  #-#-#-#-#-#-#-#-#-#-#-#
838 #                                                                     #
839 # This configuration tag defines the maximum sizes of various types   #
840 # on IRC, such as the maximum length of a channel name, and the       #
841 # maximum length of a channel. These values should match network-wide #
842 # otherwise issues will occur.                                        #
843 #                                                                     #
844 # The highest safe value you can set any of these options to is 500,  #
845 # but it is recommended that you keep them somewhat                   #
846 # near their defaults (or lower).                                     #
847
848 <limits
849         # maxnick: Maximum length of a nickname.
850         maxnick="30"
851
852         # maxchan: Maximum length of a channel name.
853         maxchan="64"
854
855         # maxmodes: Maximum number of mode changes per line.
856         maxmodes="20"
857
858         # maxident: Maximum length of a ident/username.
859         maxident="10"
860
861         # maxhost: Maximum length of a hostname.
862         maxhost="64"
863
864         # maxquit: Maximum length of a quit message.
865         maxquit="255"
866
867         # maxtopic: Maximum length of a channel topic.
868         maxtopic="307"
869
870         # maxkick: Maximum length of a kick message.
871         maxkick="255"
872
873         # maxreal: Maximum length of a real name.
874         maxreal="128"
875
876         # maxaway: Maximum length of an away message.
877         maxaway="200">
878
879 #-#-#-#-#-#-#-#-#-#-#-#-# PATHS CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#
880 #                                                                     #
881 # This configuration tag defines the location that InspIRCd stores    #
882 # various types of files such as configuration files, log files and   #
883 # modules. You will probably not need to change these from the values #
884 # set when InspIRCd was built unless you are using a binary package   #
885 # where you do not have the ability to set build time configuration.  #
886 #<path configdir="conf" datadir="data" logdir="logs" moduledir="modules">
887
888 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
889 # Logging
890 # -------
891 #
892 # Logging is covered with the <log> tag, which you may use to change
893 # the behaviour of the logging of the IRCd.
894 #
895 # An example log tag would be:
896 #  <log method="file" type="OPER" level="default" target="opers.log">
897 # which would log all information on /OPER (failed and successful) to
898 # a file called opers.log.
899 #
900 # There are many different types which may be used, and modules may
901 # generate their own. A list of useful types:
902 #  - USERS - information relating to user connection and disconnection
903 #  - OPER - successful and failed oper attempts
904 #  - KILL - kill related messages
905 #  - FILTER - messages related to filter matches (filter module)
906 #  - CONFIG - configuration related messages
907 #  - COMMAND - die and restart messages, and messages related to unknown user types
908 #  - SOCKET - socket engine informational/error messages
909 #  - MODULE - module related messages
910 #  - STARTUP - messages related to starting up the server
911 #
912 # You may also log *everything* by using a type of *, and subtract things out
913 # of that by using -TYPE - for example "* -USERINPUT -USEROUTPUT".
914 #
915 # Useful levels are:
916 #  - default (general messages, including errors)
917 #  - sparse (misc error messages)
918 #  - debug (debug messages)
919 #
920 # Some types only produce output in the debug level, those are:
921 #  - BANCACHE - ban cache debug messages
922 #  - CHANNELS - information relating to joining/creating channels
923 #  - CULLLIST - debug messages related to issues with removing users
924 #  - RESOLVER - DNS related debug messages
925 #  - CONNECTCLASS - Connection class debug messages
926 #  - USERINPUT
927 #  - USEROUTPUT
928 #
929 # If your server is producing a high levels of log messages you can also set the
930 # flush="[positive number]" attribute to specify how many log messages should be
931 # buffered before flushing to disk. You should probably not specify this unless
932 # you are having problems.
933 #
934 # The following log tag is highly default and uncustomised. It is recommended you
935 # sort out your own log tags. This is just here so you get some output.
936
937 <log method="file" type="* -USERINPUT -USEROUTPUT" level="default" target="ircd.log">
938
939 #-#-#-#-#-#-#-#-#-#-#-#-#-  WHOWAS OPTIONS   -#-#-#-#-#-#-#-#-#-#-#-#-#
940 #                                                                     #
941 # This tag lets you define the behaviour of the /WHOWAS command of    #
942 # your server.                                                        #
943 #                                                                     #
944
945 <whowas
946         # groupsize: Maximum entries per nick shown when performing
947         # a /WHOWAS <nick>.
948         groupsize="10"
949
950         # maxgroups: Maximum number of nickgroups that can be added to
951         # the list so that /WHOWAS does not use a lot of resources on
952         # large networks.
953         maxgroups="100000"
954
955         # maxkeep: Maximum time a nick is kept in the whowas list
956         # before being pruned. Time may be specified in seconds,
957         # or in the following format: 1y2w3d4h5m6s. Minimum is
958         # 1 hour.
959         maxkeep="3d">
960
961 #-#-#-#-#-#-#-#-#-#-#-#-#-#-  BAN OPTIONS  -#-#-#-#-#-#-#-#-#-#-#-#-#-#
962 #                                                                     #
963 # The ban tags define nick masks, host masks and ip ranges which are  #
964 # banned from your server. All details in these tags are local to     #
965 # Your server.                                                        #
966 #                                                                     #
967
968 <badip
969        # ipmask: IP range to ban. Wildcards and CIDR can be used.
970        ipmask="192.0.2.69"
971
972        # reason: Reason to display when user is disconnected.
973        reason="No porn here thanks.">
974
975 <badnick
976          # nick: Nick to disallow. Wildcards are supported.
977          nick="Tr0ll123"
978
979          # reason: Reason to display on /NICK.
980          reason="Don't use this nick.">
981
982 <badhost
983          # host: ident@hostname to ban.
984          # Wildcards and CIDR (if you specify an IP) can be used.
985          host="*@banneduser.example.net"
986
987          # reason: Reason to display when user is disconnected
988          reason="Evading Bans">
989
990 <badhost host="root@*" reason="Don't IRC as root!">
991 <badhost host="*@198.51.100.0/24" reason="This subnet is bad.">
992
993 # exception: Hosts that are exempt from [KGZ]-lines.
994 <exception
995            # host: ident@hostname to exempt.
996            # Wildcards and CIDR (if you specify an IP) can be used.
997            host="*@serverop.example.com"
998
999            # reason: Reason for exception. Only shown in /STATS e.
1000            reason="Oper's hostname">
1001
1002 #-#-#-#-#-#-#-#-#-#-#- INSANE BAN OPTIONS  -#-#-#-#-#-#-#-#-#-#-#-#-#-#
1003 #                                                                     #
1004 # This optional tag allows you to specify how wide a G-line, E-line,  #
1005 # K-line, Z-line or Q-line can be before it is forbidden from being   #
1006 # set. By setting hostmasks="yes", you can allow all G-, K-, E-lines, #
1007 # no matter how many users the ban would cover. This is not           #
1008 # recommended! By setting ipmasks="yes", you can allow all Z-lines,   #
1009 # no matter how many users these cover too. Needless to say we        #
1010 # don't recommend you do this, or, set nickmasks="yes", which will    #
1011 # allow any Q-line.                                                   #
1012 #                                                                     #
1013
1014 <insane
1015         # hostmasks: Allow bans with insane hostmasks. (over-reaching bans)
1016         hostmasks="no"
1017
1018         # ipmasks: Allow bans with insane ipmasks. (over-reaching bans)
1019         ipmasks="no"
1020
1021         # nickmasks: Allow bans with insane nickmasks. (over-reaching bans)
1022         nickmasks="no"
1023
1024         # trigger: What percentage of users on the network to trigger
1025         # specifying an insane ban as. The default is 95.5%, which means
1026         # if you have a 1000 user network, a ban will not be allowed if it
1027         # will be banning 955 or more users.
1028         trigger="95.5">
1029
1030 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# MODULES #-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1031 #    ____                _   _____ _     _       ____  _ _   _        #
1032 #   |  _ \ ___  __ _  __| | |_   _| |__ (_)___  | __ )(_) |_| |       #
1033 #   | |_) / _ \/ _` |/ _` |   | | | '_ \| / __| |  _ \| | __| |       #
1034 #   |  _ <  __/ (_| | (_| |   | | | | | | \__ \ | |_) | | |_|_|       #
1035 #   |_| \_\___|\__,_|\__,_|   |_| |_| |_|_|___/ |____/|_|\__(_)       #
1036 #                                                                     #
1037 # Well done, you've reached the end of the basic configuration, your  #
1038 # ircd should now start if you want to try it out! (./inspircd start) #
1039 #                                                                     #
1040 # We now suggest you read and edit modules.conf, as modules are what  #
1041 # provide almost all the features of InspIRCd. :)                     #
1042 #                                                                     #
1043 # The default does nothing -- we include it for simplicity for you.   #
1044 #<include file="examples/modules.conf.example">
1045
1046 #-#-#-#-#-#-#-#-#-#-#-# SERVICES CONFIGURATION  #-#-#-#-#-#-#-#-#-#-#-#
1047 #                                                                     #
1048 # If you use services you will probably want to include one of the    #
1049 # following files which set up aliases, nick reservations and filter  #
1050 # exemptions for services pseudoclients:                              #
1051 #
1052 # Anope users should uncomment this:
1053 #<include file="examples/services/anope.conf.example">
1054 #
1055 # Atheme users should uncomment this:
1056 #<include file="examples/services/atheme.conf.example">
1057 #
1058 # Users of other services should uncomment this:
1059 #<include file="examples/services/generic.conf.example">
1060
1061 #########################################################################
1062 #                                                                       #
1063 #                     - InspIRCd Development Team -                     #
1064 #                        https://www.inspircd.org                       #
1065 #                                                                       #
1066 #########################################################################