X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=conf%2Finspircd.conf.example;h=baadf24d62233c39ad47a1823bc4e2311517e581;hb=fa67c7e80b15060773295e4719545a802d8717d5;hp=663d69e1dcb96c5edc8b8da01835bbc9dc59b443;hpb=f19b6d5eb255fbb04ead9eaa4ac82aab6fb6fd80;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/conf/inspircd.conf.example b/conf/inspircd.conf.example index 663d69e1d..baadf24d6 100644 --- a/conf/inspircd.conf.example +++ b/conf/inspircd.conf.example @@ -46,9 +46,8 @@ # 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 of the main # -# config file inspircd.conf, unless the filename starts with a forward# -# slash (/) in which case it is treated as an absolute path. # +# 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 # @@ -63,6 +62,22 @@ # # +#-#-#-#-#-#-#-#-#-#-#-# 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. # +# # +# Using variable definitions REQUIRES that the config format be # +# changed to "xml" from the default "compat" that uses escape # +# sequences such as "\"" and "\n", and does not support # + + + + #-#-#-#-#-#-#-#-#-#-#-#- SERVER DESCRIPTION -#-#-#-#-#-#-#-#-#-#-#-#- # # # Here is where you enter the information about your server. # @@ -150,16 +165,16 @@ -# When linking servers, the openssl and gnutls transports are largely +# When linking servers, the openssl and gnutls transports are completely # link-compatible and can be used alongside each other # on each end of the link without any significant issues. # Transports can only be used on server blocks. -# Supported Transports are: "zip", "openssl" and "gnutls". +# Supported Transports are: "ziplinks", "openssl" and "gnutls". # You must load m_ziplinks module for zip, m_ssl_openssl for openssl # or m_ssl_gnutls for gnutls. - + #-#-#-#-#-#-#-#-#-#- DIE/RESTART CONFIGURATION -#-#-#-#-#-#-#-#-#-#- @@ -241,23 +256,13 @@ # send /nick, /user or /pass) timeout="10" - # pingfreq: How often (in seconds) the server tries to ping connecting clients. - pingfreq="120" - - # sendq: Amount of data that the server is allowed to send to the user - # before they are dropped. - sendq="262144" - - # recvq: amount of data allowed in a clients queue before they are dropped. - recvq="8192" - - # localmax: Maximum local connections per IP. + # localmax: Maximum local connections per IP (or CIDR mask, see below). localmax="3" - # globalmax: Maximum global (network-wide) connections per IP. + # globalmax: Maximum global (network-wide) connections per IP (or CIDR mask, see below). globalmax="3" - # useident: Defines if users in this class must respond to a ident query or not. + # useident: Defines if users in this class MUST respond to a ident query or not. useident="no" # limit: How many users are allowed in this class @@ -266,6 +271,8 @@ # modes: Usermodes that are set on users in this block on connect. # Enabling this option requires that the m_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 m_cloaking + # module be loaded as well. modes="+x" # port: What port this user is allowed to connect on. (optional) @@ -293,13 +300,42 @@ # pingfreq: How often (in seconds) the server tries to ping connecting clients. pingfreq="120" - # sendq: Amount of data that the server is allowed to send to the user - # before they are dropped. - sendq="262144" + # hardsendq: maximum amount of data allowed in a client's send queue + # before they are dropped. Keep this value higher than the length of + # your network's /LIST or /WHO output, or you will have lots of + # disconnects from sendq overruns! + hardsendq="1048576" + + # softsendq: amount of data in a client's send queue before the server + # begins delaying their commands in order to allow the sendq to drain + softsendq="8192" - # recvq: amount of data allowed in a clients queue before they are dropped. + # recvq: amount of data allowed in a client's queue before they are dropped. recvq="8192" + # threshold: This specifies the amount of command penalty a user is allowed to have + # before being quit or fakelagged due to flood. Normal commands have a penalty of 1, + # ones such as /OPER have penalties up to 10. + # + # If you are not using fakelag, this should be at least 20 to avoid excess flood kills + # from processing some commands. + threshold="10" + + # commandrate: This specifies the maximum rate that commands can be processed. + # If commands are sent more rapidly, the user's penalty will increase and they will + # either be fakelagged or killed when they reach the threshold + # + # Units are millicommands per second, so 1000 means one line per second. + commandrate="1000" + + # fakelag: Use fakelag instead of killing users for excessive flood + # + # Fake lag stops command processing for a user when a flood is detected rather than + # immediately killing them; their commands are held in the recvq and processed later + # as the user's command penalty drops. Note that if this is enabled, flooders will + # quit with "RecvQ exceeded" rather than "Excess Flood". + fakelag="on" + # localmax: Maximum local connections per IP. localmax="3" @@ -315,6 +351,8 @@ # modes: Usermodes that are set on users in this block on connect. # Enabling this option requires that the m_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 m_cloaking + # module be loaded as well. modes="+x"> @@ -324,7 +362,9 @@ # 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. # +# is detected and curtailed much easier. Here is a good chart that # +# shows how many IPs the different CIDRs correspond to: # +# http://en.wikipedia.org/wiki/CIDR#Prefix_aggregation # # # + # This file has all the information about server links and ulined servers. # You *MUST* edit it if you intend to link servers. - + #-#-#-#-#-#-#-#-#-#- MISCELLANEOUS CONFIGURATION -#-#-#-#-#-#-#-#-#-# # # + # rules: Path to your rules file. Path is relative to the run directory. + # This is optional and is displayed when a user does /rules on the network. + rules="conf/inspircd.rules.example"> #-#-#-#-#-#-#-#-#-#-#-# MAXIMUM CHANNELS -#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # # @@ -374,7 +415,13 @@ @@ -452,11 +499,19 @@ # prefixpart: What (if anything) a users' part message # should be prefixed with. - prefixpart="\"" + prefixpart=""" + # NOTE: Use "\"" instead of """ if not using # suffixpart: What (if anything) a users' part message # should be suffixed with. - suffixpart="\"" + 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 @@ -473,12 +528,17 @@ # it will just message the user normally. ircumsgprefix="no" - # announcets: If set to yes, when the TS on a channel changes, all users + # announcets: If set to yes, when the TimeStamp on a channel changes, all users # in channel will be sent a NOTICE about it. announcets="yes" + # allowmismatched: Setting this option to yes will allow servers to link even + # if they don't have the same VF_OPTCOMMON modules loaded. Setting this to + # yes may introduce some desyncs and weirdness. + allowmismatched="no" + # hostintopic: If enabled, channels will show the host of the topicsetter - # in the topic. + # in the topic. If set to no, it will only show the nick of the topicsetter. hostintopic="yes" # pingwarning: If a server does not respond to a ping within x seconds, @@ -501,10 +561,6 @@ # banned from the server. moronbanner="You're banned! Email haha@abuse.com with the ERROR line below for help." - # exemptchanops: Defines what channel modes channel operators are - # exempt from. Supported modes are +TCGfcSFBgN. Defaults to off. - exemptchanops="" - # invitebypassmodes: This allows /invite to bypass other channel modes. # (Such as +k, +j, +l, etc) invitebypassmodes="yes"> @@ -519,8 +575,7 @@ netbuffersize="10240" # maxwho: Maximum number of results to show in a /who query. - # It is not recommended to set this above 1024. - maxwho="128" + maxwho="4096" # somaxconn: The maximum number of connections that may be waiting # in the accept queue. This is *NOT* the total maximum number of @@ -638,6 +693,10 @@ # defined to account for a null terminator on the end of the text. # # # # These values should match network-wide otherwise issues will occur. # +# # +# The highest safe value you can set any of these options to is 500, # +# but it is recommended that you keep them somewhat # +# near their defaults (or lower). # + + +# Here are some pre-built modules.conf files that closely match the +# default configurations of some popular IRCd's. You still may want to +# look over them and make sure if everything is correct for you and setup +# the proper SSL information. +# +# *NOTE*: These files have no comments for what the modules do. If you +# are interested in that, please read the modules.conf.example. It is also +# recommended that you make your own modules file based on modules.conf.example. + +# Settings similar to UnrealIRCd defaults. +# + +# Settings similar to Charybdis IRCd defaults. +# #########################################################################