X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=docs%2Finspircd.conf.example;h=b4fda8c8c5c06cad6bf65471127220bd1771c19f;hb=cf5ee19bca635a8c8ec3ef962a94bbafc06776cd;hp=d624e3ad2fafc55d14c969179ab976d30169c9df;hpb=df9da7e1d4474b83eba9e9ecb736bf9db8c0a964;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/docs/inspircd.conf.example b/docs/inspircd.conf.example index d624e3ad2..b4fda8c8c 100644 --- a/docs/inspircd.conf.example +++ b/docs/inspircd.conf.example @@ -37,7 +37,10 @@ # something new or different to this version and you SHOULD READ IT. # # # ######################################################################## - +# # +# Unalphabeticalise the modules list at your own risk # +# # +######################################################################## #-#-#-#-#-#-#-#-#-#-#-#- SERVER DESCRIPTION -#-#-#-#-#-#-#-#-#-#-#-#- @@ -76,8 +79,13 @@ # # # Enter the port and address bindings here. # # # -# bind address - specifies which the address which ports bind # -# port - opens an unused port # +# bind address - specifies which the address which ports bind. # +# may be a hostname or an IP address. Resolution of # +# hostnames may block for up to one second per IP # +# as port binding occurs before the socket engine is # +# initialized and therefore nonblocking DNS is not # +# available at this point until startup is complete. # +# port - The port number to bind to # # 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 # @@ -97,8 +105,8 @@ # # # Syntax is as follows: # # # -# # -# # +# # +# # # # @@ -160,12 +168,14 @@ # # # 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. The default is to # -# DISABLE this feature. A recommended value is 10. A counter is # -# maintained for each user which is reset every 'threshold' seconds # -# and specifying this threshold value with threshold="X" indicates # -# how often the counter is reset. For example, with flood="5" and # -# threshold="8", the user may not send more than 5 lines in 8 secs. # +# before they are disconnected for excess flood. This feature can # +# not be disabled, however it can be set to exremely high values, # +# rendering it effectively disabled. A recommended value is 10. # +# A counter is maintained for each user which is reset every # +# 'threshold' seconds and specifying this threshold value with # +# threshold="X" indicates how often the counter is reset. For # +# example, with flood="5" and threshold="8", the user may not send # +# more than 5 lines in 8 secs. # # # # You may optionally specify the sendq size and ping frequency of # # each connect:allow line using the pingfreq="X" and sendq="X" # @@ -189,7 +199,7 @@ # that of the user... Just to clear up any confusion or complaints # # that these are backwards :p # # # -# The maxlocal and maxglobal values can be used to enforce local # +# The localmax and globalmax values can be used to enforce local # # and global session limits on connections. The session limits are # # counted against all users, but applied only to users within the # # class. For example, if you had a class 'A' which has a session # @@ -201,7 +211,7 @@ # # - + @@ -280,7 +290,7 @@ # are modules that allow for oper password encryption. # # # # host - host of client allowed to oper-up. # -# wildcards accepted # +# wildcards accepted, seperate multiple hosts with space # # # # type - specified above, defines the kind of operator # # # @@ -293,7 +303,7 @@ @@ -381,14 +391,16 @@ # files. # # # - + #-#-#-#-#-#-#-#-#-#-#-#-#-#-# DNS SERVER -#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # # -# Define your DNS server address here. InspIRCd has its own resolver # -# and you must define this otherwise nobody's host will resolve. The # -# timeout value is in seconds. # +# Define your DNS server address here. InspIRCd has its own resolver. # +# If you do not define this value, the first dns server from your # +# /etc/resolv.conf file is read. If no entries are found in this file # +# or the file cannot be opened, the default value '127.0.0.1' is used # +# instead. The timeout value is in seconds. # # # # ____ _ _____ _ _ ____ _ _ _ # # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | # @@ -513,12 +525,43 @@ # socket engine/dns engine names. You may use this # # to enhance security, or simply for vanity. # # # -# maxtargets - The maxtargets field is optional, and if not # +# maxtargets - The maxtargets field is optional, and if not # # defined, defaults to 20. It indicates the maximum # # number of targets which may be given to commands # # such as PRIVMSG, KICK etc. # # # - +# hidesplits - When set to 'yes', will hide split server names # +# from non-opers. Non-opers will see '*.net *.split' # +# instead of the server names in the quit message, # +# identical to the way IRCu displays them. # +# # +# hidebans - When set to 'yes', will hide gline, kline, zline # +# and qline quit messages from non-opers. For # +# example, user A who is not an oper will just see # +# (G-Lined) while user B who is an oper will see the # +# text (G-Lined: Reason here) instead. # +# # +# hidewhois - When defined with a non-empty value, the given # +# text will be used in place of the user's server # +# in WHOIS, when a user is WHOISed by a non-oper. # +# For example, most nets will want to set this to # +# something like '*.netname.net' to conceal the # +# actual server the user is on. # +# # +# flatlinks - When you are using m_spanningtree.so, and this # +# value is set to true, yes or 1, /MAP and /LINKS # +# will be flattened when shown to a non-oper. # +# # +# hideulines - When you are using m_spanningtree.so, and this # +# value is set to true, yes or 1, then U-lined # +# servers will be hidden in /LINKS and /MAP. For non # +# opers. Please be aware that this will also hide # +# any leaf servers of a U-lined server, e.g. jupes. # +# # +# tempdir - If defined, indicates a path where modules will be # +# temporarily copied before loading. If not defined, # +# defaults to /tmp. # +# # @@ -583,7 +631,7 @@ # # # text - The text to detect at the start of the line, # # must be at the start of the line to trigger the # -# alias. May contain spaces, but case insensitive. # +# alias. Cant contain spaces, but case insensitive # # replace - The text to replace 'text' with. Usually this # # will be "PRIVMSG ServiceName" or similar. # # requires - If you provide a value for 'requires' this means # @@ -603,6 +651,11 @@ # # +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Antibear security module: Prevents 'bear.txt' based trojans from +# connecting to your network by sending them a numeric they can't handle. +# + #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Antibottler module: Labels bottler leech bots # @@ -611,6 +664,27 @@ # Ban except module: Adds support for channel ban exceptions (+e) # +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Block amsg module: Attempt to block all usage of /amsg and /ame +# +# +#-#-#-#-#-#-#-#-#-#-#- BLOCKAMSG CONFIGURATION -#-#-#-#-#-#-#-#-#-#-# +# # +# If you have the m_blockamsg.so module loaded, you can configure it # +# with the tag: # +# # +# delay - How many seconds between two messages to force # +# them to be recognised as unrelated. # +# action - Any of 'notice', 'noticeopers', 'silent', 'kill' # +# or 'killopers'. Define how to take action when # +# a user uses /amsg or /ame. # +# +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Block CAPS module: Blocking all-CAPS messages with cmode +P +# + #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Block colour module: Blocking colour-coded messages with cmode +c # @@ -655,6 +729,24 @@ #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Cloaking module: Adds usermode +x and cloaking support # +# +#-#-#-#-#-#-#-#-#-#-#- CLOAKING CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-# +# # +# Optional - If ypu specify the m_cloaking.so module as above, you # +# must define cloak keys, and optionally a cloak prefix as shown # +# below. When using cloaking, the cloak keys are MANDITORY and must # +# be included. However, if prefix is not included, it will default # +# to your networks name from the tag. # +# # +# # +# # +# Please note that the key values will accept any number, positive # +# or negative, and should be large numbers. Using small numbers such # +# as "7" or "1924" will seriously weaken the security of your cloak. # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Conn-Lusers: Shows the LUSERS output on connect @@ -663,6 +755,17 @@ #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Conn-Wait-for-Pong: Don't let a user connect until they PONG # +# +#-#-#-#-#-#-#-#-#-#-#- WAITPONG CONFIGURATION -#-#-#-#-#-#-#-#-#-#-# +# # +# If you have the m_conn_waitpong.so module loaded, configure it with # +# the tag: # +# # +# sendsnotice - Whether to send a snotice on connect, like Unreal# +# killonbadreply - Whether to kill the user if they send the wrong # +# PONG reply. # +# +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Deny Channels: Deny Channels from being used by users @@ -705,6 +808,11 @@ # Globops module: gives /GLOBOPS and usermode +g # +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Global load module: Allows loading and unloading of modules network- +# wide (USE WITH EXTREME CAUTION!) +# + #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # HELPOP module: Provides the /HELPOP command # @@ -813,6 +921,10 @@ # # +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Oper WHO module: Provides a more revealing /WHO to opers +# + #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Override module: Adds support for oper override # @@ -879,6 +991,11 @@ # Restrict message module: Allows users to only message opers # +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Provide /LIST throttling (to prevent flooding) and /LIST safety to +# prevent excess flood when the list is large. +# + #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # SAJOIN module: Adds the /SAJOIN command # @@ -899,6 +1016,11 @@ # SAQUIT module: Adds the oper /SAQUIT command (abusable!!!) # +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#- +# Secure list module: Prevent /LIST in the first minute of connection, +# crippling most spambots and trojan spreader bots. +# + #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Set Idle module: Adds a command for opers to change their # idle time (mainly a toy) @@ -925,11 +1047,25 @@ # to see when they are whois'ed # +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Spy module: Adds the commands SPYLIST and SPYNAMES that let opers +# see who is in a +s channel, and list +s channels, show keys of keyed +# channels the oper is not a member of etc. (standard 'abusive' features +# of unrealircd, modulized here in InspIRCd). +# + #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # SSL channel mode module: Adds support for SSL-only channels (+z). # does not do anything useful without a working SSL module (see below) # +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Dummy ssl module: If you have other servers on your network which +# have SSL, but your server does not have ssl enabled, you should load +# this module, which will handle SSL metadata (e.g. the "Is using ssl" +# field in the WHOIS information). +# + #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # GnuTLS ssl module: Adds support for client-server SSL using GnuTLS, # if enabled. You must copy the source for this module from the directory @@ -1025,6 +1161,11 @@ # Timed bans module: Adds timed bans and the /TBAN command # +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Uninvite module: Adds the /UNINVITE command which lets users remove +# pending invites from channels without waiting for the user to join. +# + #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Userip module: Adds the /USERIP command #