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