X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=docs%2Finspircd.conf.example;h=8877bfe9098da7a0e5c34558591dd0ff6851bee6;hb=1ff54f0c4d4a53003319e72e3c7cbcf4c6c025e3;hp=fdfbb6abde54a6f8113c0b9342abf87e95cb37bf;hpb=bf12d6221243f7d9307f3b31c128512661fb2a17;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/docs/inspircd.conf.example b/docs/inspircd.conf.example index fdfbb6abd..8877bfe90 100644 --- a/docs/inspircd.conf.example +++ b/docs/inspircd.conf.example @@ -48,25 +48,37 @@ # # # # # # -# The server ID is optional, and if omitted or set to 0, is auto- # -# matically calculated from the server name and description. This is # -# similar in behaviour to the server id on ircu and charybdis ircds. # +# The server name should be a syntactically valid hostname, with at # +# least one '.', and does not need to resolve to an IP address. # +# # +# The description is freeform text. Remember you may put quotes in # +# this field by escaping it using \". # +# # +# The network field indicates the network name given in on connect # +# to clients. It is used by many clients such as mIRC to select a # +# perform list, so it should be identical on all servers on a net # +# and should not contain spaces. # +# # +# The server ID is optional, and if omitted automatically calculated # +# from the server name and description. This is similar in # +# in behaviour to the server id on ircu and charybdis ircds. # # You should only need to set this manually if there is a collision # # between two server ID's on the network. The server ID must be # -# between 1 and 999, if it is not, it will be wrapped to this range. # -# There is a range of server ID's which are suffixed by two letters # -# rather than two numbers, e.g. 1AA, 2FF, 3ZZ, which are reserved # -# for use by non-inspircd servers such as services and stats servers.# +# three digits or letters long, of which the first digit must always # +# be a number, and the other two letters may be any of 0-9 and A-Z. # +# For example, 3F9, 03J and 666 are all valid server IDs, and A9D, # +# QFX and 5eR are not. Remember, in most cases you will not need to # +# even set this value, it is calculated for you from your server # +# name and description. Changing these will change your auto- # +# generated ID. # # # + network="Omega"> #-#-#-#-#-#-#-#-#-#-#-#- ADMIN INFORMATION -#-#-#-#-#-#-#-#-#-#-#-# @@ -89,19 +101,19 @@ # # # Enter the port and address bindings here. # # # -# bind address - specifies which address ports bind to. Leaving this # +# bind address - Specifies which address ports bind to. Leaving this # # field blank binds the port to all IP's available. # # # # port - The port number to bind to. You may specify a port # # range here, e.g. "6667-6669,7000,7001". If you do # # this, the server will count each port within your # -# range as a seperate binding, making the above # -# example equivalent to five seperate bind tags. # +# range as a separate binding, making the above # +# example equivalent to five separate bind tags. # # A failure on one port in the range does not prevent # # the entire range from being bound, just that one # # port number. # # # -# type - can be 'clients' or 'servers'. The clients type is # +# type - Can be 'clients' or 'servers'. The clients type is # # a standard TCP based socket, the servers type is a # # also a TCP based connection but of a different # # format. SSL support is provided by modules, to # @@ -110,7 +122,7 @@ # # # ssl - When using m_ssl_gnutls.so or m_ssl_openssl.so # # modules, you must define this value to use ssl on # -# that port. valid values are 'gnutls' or 'openssl' # +# that port. Valid values are 'gnutls' or 'openssl' # # respectively. If the module is not loaded, this # # setting is ignored. # # # @@ -118,7 +130,7 @@ # either one of the SSL modules (m_ssl_gnutls or # # m_ssl_openssl) or m_ziplinks.so, then you may make # # use of this value. # -# setting it to 'openssl' or 'gnutls' or 'zip' # +# Setting it to 'openssl' or 'gnutls' or 'zip' # # indicates that the port should accept connections # # using the given transport name. Transports are # # layers which sit on top of a socket and change the # @@ -198,8 +210,13 @@ # config file inspircd.conf, unless the filename starts with a forward# # slash (/) in which case it is treated as an absolute path. # # # +# 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: # # # +# # # # #-#-#-#-#-#-#-#-#-#- CONNECTIONS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-# @@ -211,11 +228,11 @@ # # # Syntax is as follows: # # # -# # +# port="6660" maxchans="50" limit="999"> # # # # # # # @@ -233,7 +250,7 @@ # be copied from the parent. # # # # If the value maxchans is included, this overrides all other max # -# channels related settings, including the seperate oper maximum. # +# channels related settings, including the separate oper maximum. # # You may set this to any (sane) value you wish and it applies to # # all users within this connect tag. # # # @@ -241,6 +258,10 @@ # specifies the amount of time given before an unknown connection # # is closed if USER/NICK/PASS are not given. This value is in secs. # # # +# You may optionally limit the number of clients that are matched # +# by a single tag by specifying the maximum in the limit # +# parameter. If set to 0, there is no limit, which is the default. # +# # # You should also include a flood="x" line which indicates # # the number of lines a user may place into their buffer at once # # before they are disconnected for excess flood. This feature can # @@ -288,6 +309,11 @@ # only incoming connections on the specified port will match. Port # # tags may be used on connect allow and connect deny tags. # # # +# The limit value determines the maximum number of users which may # +# be in this class. Combine this with CIDR masks for various ISP # +# subnets to limit the number of users which may connect at any one # +# time from a certain ISP. Omit this value to not limit the tag. # +# # @@ -299,7 +325,8 @@ sendq="262144" recvq="8192" localmax="3" - globalmax="3"> + globalmax="3" + limit="5000"> @@ -313,8 +340,16 @@ # # # Syntax is as follows: # # # -# # +# # # # +# The name value indicates a name for this class. # +# The commands value indicates a list of one or more commands that # +# are allowed by this class (see also 'READ THIS BIT' below). # +# The usermodes and chanmodes values indicate lists of usermodes and # +# channel modes this oper can execute. This only applies to modes # +# that are marked oper-only such as usermode +Q and channelmode +O. # # ____ _ _____ _ _ ____ _ _ _ # # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | # # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | # @@ -331,11 +366,11 @@ # however it is provided for fast configuration (e.g. in test nets) # # # - - - - - + + + + + #-#-#-#-#-#-#-#-#-#-#-#- OPERATOR COMPOSITION -#-#-#-#-#-#-#-#-#-#-# @@ -344,17 +379,17 @@ # your server, as well as the commands they are allowed to use. # # This works alongside with the classes specified above. # # # -# type name - a name for the combined class types. # +# type name - A name for the combined class types. # # a type name cannot contain spaces, however if you # # put an _ symbol in the name, it will be translated # # to a space when displayed in a WHOIS. # # # -# classes - specified above, used for flexibility for the # +# classes - Specified above, used for flexibility for the # # server admin to decide on which operators get # # what commands. Class names are case sensitive, # -# seperate multiple class names with spaces. # +# separate multiple class names with spaces. # # # -# host - optional hostmask operators will receive on oper-up. # +# host - Optional hostmask operators will receive on oper-up. # # # # Syntax is as follows: # # # @@ -381,20 +416,20 @@ # Opers are defined here. This is a very important section. # # Remember to only make operators out of trust worthy people. # # # -# name - oper name, this is case sensitive, so it is best to # +# name - Oper name, this is case sensitive, so it is best to # # use lower-case. # # # -# password - password to oper-up, also case sensitive. # +# password - Password to oper-up, also case sensitive. # # encryption is supported via modules. You may load # # modules for MD5 or SHA256 encryption, and if you do, # # this value will be a hash value, otherwise put a # # plaintext password in this value. # # # -# host - hosts of client allowed to oper-up. # -# wildcards accepted, seperate multiple hosts with a # +# host - Hosts of client allowed to oper-up. # +# wildcards accepted, separate multiple hosts with a # # space. You may also specify CIDR IP addresses. # # # -# fingerprint - when using the m_ssl_oper_cert.so module, you may # +# fingerprint - When using the m_ssl_oper_cert.so module, you may # # specify a key fingerprint here. This can be obtained # # using the /fingerprint command whilst the module is # # loaded, or from the notice given to you when you # @@ -409,7 +444,7 @@ # is not loaded, this configuration option has no # # effect and will be ignored. # # # -# type - defines the kind of operator. This must match a type # +# type - Defines the kind of operator. This must match a type # # tag you defined above, and is case sensitive. # # # # Syntax is as follows: # @@ -431,29 +466,29 @@ # Defines which servers can link to this one, and which servers this # # server may create outbound links to. # # # -# name - the name is the canocial name of the server, does # +# name - The name is the canonical name of the server, does # # not have to resolve - but it is expected to be set # # in the remote servers connection info. # # # -# ipaddr - valid host or IP address for remote server. These # +# ipaddr - Valid host or IP address for remote server. These # # hosts are resolved on rehash, and cached, if you # # specify a hostname; so if you find that your server # # is still trying to connect to an old IP after you # -# have updated your dns, try rehashing and then # +# have updated your DNS, try rehashing and then # # attempting the connect again. # # # -# port - the TCP port for the remote server. # +# port - The TCP port for the remote server. # # # -# sendpass - password to send to create an outbound connection # +# sendpass - Password to send to create an outbound connection # # to this server. # # # -# recvpass - password to receive to accept an inbound connection # +# recvpass - Password to receive to accept an inbound connection # # from this server. # # # -# autoconnect - sets the server to autoconnect. Where x is the num. # +# autoconnect - Sets the server to autoconnect. Where x is the num. # # (optional) of seconds between attempts. e.g. 300 = 5 minutes. # # # -# transport - if defined, this is a transport name implemented by # +# transport - If defined, this is a transport name implemented by # # another module. Transports are layers on top of # # plaintext connections, which alter them in certain # # ways. Currently the three supported transports are # @@ -464,7 +499,7 @@ # link to succeed. OpenSSL and GnuTLS are link- # # compatible with each other. # # # -# statshidden - when using m_spanningtree.so for linking. you may # +# statshidden - When using m_spanningtree.so for linking. you may # # set this to 'yes', and if you do, the IP address/ # # hostname of this connection will NEVER be shown to # # any opers on the network. In /stats c its address # @@ -473,7 +508,7 @@ # UNLESS the connection fails (e.g. due to a bad # # password or servername) # # # -# allowmask - when this is defined, it indicates a range of IP # +# allowmask - When this is defined, it indicates a range of IP # # addresses to allow for this link (You may use CIDR # # or wildcard form for this address). # # e.g. if your server is going to connect to you from # @@ -481,7 +516,7 @@ # into this value. If it is not defined, then only # # the ipaddr field of the server shall be allowed. # # # -# failover - if you define this option, it must be the name of a # +# failover - If you define this option, it must be the name of a # # different link tag in your configuration. This # # option causes the ircd to attempt a connection to # # the failover link in the event that the connection # @@ -499,12 +534,12 @@ # apply to autoconnected servers as well as manually # # connected ones. # # # -# timeout - if this is defined, then outbound connections will # +# timeout - If this is defined, then outbound connections will # # time out if they are not connected within this many # # seconds. If this is not defined, the default of ten # # seconds is used. # # # -# bind - if you specify this value, then when creating an # +# bind - If you specify this value, then when creating an # # outbound connection to the given server, the IP you # # place here will be bound to. This is for multi- # # homed servers which may have multiple IP addresses. # @@ -518,7 +553,7 @@ # looking for the error 'Could not assign requested # # address' in your log when connecting to servers. # # # -# hidden - if this is set to true, yes, or 1, then the server # +# hidden - If this is set to true, yes, or 1, then the server # # is completely hidden from non-opers. It does not # # show in /links and it does not show in /map. Also, # # any servers which are child servers of this one # @@ -530,7 +565,7 @@ # example to hide a non-client hub, for which clients # # do not have an IP address or resolvable hostname. # # # -# to u:line a server (give it extra privilages required for running # +# To u:line a server (give it extra privileges required for running # # services, Q, etc) you must include the tag as shown # # in the example below. You can have as many of these as you like. # # # @@ -542,7 +577,7 @@ # # # NOTE: If you have built your server as an IPv6 server, then when a # # DNS lookup of a server's host occurs, AAAA records (IPv6) are # -# priorotized over A records (IPv4). Therefore, if the server you are # +# prioritised over A records (IPv4). Therefore, if the server you are # # connecting to has both an IPv6 IP address and an IPv4 IP address in # # its DNS entry, the IPv6 address will *always* be selected. To # # change this behaviour simply specify the IPv4 IP address rather # @@ -606,7 +641,7 @@ # # # These options let you define the path to your motd and rules # # files. If these are relative paths, they are relative to the # -# configurtion directory. # +# configuration directory. # # #