######################################################################## # # # ___ ___ ____ ____ _ # # |_ _|_ __ ___ _ __|_ _| _ \ / ___|__| | # # | || '_ \/ __| '_ \| || |_) | | / _` | # # | || | | \__ \ |_) | || _ <| |__| (_| | # # |___|_| |_|___/ .__/___|_| \_\\____\__,_| # # |_| # # ____ __ _ _ _ # # / ___|___ _ __ / _(_) __ _ _ _ _ __ __ _| |_(_) ___ _ __ # # | | / _ \| '_ \| |_| |/ _` | | | | '__/ _` | __| |/ _ \| '_ \ # # | |__| (_) | | | | _| | (_| | |_| | | | (_| | |_| | (_) | | | | # # \____\___/|_| |_|_| |_|\__, |\__,_|_| \__,_|\__|_|\___/|_| |_| # # |___/ # # # ##################################||#################################### #||# ##################################||#################################### # # # This is an example of the config file for InspIRCd. # # Change the options to suit your network. # # # # # # ____ _ _____ _ _ ____ _ _ _ # # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | # # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | # # | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| # # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) # # # # Lines prefixed with READ THIS BIT, as shown above, are IMPORTANT # # lines, and you REALLY SHOULD READ THEM. Yes, THIS MEANS YOU. Even # # if you've configured InspIRCd before, these probably indicate # # something new or different to this version and you SHOULD READ IT. # # # ######################################################################## #-#-#-#-#-#-#-#-#-# CONFIGURATION FORMAT #-#-#-#-#-#-#-#-#-#-#-#-#-#- # # # In order to maintain compatibility with older configuration files, # # you can change the configuration parser to parse as it did in # # previous releases. When using the "compat" format, you need to use # # C++ escape sequences (e.g. \n) instead of XML ones (e.g. &nl;) and # # can not use to create macros. # # #-#-#-#-#-#-#-#-#-# INCLUDE CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#-# # # # This optional tag allows you to include another config file # # allowing you to keep your configuration tidy. The configuration # # file you include will be treated as part of the configuration file # # which includes it, in simple terms the inclusion is transparent. # # # # All paths to config files are relative to the directory that the # # process runs in. # # # # You may also include an executable file, in which case if you do so # # the output of the executable on the standard output will be added # # to your config at the point of the include tag. # # # # Syntax is as follows: # # # # # # # # Executable include example: # # # # #-#-#-#-#-#-#-#-#-#-#-# VARIABLE DEFINITIONS -#-#-#-#-#-#-#-#-#-#-#-# # # # You can define variables that will be substituted later in the # # configuration file. This can be useful to allow settings to be # # easily changed, or to parameterize a remote includes. # # # # Variables may be redefined and may reference other variables. # # Value expansion happens at the time the tag is read. # #-#-#-#-#-#-#-#-#-#-#-#- SERVER DESCRIPTION -#-#-#-#-#-#-#-#-#-#-#-#- # # # Here is where you enter the information about your server. # # # #-#-#-#-#-#-#-#-#-#-#-#- ADMIN INFORMATION -#-#-#-#-#-#-#-#-#-#-#-# # # # Describes the Server Administrator's real name (optionally), # # nick, and email address. # # # #-#-#-#-#-#-#-#-#-#-#-#- PORT CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#- # # # Enter the port and address bindings here. # # # # # # ____ _ _____ _ _ ____ _ _ _ # # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | # # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | # # | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| # # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) # # # # If you want to link servers to InspIRCd you must load the # # spanningtree module! Please see the modules list for # # information on how to load this module! If you do not load this # # module, server ports will NOT work! # tag that you have defined or one # of "openssl", "gnutls", "mbedtls" if you have not defined any. See the # wiki page for the SSL module you are using for more details. # # You will need to load the ssl_openssl module for OpenSSL, ssl_gnutls # for GnuTLS and ssl_mbedtls for mbedTLS. ssl="gnutls" # defer: When this is non-zero, connections will not be handed over to # the daemon from the operating system before data is ready. # In Linux, the value indicates the time period we'll wait for a # connection to come up with data. Don't set it too low! # In BSD the value is ignored; only zero and non-zero is possible. # Windows ignores this parameter completely. # Note: This does not take effect on rehash. # To change it on a running bind, you'll have to comment it out, # rehash, comment it in and rehash again. defer="0" # free: When this is enabled the listener will be created regardless of # whether the interface that provides the bind address is available. This # is useful for if you are starting InspIRCd on boot when the server may # not have brought the network interfaces up yet. free="no" > # Listener accepting HTML5 WebSocket connections. # Requires the websocket module and SHA-1 hashing support (provided by the sha1 # module). # # EXPERIMENTAL: Listener that binds on a UNIX endpoint instead of a TCP/IP endpoint: # # You can define a custom tag which defines the SSL configuration # for this listener. See the wiki page for the SSL module you are using for # more details. # # Alternatively, you can use one of the default SSL profiles which are created # when you have not defined any: # "openssl" (requires the ssl_openssl module) # "gnutls" (requires the ssl_gnutls module) # "mbedtls" (requires the ssl_mbedtls module) # # When linking servers, the OpenSSL, GnuTLS, and mbedTLS implementations are # completely link-compatible and can be used alongside each other on each end # of the link without any significant issues. #-#-#-#-#-#-#-#-#-#- CONNECTIONS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-# # # # This is where you can configure which connections are allowed # # and denied access onto your server. The password is optional. # # You may have as many of these as you require. To allow/deny all # # connections, use a '*' or 0.0.0.0/0. # # # # -- It is important to note that connect tags are read from the -- # # TOP DOWN. This means that you should have more specific deny # # and allow tags at the top, progressively more general, followed # # by a # # connect:reason is the message that users will see if they match a deny block #hash="bcrypt" # password: Password to use for this block/user(s) password="secret" # maxchans: Maximum number of channels a user in this class # be in at one time. maxchans="20" # timeout: How long the server will wait before disconnecting # a user if they do not do anything on connect. # (Note, this is a client-side thing, if the client does not # send /nick, /user or /pass) timeout="10" # localmax: Maximum local connections per IP (or CIDR mask, see below). localmax="3" # globalmax: Maximum global (network-wide) connections per IP (or CIDR mask, see below). globalmax="3" # maxconnwarn: Enable warnings when localmax or globalmax are reached (defaults to on) maxconnwarn="off" # resolvehostnames: If disabled, no DNS lookups will be performed on connecting users # in this class. This can save a lot of resources on very busy servers. resolvehostnames="yes" # usednsbl: Defines whether or not users in this class are subject to DNSBL. Default is yes. # This setting only has effect when the dnsbl module is loaded. #usednsbl="yes" # useident: Defines if users in this class MUST respond to a ident query or not. useident="no" # webirc: Restricts usage of this class to the specified WebIRC gateway. # This setting only has effect when the cgiirc module is loaded. #webirc="name" # limit: How many users are allowed in this class limit="5000" # modes: Usermodes that are set on users in this block on connect. # Enabling this option requires that the conn_umodes module be loaded. # This entry is highly recommended to use for/with IP Cloaking/masking. # For the example to work, this also requires that the "cloaking" # module be loaded as well. modes="+x" # requireident, requiressl, requireaccount: require that users of this # block have a valid ident response, use SSL, or have authenticated. # Requires ident, sslinfo, or the services_account module, respectively. requiressl="on" # NOTE: For requireaccount, you must complete the signon prior to full # connection. Currently, this is only possible by using SASL # authentication; passforward and PRIVMSG NickServ happen after # your final connect block has been found. # Alternate MOTD file for this connect class. The contents of this file are # specified using or # # NOTE: the following escape sequences for IRC formatting characters can be # used in your MOTD: # Bold: \b # Color: \c[,] # Italic: \i # Monospace: \m (not widely supported) # Reset: \x # Reverse: \r # Strikethrough: \s (not widely supported) # Underline: \u # See https://defs.ircdocs.horse/info/formatting.html for more information # on client support for formatting characters. motd="secretmotd" # port: What port range this user is allowed to connect on. (optional) # The ports MUST be set to listen in the bind blocks above. port="6697,9999"> #-#-#-#-#-#-#-#-#-#-#-#- CIDR CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#- # # # CIDR configuration allows detection of clones and applying of # # throttle limits across a CIDR range. (A CIDR range is a group of # # IPs, for example, the CIDR range 192.168.1.0-192.168.1.255 may be # # represented as 192.168.1.0/24). This means that abuse across an ISP # # is detected and curtailed much easier. Here is a good chart that # # shows how many IPs the different CIDRs correspond to: # # https://en.wikipedia.org/wiki/IPv4_subnetting_reference # # https://en.wikipedia.org/wiki/IPv6_subnetting_reference # # # # This file has all the information about oper classes, types and o:lines. # You *MUST* edit it. # This file has all the information about server links and ulined servers. # You *MUST* edit it if you intend to link servers. #-#-#-#-#-#-#-#-#-#- MISCELLANEOUS CONFIGURATION -#-#-#-#-#-#-#-#-#-# # # # Files block - contains files whose contents are used by the ircd # # motd - displayed on connect and when a user executes /MOTD # Modules can also define their own files # Example of an executable file include. Note this will be read on rehash, # not when the command is run. # #-#-#-#-#-#-#-#-#-#-#-#-#-#-# DNS SERVER -#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # If these values are not defined, InspIRCd uses the default DNS resolver # of your system. # An example of using an IPv6 nameserver # #-#-#-#-#-#-#-#-#-#-#-#-#-#-# PID FILE -#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # # # Define the path to the PID file here. The PID file can be used to # # rehash the ircd from the shell or to terminate the ircd from the # # shell using shell scripts, perl scripts, etc... and to monitor the # # ircd's state via cron jobs. If this is a relative path, it will be # # relative to the configuration directory, and if it is not defined, # # the default of 'inspircd.pid' is used. # # # # #-#-#-#-#-#-#-#-#-#-#-#-#- LIST MODE LIMITS #-#-#-#-#-#-#-#-#-#-#-#-#-# # # # The tag is used customise the maximum number of each list # # mode that can be set on a channel. # # The tags are read from top to bottom and the list mode limit from # # the first tag found which matches the channel name and mode type is # # applied to that channel. # # It is advisable to put an entry with the channel as '*' at the # # bottom of the list. If none are specified or no maxlist tag is # # matched, the banlist size defaults to 100 entries. # # # # Allows #largechan to have up to 200 ban entries. # # Allows #largechan to have up to 200 ban exception entries. # # Allows all channels and list modes not previously matched to have # up to 100 entries. #-#-#-#-#-#-#-#-#-#-#- DISABLED FEATURES -#-#-#-#-#-#-#-#-#-#-#-#-#-# # # # This tag is optional, and specifies one or more features which are # # not available to non-operators. # # # # For example you may wish to disable NICK and prevent non-opers from # # changing their nicknames. # # Note that any disabled commands take effect only after the user has # # 'registered' (e.g. after the initial USER/NICK/PASS on connection) # # so for example disabling NICK will not cripple your network. # # # # You can also define if you want to disable any channelmodes # # or usermodes from your users. # # # # `fakenonexistant' will make the ircd pretend that nonexistant # # commands simply don't exist to non-opers ("no such command"). # # # # #-#-#-#-#-#-#-#-#-#-#-#-#- SERVER OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-# # # # Settings to define which features are usable on your server. # # # # suffixpart: What (if anything) users' part message # should be suffixed with. suffixpart=""" # fixedquit: Set all users' quit messages to this value. #fixedquit="" # fixedpart: Set all users' part messages in all channels # to this value. #fixedpart="" # syntaxhints: If enabled, if a user fails to send the correct parameters # for a command, the ircd will give back some help text of what # the correct parameters are. syntaxhints="no" # casemapping: This sets the case mapping method to be used by the # server. This MUST be the same on all servers. Possible values are: # "ascii" (recommended) # "rfc1459" (default, required for linking to 2.0 servers) # NOTE: if you are using the nationalchars module this setting will be # ignored. You should use instead. casemapping="ascii" # cyclehostsfromuser: If enabled, the source of the mode change for # cyclehosts will be the user who cycled. This can look nicer, but # triggers anti-takeover mechanisms of some obsolete bots. cyclehostsfromuser="no" # announcets: If set to yes, when the timestamp on a channel changes, all users # in the channel will be sent a NOTICE about it. announcets="yes" # allowmismatch: Setting this option to yes will allow servers to link even # if they don't have the same "optionally common" modules loaded. Setting this to # yes may introduce some desyncs and unwanted behaviour. allowmismatch="no" # defaultbind: Sets the default for tags without an address. Choices are # ipv4 or ipv6; if not specified, IPv6 will be used if your system has support, # falling back to IPv4 otherwise. defaultbind="auto" # hostintopic: If enabled, channels will show the host of the topic setter # in the topic. If set to no, it will only show the nick of the topic setter. hostintopic="yes" # pingwarning: If a server does not respond to a ping within this period, # it will send a notice to opers with snomask +l informing that the server # is about to ping timeout. pingwarning="15" # serverpingfreq: How often pings are sent between servers. serverpingfreq="1m" # splitwhois: Whether to split private/secret channels from normal channels # in WHOIS responses. Possible values for this are: # 'no' - list all channels together in the WHOIS response regardless of type. # 'split' - split private/secret channels to a separate WHOIS response numeric. # 'splitmsg' - the same as split but also send a message explaining the split. splitwhois="no" # defaultmodes: What modes are set on a empty channel when a user # joins it and it is unregistered. defaultmodes="not" # xlinemessage: This is the text that is sent to a user when they are # banned from the server. xlinemessage="You're banned! Email irc@example.com with the ERROR line below for help." # allowzerolimit: If enabled then allow a limit of 0 to be set on channels. # This is non-standard behaviour and should only be enabled if you need to # link with servers running 2.0. Defaults to yes. allowzerolimit="no" # exemptchanops: Allows users with with a status mode to be exempt # from various channel restrictions. Possible restrictions are: # - auditorium-see Permission required to see the full user list of # a +u channel (requires the auditorium module). # - auditorium-vis Permission required to be visible in a +u channel # (requires the auditorium module). # - blockcaps Channel mode +B - blocks messages with too many capital # letters (requires the blockcaps module). # - blockcolor Channel mode +c - blocks messages with formatting codes # (requires the blockcolor module). # - censor Channel mode +G - censors messages based on the network # configuration (requires the censor module). # - filter Channel mode +g - blocks messages containing the given # glob mask (requires the chanfilter module). # - flood Channel mode +f - kicks (and bans) on text flood of a # specified rate (requires the messageflood module). # - nickflood Channel mode +F - blocks nick changes after a specified # rate (requires the nickflood module). # - noctcp Channel mode +C - blocks any CTCPs to the channel # (requires the noctcp module). # - nonick Channel mode +N - prevents users on the channel from # changing nicks (requires the nonicks module). # - nonotice Channel mode +T - blocks /NOTICEs to the channel # (requires the nonotice module). # - regmoderated Channel mode +M - blocks unregistered users from # speaking (requires the services account module). # - stripcolor Channel mode +S - strips formatting codes from # messages (requires the stripcolor module). # - topiclock Channel mode +t - limits changing the topic to (half)ops # You can also configure this on a per-channel basis with a channel mode. # See m_exemptchanops in modules.conf.example for more details. exemptchanops="censor:o filter:o nickflood:o nonick:v regmoderated:o" # invitebypassmodes: This allows /invite to bypass other channel modes. # (Such as +k, +j, +l, etc.) invitebypassmodes="yes" # nosnoticestack: This prevents snotices from 'stacking' and giving you # the message saying '(last message repeated X times)'. Defaults to no. nosnoticestack="no"> #-#-#-#-#-#-#-#-#-#-#-# PERFORMANCE CONFIGURATION #-#-#-#-#-#-#-#-#-#-# # # #-#-#-#-#-#-#-#-#-#-#-# SECURITY CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-# # #