X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=docs%2Finspircd.conf.example;h=2259858b0742499e4efe4608c96be2ff6dc81ec0;hb=6c6d83a21718b342c4f615dcca4093d06638f9fb;hp=ca65b9c90ed5487583797d11f8825d4f06578417;hpb=db7cd348e263ed270d128c35a81887a7c922ea66;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/docs/inspircd.conf.example b/docs/inspircd.conf.example index ca65b9c90..2259858b0 100644 --- a/docs/inspircd.conf.example +++ b/docs/inspircd.conf.example @@ -14,16 +14,13 @@ # |___/ # # # ##################################||#################################### - #||# + #||# ##################################||#################################### # # # This is an example of the config file for InspIRCd. # # Change the options to suit your network # # # -# Last updated on : 09/01/2006 # -# Written by : CC (cc@backchat.co.za) # -# Updated by : katsklaw (katsklaw@gmail.com) # -# Updated by : brain (brain@inspircd.org) # +# Last updated on : 03 Feb 2007 # # # # ____ _ _____ _ _ ____ _ _ _ # # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | # @@ -61,8 +58,8 @@ #-#-#-#-#-#-#-#-#-#-#-#- ADMIN INFORMATION -#-#-#-#-#-#-#-#-#-#-#-# # # -# Describes the Server Administrator's real name, nick # -# and email address. # +# Describes the Server Administrator's real name (optionally), # +# nick, and email address. # # # # Syntax is as follows: # # # # # - + #-#-#-#-#-#-#-#-#-#-#-#- PORT CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#- # # # Enter the port and address bindings here. # # # -# 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 # +# bind address - specifies which address ports bind to. Leaving this # +# field blank binds the port to all IPs 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. # +# 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 # # a standard tcp based socket, the servers type is a # # also a TCP based connection but of a different # -# format. # +# format. SSL support is provided by modules, to # +# enable SSL support, please read the module section # +# of this configuration file. # +# # +# 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' # +# respectively. If the module is not loaded, this # +# setting is ignored. # +# # +# transport - If you have m_spanningtree.so loaded, along with # +# either 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' # +# 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 # +# way data is sent and received, e.g. encryption, # +# compression, and other such things. Because this # +# may not be limited in use to just encryption, # +# the 'ssl' value used for client ports does not # +# exist for servers, and this value is used instead. # # ____ _ _____ _ _ ____ _ _ _ # # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | # # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | # @@ -105,19 +129,35 @@ # # # Syntax is as follows: # # # -# # -# # +# # +# # # # # If InspIRCd is built for IPV6, and you wish to accept IPV4 clients, # -# then you must specify your IPV6 clients in the following form: # -# ::ffff:1.2.3.4, where 1.2.3.4 is the IPV4 address to bind the # -# port on. If InspIRCd is built for IPV4 connections (this is the # -# default) then you do not need to prefix your addresses like this. # +# then you can specify IPV4 ip addresses here to bind. You may also # +# use the 4in6 notation, ::ffff:1.2.3.4, where 1.2.3.4 is the IPV4 # +# address to bind the port, but as of InspIRCd 1.1.1, this is not # +# required. # +# # +# ------------------------------------------------------------------- # # # +# PLEASE NOTE: If you have build InspIRCd as an ipv6 server, and you # +# specify an empty bind address, the binding will be bound to ALL THE # +# IPV6 IP ADDRESSES, and not the ipv4 addresses. If you are using an # +# ipv6 enabled InspIRCd and want to bind to multiple IPV4 addresses # +# in this way, you must specify them by hand. If you have built the # +# server for ipv4 connections only, then specifying an empty bind # +# address binds the port to all ipv4 IP addresses, as expected. # +# # + + + + +# When linking servers, the openssl and gnutls transports are largely +# link-compatible and can be used alongside each other or either/or +# on each end of the link without any significant issues. - - - + + #-#-#-#-#-#-#-#-#-#- DIE/RESTART CONFIGURATION -#-#-#-#-#-#-#-#-#-#- @@ -146,7 +186,7 @@ # slash (/) in which case it is treated as an absolute path. # # # # Syntax is as follows: # -# # +# # # # #-#-#-#-#-#-#-#-#-#- CONNECTIONS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-# @@ -168,7 +208,8 @@ # # # # # # -# IP masks may be specified in CIDR format for IPV4 and IPV6. # +# IP masks may be specified in CIDR format or wildcard format, # +# for IPV4 and IPV6. # # # # You may optionally include timeout="x" on any allow line, which # # specifies the amount of time given before an unknown connection # @@ -177,7 +218,7 @@ # 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 # -# not be disabled, however it can be set to exremely high values, # +# not be disabled, however it can be set to extremely 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 # @@ -197,7 +238,7 @@ # The optional recvq value is the maximum size which users in this # # group may grow their receive queue to. This is recommended to be # # kept pretty low compared to the sendq, as users will always # -# recieve more than they send in normal circumstances. The default # +# receive more than they send in normal circumstances. The default # # if not specified is 4096. # # # # IMPORTANT NOTE, CALL THE CONFUSION POLICE! # @@ -219,7 +260,7 @@ # # - + @@ -245,12 +286,17 @@ # You can create your own named classes, if you want, in fact that # # is the whole idea of this system! # # # +# Note: It is possible to make a class which covers all available # +# commands. To do this, specify commands="*". This is not really # +# recommended, as it negates the whole purpose of the class system, # +# however it is provided for fast configuration (e.g. in test nets) # +# # - - + + - - + + #-#-#-#-#-#-#-#-#-#-#-#- OPERATOR COMPOSITION -#-#-#-#-#-#-#-#-#-#-# @@ -266,13 +312,14 @@ # # # classes - specified above, used for flexibility for the # # server admin to decide on which operators get # -# what commands # +# what commands. Class names are case sensitive, # +# seperate multiple class names with spaces. # # # -# host - optional hostmask operators will recieve on oper-up. # +# host - optional hostmask operators will receive on oper-up. # # # # Syntax is as follows: # # # -# # +# # # # # ____ _ _____ _ _ ____ _ _ _ # # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | # @@ -295,29 +342,49 @@ # Opers are defined here. This is a very important section. # # Remember to only make operators out of truthworthy people. # # # -# name - oper name, best to use lower-case # -# # -# password - password to oper-up, # -# encryption not supported by inspircd. However, there # -# are modules that allow for oper password encryption. # -# # -# host - host of client allowed to oper-up. # -# wildcards accepted, seperate multiple hosts with space # -# You may also specify CIDR ip addresses. # -# # -# type - specified above, defines the kind of operator # +# name - oper name, This is case sensitive, so it is best to # +# use lower-case. # +# # +# 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 # +# space. You may also specify CIDR ip addresses. # +# # +# 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 # +# connect to the ircd using a client certificate, # +# and will lock this oper block to only the user who # +# has that specific key/certificate pair. # +# This enhances security a great deal, however it # +# requires that opers use clients which can send ssl # +# client certificates, if this is configured for that # +# oper. Note that if the m_ssl_oper.so module is not # +# loaded, and/or one of m_ssl_openssl or m_ssl_gnutls # +# is not loaded, this configuration option has no # +# effect and will be ignored. # +# # +# type - Defines the kind of operator. This must match a type # +# tag you defined above, and is case sensitive. # # # # Syntax is as follows: # # # # # - + #-#-#-#-#-#-#-#-#-#-#- SERVER LINK CONFIGURATION -#-#-#-#-#-#-#-#-#-# @@ -326,9 +393,15 @@ # server may create outbound links to. # # # # name - The name is the canocial name of the server, does # -# not have to resolve - but it is expected to be sent # +# 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. * # +# # +# 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 # +# attempting the connect again. # # # # port - The TCP port for the remote server. # # # @@ -341,11 +414,16 @@ # autoconnect - Sets the server to autoconnect. Where x is the num. # # (optional) of seconds between attempts. e.g. 300 = 5 minutes. # # # -# encryptionkey - Encryption key to be used for AES encryption, where # -# supported. Links using the spanning tree protocol # -# support AES. The encryption key must be EXACTLY 8, # -# 16 or 32 characters in length for a 64, 128 or 256 # -# bit key, respectively. # +# 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 # +# 'openssl' and 'gnutls' which are types of SSL # +# encryption, and 'zip' which is for compression. # +# If you define a transport, both ends of the # +# connection must use a compatible transport for the # +# link to succeed. OpenSSL and GnuTLS are link- # +# compatible with each other. # # # # hidden - When using m_spanningtree.so for linking. you may # # set this to 'yes', and if you do, the IP address/ # @@ -357,12 +435,50 @@ # password or servername) # # # # allowmask - When this is defined, it indicates a range of IP # -# addresses to allow for this link (in CIDR form). # +# 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 # # the range 1.2.3.1 through 1.2.3.255, put 1.2.3.0/24 # # 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 # +# 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 # +# to this server fails. For example, you could define # +# two hub uplinks to a leaf server, and set an # +# american server to autoconnect, with a european # +# hub as its failover. In this situation, your ircd # +# will only try the link to the european hub if the # +# american hub is unreachable. NOTE that for the # +# intents and purposes of this option, an unreachable # +# server is one which DOES NOT ANSWER THE CONNECTION. # +# If the server answers the connection with accept(), # +# EVEN IF THE CREDENTIALS ARE INVALID, the failover # +# link will not be tried! Failover settings will also # +# apply to autoconnected servers as well as manually # +# connected ones. # +# # +# 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 # +# 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. # +# If you do not define this value, the first IP that # +# is not empty or localhost from your tags # +# will be bound to. This is usually acceptable, # +# however if your server has multiple network cards # +# then you may have to manually specify the bind # +# value instead of leaving it to automatic binding. # +# You can usually tell if you need to set this by # +# looking for the error 'Could not assign requested # +# address' in your log when connecting to servers. # +# # # to u:line a server (give it extra privilages 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. # @@ -371,11 +487,17 @@ # that server to operoverride modes. This should only be used for # # services and protected oper servers! # # # -# NOTE: If you have built InspIRCd with IPV6 support, and you want # -# to link to an IPV4 server, you must specify the IP address in the # -# form '::ffff:1.2.3.4' where 1.2.3.4 is the IP address of the target # -# server. If you have built InspIRCd for IPV4 (this is the default) # -# you should not prefix your IP addresses in this fashion. # +# ------------------------------------------------------------------- # +# # +# 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 # +# 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 # +# than the hostname of the server. # +# # +# ------------------------------------------------------------------- # # # # ____ _ _____ _ _ ____ _ _ _ # # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | # @@ -388,21 +510,31 @@ # information on how to load this module! If you do not load this # # module, server links will NOT work! # # # +# Also, if you define any transports, you must load the modules for # +# these transports BEFORE you load m_spanningtree, e.g. place them # +# above it in the configuration file. Currently this means the three # +# modules m_ssl_gnutls, m_ziplinks and m_ssl_openssl, depending on # +# which you choose to use. # +# # + ipaddr="penguin.box.com" + port="7000" + allowmask="69.58.44.0/24" + autoconnect="300" + failover="hub.other.net" + timeout="15" + transport="gnutls" + bind="1.2.3.4" + sendpass="outgoing!password" + recvpass="incoming!password"> + ipaddr="localhost" + port="7000" + allowmask="127.0.0.0/8" + sendpass="penguins" + recvpass="polarbears"> @@ -410,11 +542,23 @@ #-#-#-#-#-#-#-#-#-#- MISCELLANEOUS CONFIGURATION -#-#-#-#-#-#-#-#-#-# # # # These options let you define the path to your motd and rules # -# files. # +# files. If these are relative paths, they are relative to the # +# configurtion directory. # # # - + + +#-#-#-#-#-#-#-#-#-#-#-# MAXIMUM CHANNELS -#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# # +# This optional configuration tag lets you define the maximum number # +# of channels that both opers and users may be on at any one time. # +# the default is 20 for user and 60 for opers if this tag is not # +# defined. Remote users are not restricted in any manner. # +# # + + #-#-#-#-#-#-#-#-#-#-#-#-#-#-# DNS SERVER -#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # # @@ -439,31 +583,30 @@ # resolving even though the DNS server appears to be up! Most ISP and # # hosting provider DNS servers support recursive lookups. # # # -# NOTE: If you have built InspIRCd with IPV6 support, and you want # -# to use an IPV4 nameserver, you must specify the IP address in the # -# form '::ffff:1.2.3.4' where 1.2.3.4 is the IP address of the target # -# server. If you have built InspIRCd for IPV4 (this is the default) # -# you should not prefix your IP addresses in this fashion. # +# ------------------------------------------------------------------- # # # -# IF YOUR RESOLV.CONF CONTAINS ONLY IPV4 ADDRESSES, AND YOU ARE USING # -# IPV6, YOU MUST DEFINE THE TAG, AND USE THE ::FFFF # -# PREFIX NOTATION. IF YOU DO NOT, HOSTS WILL *NOT* RESOLVE. # +# NOTE: if you have built InspIRCd with IPV6 support, then both # +# ipv6 and ipv4 addresses are allowed here, and also in the system # +# resolv.conf file. Remember that an ipv4 dns server can still # +# resolve ipv6 addresses, and vice versa. # # # -# An example of using IPV4 nameservers over IPV6 -# +# 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. # +# 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. # # # - +# #-#-#-#-#-#-#-#-#-#-#-#-#- BANLIST LIMITS #-#-#-#-#-#-#-#-#-#-#-#-#-#-# # # @@ -504,7 +647,15 @@ # # # Settings to define which features are useable on your server. # # # -# prefixquit - a prefix for a client's quit message # +# prefixquit - A prefix to be placed on the start of a client's # +# quit message # +# # +# suffixquit - A suffix to be placed on the end of a client's # +# quit message. # +# # +# fixedquit - A fixed quit message to display for all client # +# QUITS. If specified, overrides both prefixquit # +# and suffixquit options. # # # # loglevel - specifies what detail of messages to log in the # # log file. You may select from debug, verbose, # @@ -522,6 +673,12 @@ # used in unreal. This is only useful on networks # # running the m_chanprotect module # # # +# deprotectself - If this value is set to yes, true, or 1, then any # +# user with +q or +a may remove the +q or +a from # +# themselves. The default setting is to not enable # +# this feature, which stops even the founder taking # +# away their founder status without using services. # +# # # cyclehosts - If this is set to true, yes or 1, then when a # # user's hostname changes, they will appear to quit # # and then rejoin with their new host. This prevents # @@ -558,12 +715,11 @@ # if defined sets a soft maxconnections value, has # # to be less than the ./configure maxclients # # # -# operonlystats - The operonlystats field is optional and specifies # -# which stats characters in /STATS may only be # -# requested by an IRC operator. Stats characters in # -# this field are case sensitive and enforced as # -# oper-only independent of if they are in a module # -# or the core. # +# userstats - The userstats field is optional and specifies # +# which stats characters in /STATS may be requested # +# by non-operators. Stats characters in this field # +# are case sensitive and are allowed to users # +# independent of if they are in a module or the core # # # # operspywhois - If this is set then when an IRC operator uses # # /WHOIS on a user they will see all channels, even # @@ -611,30 +767,49 @@ # 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. # -# # # nouserdns - If set to 'yes', 'true' or '1', no user dns # # lookups will be performed for connecting users. # # this can save a lot of resources on very busy irc # # servers. # # # -# syntaxhints - If set to 'yes', 'true' or '1', when a user does # +# syntaxhints - If set to 'yes', 'true' or '1', when a user does # # not give enough parameters for a command, a syntax # # hint will be given (using the RPL_TEXT numeric) # # as well as the standard ERR_NEEDMOREPARAMS. # # # +# announcets - If this value is defined to 'yes', 'true' or '1', # +# then if a channel's timestamp is updated the users # +# on the channel will be informed of the change via # +# a server notice to the channel with the old and # +# new TS values in the timestamp. If you think this # +# is just pointless noise, define the value to 0. # +# # +# ircumsgprefix - Use undernet style message prefix for channel # +# NOTICE and PRIVMSG adding the prefix to the line # +# of text sent out. Eg. NOTICE @#test :@ testing # +# vs. the off setting: NOTICE @#test :testing # +# # +# hostintopic - If this is set to yes (the default) then the full # +# nick!user@host is shown for who set a TOPIC last. # +# if set to no, then only the nickname is shown. # +# # +# announceinvites # +# - If this option is set to yes (the default), then # +# invites are announced to the channel when a user # +# invites annother user. If you consider this to be # +# unnecessary noise, explicitly set this to no. # +# # +#-#-#-#-#-#-#-#-#-#-#-#-#-#- TIME SYNC OPTIONS -#-#-#-#-#-#-#-#-#-#-#-# +# Time sychronization options for m_spanningtree linking. # +# # +# Because IRC is very time and clock dependent, InspIRCd provides its # +# own methods for syncronization of time between servers as shown # +# in the example below, for servers that don't have ntpd running. # +# # +# enable - If this value is 'yes', 'true', or '1', time # +# synchronization is enabled on this server. This # +# means any servers you are linked to will # +# automatically synchronize time, however you should # +# use ntpd instead where possible, NOT this option. # +# # +# master - If this value is set to yes, then this server will # +# act as the authoritative time source for the whole # +# network. All other servers will respect its time # +# without question, and match their times to it. # +# only one server should have the master value set # +# to 'yes'. # +# # + + +#-#-#-#-#-#-#-#-#-#-#-#-#- WHOWAS OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-# +# # +# This tag lets you define the behaviour of the /whowas command of # +# your server. # +# # +# groupsize - Controls the maximum entries per nick shown when # +# performing a /whowas nick. Setting this to 0 dis- # +# ables whowas completely. # +# # +# maxgroups - The maximum number of nickgroups that can be added # +# to the list. If max is reached, oldest group will # +# be deleted first like a FIFO. A groupsize of 3 and # +# a maxgroups of 5000 will allow for 5000 nicks to # +# be stored with a history of 3, thus giving a total # +# of 3 * 5000 = 15000 entries. A setting of 0 dis- # +# ables whowas completely. # +# # +# maxkeep - The maximum time a nick is kept in the whowas list # +# before being pruned. Time may be specified in # +# seconds, or in the following format: 1y2w3d4h5m6s # +# meaning one year, two weeks, three days, 4 hours, # +# 5 minutes and 6 seconds. All fields in this format # +# are optional. Minimum is 1 hour, if less InspIRCd # +# will default back to 1 hour. # +# # +# # #-#-#-#-#-#-#-#-#-#-#-#-#- MODULE OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-# @@ -665,9 +893,10 @@ # http://www.inspircd.org/wiki/Modules_List for a list of modules and# # each modules link for any additional conf tags they require. # # # -# WINDOWS USERS PLEASE NOTE: You can still load these modules! They # -# are incorporated into the executable and can be loaded and removed # -# similarly to if they were in a ramdisk. # +# You may use wildcards in a tag to load all modules which # +# match a glob pattern (e.g. m_sa????.so would load m_sajoin, # +# m_sapart, m_saquit and m_sanick) # +# # # ____ _ _____ _ _ ____ _ _ _ # # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | # # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | # @@ -686,6 +915,27 @@ # # + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# MD5 Module - Allows other modules to generate MD5 hashes, usually for +# cryptographic uses and security. +# +# IMPORTANT: +# Other modules such as m_cloaking.so and m_opermd5.so may rely on +# this module being loaded to function. +# +# +# +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# SHA256 Module - Allows other modules to generate SHA256 hashes, +# usually for cryptographic uses and security. +# +# IMPORTANT: +# Other modules such as m_opermd5.so may rely on this module being +# loaded to function. +# +# + #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Alias module: Allows you to define server-side command aliases # @@ -694,18 +944,47 @@ # # # If you have the m_alias.so module loaded, you may also define # # aliases as shown below. They are commonly used to provide shortcut # -# commands to services, however they are not limited to jsut this use.# +# commands to services, however they are not limited to just this use.# # An alias tag requires the following values to be defined in it: # # # -# text - The text to detect at the start of the line, # -# must be at the start of the line to trigger the # -# alias. Cant contain spaces, but case insensitive # +# text - The text to detect as the actual command line, # +# Cant contain spaces, but case insensitive. # +# You may have multiple aliases with the same # +# command name (text="" value), however the first # +# found will be executed if its format value is # +# matched, or it has no format value. Aliases are # +# read from the top of the file to the bottom. # +# # +# format - If this is defined, the parameters of the alias # +# must match this glob pattern. For example if you # +# want the first parameter to start with a # for # +# the alias to be executed, set format="#*" in the # +# alias definition. Note that the :'s which are # +# part of IRC formatted lines will be preserved # +# for matching of this text. This value is # +# optional. # +# # # replace - The text to replace 'text' with. Usually this # -# will be "PRIVMSG ServiceName" or similar. # +# will be "PRIVMSG ServiceName :$2-" or similar. # +# You may use the variables $1 through $9 in the # +# replace string, which refer to the first through # +# ninth word in the original string typed by the # +# user. You may also use $1- through $9- which # +# refer to the first word onwards, through to the # +# ninth word onwards, e.g. if the user types the # +# command "foo bar baz qux quz" then $3- will hold # +# "baz qux quz" and $2 will contain "bar". You may # +# also use the special variables: $nick, $ident, # +# $host and $vhost, and you may seperate multiple # +# commands with \n. If you wish to use the ACTUAL # +# characters \ and n together in a line, you must # +# use the sequence "\\n". # +# # # requires - If you provide a value for 'requires' this means # # the given nickname MUST be online for the alias # # to successfully trigger. If they are not, then # # the user receives a 'no such nick' 401 numeric. # +# # # uline - Defining this value with 'yes', 'true' or '1' # # will ensure that the user given in 'requires' # # must also be on a u-lined server, as well as # @@ -714,10 +993,38 @@ # oper-alert is sent out as this is possibly signs # # of a user trying to impersonate a service. # # # -# -# -# -# +# operonly - Defining this value, with a value of 'yes', '1' # +# or true will make the alias oper only. If a non- # +# oper attempts to use the alias, it will appear # +# to not exist. # +# # +# +# +# +# +# +# +# +# An example of using the format value to create an alias with two +# different behaviours depending on the format of the parameters. +# +# +# +# +# +# This alias fixes a glitch in xchat 2.6.x and above and the way it +# assumes IDENTIFY must be prefixed by a colon (:) character. It should +# be placed ABOVE the default NICKSERV alias (the first example) listed +# above. +# +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Alltime module: Shows time on all connected servers at once +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Antibear security module: Prevents 'bear.txt' based trojans from @@ -732,6 +1039,11 @@ # Ban except module: Adds support for channel ban exceptions (+e) # +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Ban redirection module: Allows bans which redirect to a specified +# channel. e.g. +b nick!ident@host#channelbanneduserissentto +# + #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Block amsg module: Attempt to block all usage of /amsg and /ame # @@ -752,6 +1064,22 @@ #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Block CAPS module: Blocking all-CAPS messages with cmode +P # +# # +#-#-#-#-#-#-#-#-#-#-#- BLOCKCAPS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-# +# # +# percent - How many percent of text must be caps before text # +# will be blocked. # +# # +# minlen - The minimum length a line must be for the block # +# percent to have any effect. # +# # +# capsmap - A list of chars to be considered CAPS, this was # +# you can add CAPS for your language. Also you can # +# add things like ! and space to further lock down # +# on caps usage. # +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Block colour module: Blocking colour-coded messages with cmode +c @@ -771,11 +1099,35 @@ # #-#-#-#-#-#-#-#-#-#-#- CENSOR CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-# # # -# Optional - If you specify to use the m_censor module, then specfiy # -# below the path to the censor.conf file. See also: # -# Censor file, see http://www.inspircd.org/wiki/Censor_Module # +# Optional - If you specify to use the m_censor module, then you must # +# specify some censor tags. See also: # +# http://www.inspircd.org/wiki/Censor_Module # +# +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# CGI:IRC module: Adds support for automatic host changing in CGI:IRC +# (http://cgiirc.sourceforge.net). +# +# +#-#-#-#-#-#-#-#-#-#-#-# CGIIRC CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-# # -# +# Optional - If you specify to use m_cgiirc, then you must specify one +# or more cgihost tags which indicate authorized CGI:IRC servers which +# will be connecting to your network, and an optional cgiirc tag. +# For more information see: http://www.inspircd.org/wiki/CGI-IRC_Module +# +# Set to yes if you want to notice opers when CGI clients connect +# +# +# The type field indicates where the module should get the real +# client's IP address from, for further information, please see the +# CGI:IRC documentation. +# +# # Get IP from PASS +# # Get IP from WEBIRC +# # Get IP from ident +# # See the docs #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Channel filter module: Allows channel-op defined message @@ -795,31 +1147,54 @@ # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Cloaking module: Adds usermode +x and cloaking support +# Cloaking module: Adds usermode +x and cloaking support. +# Relies on the module m_md5.so being loaded before m_cloaking.so in +# the configuration file. # # #-#-#-#-#-#-#-#-#-#-#- CLOAKING CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-# # # -# Optional - If ypu specify the m_cloaking.so module as above, you # +# Optional - If you 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. # +# Please note that the key values will accept any number, and should # +# be large numbers. Using small numbers such as "7" or "1924" will # +# seriously weaken the security of your cloak. It is recommended you # +# use hexdecimal numbers prefixed by "0x", as shown in this example, # +# with each key eight hex digits long. # + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Conn-Join: Allows you to force users to join one or more channels +# automatically upon connecting to the server. +# +# +#-#-#-#-#-#-#-#-#-#-#-#- CONNJOIN CONFIGURATION -#-#-#-#-#-#-#-#-#-#-# +# +# If you have m_conn_join.so loaded, you can configure it using the +# follow values: +# +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Conn-Lusers: Shows the LUSERS output on connect # +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Conn-Usermodes: Set modes on users when they connect +# When this module is loaded tags may have an optional +# modes="" value, which contains modes to add or remove from users +# when they connect to the server. +# + #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Conn-Wait-for-Pong: Don't let a user connect until they PONG # @@ -829,10 +1204,12 @@ # 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# +# sendsnotice - Whether to send a snotice on connect, like other # +# older ircds # +# # # killonbadreply - Whether to kill the user if they send the wrong # # PONG reply. # -# +# # # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# @@ -841,17 +1218,46 @@ # #-#-#-#-#-#-#-#-#-#-#- CONTHROTTLE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-# # seconds, maxconns - Amount of connections per . +# # timeout - Time to wait after the throttle was activated # before deactivating it. Be aware that the time # is seconds + timeout. +# # quitmsg - The message that users get if they attempt to # connect while the throttle is active. +# # bootwait - Amount of time to wait before enforcing the # throttling when the server just booted. # # +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# DCCALLOW module: Adds the /DCCALLOW command +# +# +#-#-#-#-#-#-#-#-#-#-#- DCCALLOW CONFIGURATION -#-#-#-#-#-#-#-#-#-#-# +# blockchat - Whether to block DCC CHAT as well as DCC SEND +# length - Default duration of entries in DCCALLOW list +# action - Default action to take if no action is specified +# can be 'block' or 'allow' +# +# File configuration: +# pattern - The glob pattern to match against +# action - Action to take if a user attempts to send a file +# that matches this pattern, can be 'block' or 'allow' +# +# +# +# +# +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Deaf module: adds support for ircu style usermode +d - deaf to +# channel messages and channel notices. +# + #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Deny Channels: Deny Channels from being used by users # @@ -859,34 +1265,47 @@ #-#-#-#-#-#-#-#-#-#-#- DENYCHAN DEFINITIONS -#-#-#-#-#-#-#-#-#-#-#-# # # # If you have the m_denychans.so module loaded, you need to specify # -# the channels to deny: +# the channels to deny: # # # # name - The channel name to deny. # +# # # allowopers - If operators are allowed to override the deny. # +# # # reason - Reason given for the deny. # -# +# # # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Devoice Module: Let users devoice themselves. # +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# DNS Blacklist Module: Provides support for looking up IPs on one or # +# more blacklists. # +# # +# # +# For configuration options please see the wiki page for m_dnsbl at # +# http://inspircd.org/wiki/DNS_Blacklist_Module # + #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Filter module: Provides glob-based message filtering # -#OR +# OR # PCRE filter module: Filters messages using regular expressions # # +# You may only use one or the other with these modules, network-wide. +# #-#-#-#-#-#-#-#-#-#-#- FILTER CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-# # # # Optional - If you specify to use the m_filter or m_filter_pcre # -# modules, then specfiy below the path to the filter.conf file. # -# -# +# modules, then specfiy below the path to the filter.conf file, # +# or define some tags. # +# # +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Foobar module - does nothing - historical relic +# Foobar module: does nothing - historical relic # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# @@ -905,9 +1324,20 @@ #-#-#-#-#-#-#-#-#-#-#-#- HELPOP CONFIGURATION -#-#-#-#-#-#-#-#-#-#-# # # # Optional - If you specify to use the m_helpop.so module, then # -# specify below the path to the helpop.conf file. # -# -# +# specify below the path to the helpop.conf file, or if you like to # +# make a mess, define your helpop tags in this conf. # +# # +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# HIDECHANS module: Allows opers to hide their channels list from non- +# opers by setting user mode +I on themselves. +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# HIDEOPER module: Allows opers to hide their oper status from non- +# opers by setting user mode +H on themselves. +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Hostchange module: Allows a different style of cloaking @@ -917,7 +1347,7 @@ # # # Optional - If you choose to use the m_hostchange.so module. # # Config Help - See http://www.inspircd.org/wiki/Host_Changer_Module # -# +# # # # # @@ -935,15 +1365,19 @@ # # +# You may have as many of these tags as you wish, each with a different +# IP, port, host or index file. Each one will act as an independent +# HTTP server. +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # http stats module: Provides basic stats pages over HTTP -# Required m_httpd.so -# +# Requires m_httpd.so to be loaded for it to function. +# # #-#-#-#-#-#-#-#-#-#-#-#- HTTPD STATS CONFIGURATION -#-#-#-#-#-#-#-#-#-# # -# No extra configuration yet. +# # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# @@ -956,7 +1390,7 @@ # specify the timeout for ident lookups here. If not defined, it will # # default to one second. This is a non-blocking timeout which holds # # the user in a 'connecting' state until the lookup is complete. # -# +# # # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# @@ -967,6 +1401,10 @@ # Join flood module: Adds support for join flood protection (+j) # +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Jump Server module: Adds support for the RPL_REDIR numeric +# + #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Anti-Auto-Rejoin: Adds support for prevention of auto-rejoin (+J) # @@ -975,6 +1413,16 @@ # Knock module: adds the /KNOCK command and +K channel mode # +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Lock server module: Adds /LOCKSERV and /UNLOCKSERV commands that is # +# used to temporarily close/open for new connections to the server. # +# These commands require OPER status and that the LOCKSERV UNLOCKSERV # +# are specified in a tag that the oper is part of. This is so # +# you can control who has access to this possible dangerous command. # +# If your server is locked and you got disconnected, do a REHASH from # +# shell to open up again. +# + #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Msg flood module: Adds message/notice flood protection (+f) # @@ -995,11 +1443,12 @@ #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # NAMESX module: Provides support for the NAMESX extension which allows # clients to see all the prefixes set on a user without getting confused. +# This is supported by mIRC, x-chat, klient, and maybe more. # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Nicklock module: Let opers change a user's nick and then stop that -# user from changing their nick again. /NICKLOCK and /NICKUNLOCK +# user from changing their nick again. # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# @@ -1026,6 +1475,28 @@ # Oper channels mode: Adds the +O channel mode # +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Oper hash module: Allows hashed oper passwords +# Relies on the module m_md5.so and/or m_sha256.so being loaded before +# m_oper_hash.so in the configuration file. +# +# +#-#-#-#-#-#-#-#-#-#-# OPER HASH CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-# +# +# To use this module, you must define a hash type for each oper's +# password you want to hash. For example: +# +# +# +# The types of hashing available vary depending on which hashing modules +# you load, but usually if you load m_sha256.so and m_md5.so, both md5 +# and sha256 type hashing will be available (the most secure of which +# is SHA256). + #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Oper Join module: Forces opers to join a channel on oper-up # @@ -1033,7 +1504,7 @@ #-#-#-#-#-#-#-#-#-#-# OPERJOIN CONFIGURATION -#-#-#-#-#-#-#-#-#-#-# # # # If you are using the m_operjoin.so module, specify the channel here # -# +# # # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# @@ -1044,8 +1515,8 @@ #-#-#-#-#-#-#-#-#-#-# OPERMOTD CONFIGURATION -#-#-#-#-#-#-#-#-#-#-# # # # If you are using the m_opermotd.so module, specify the motd here # -# -# +# # +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Override module: Adds support for oper override @@ -1062,29 +1533,11 @@ # Specify the level as the 'level' parameter of the tag # -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Oper MD5 module: Allows MD5 hashed oper passwords -# - -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Oper SHA256 module: Allows SHA256 hashed oper passwords -# This module is in src/modules/extra -# - #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Oper modes module: Allows you to specify modes to add/remove on oper # Specify the modes as the 'modes' parameter of the tag # -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Parking module: Adds parking support and /PARK and /UNPARK -# -# -#-#-#-#-#-#-#-#-#-#-#-# PARK CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-# -# # -# m_park.so is too complex it describe here, see the wiki: # -# http://www.inspircd.org/wiki/User_Parking_Module # - #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # PostgreSQL module: Allows other SQL modules to access PgSQL databases # through a unified API. You must copy the source for this module @@ -1099,15 +1552,17 @@ # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Random Quote module: provides a random quote on connect +# Random Quote module: provides a random quote on connect. +# NOTE: Some of these may mimic fatal errors and confuse users and +# opers alike! - BEWARE! # # #-#-#-#-#-#-#-#-#-#- RANDOMQUOTES CONFIGURATION -#-#-#-#-#-#-#-#-#-#-# # # # Optional - If you specify to use the m_randquote.so module, then # # specify below the path to the randquotes.conf file. # -# -# +# # +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Redirect module: Adds channel redirection (mode +L) @@ -1118,6 +1573,12 @@ # alternative to /KICK # +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Restrict banned users module: +# Disallows banned users on a channel from messaging the channel, +# changing nick, or changing the topic, if loaded. +# + #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Restricted channels module: Allows only opers to create channels # @@ -1130,6 +1591,22 @@ # Provide /LIST throttling (to prevent flooding) and /LIST safety to # prevent excess flood when the list is large. # +# +#-#-#-#-#-#-#-#-#-#-# SAFELIST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-# +# +# When using Safelist, you may set the following values; +# +# The first value, 'throttle', sets the amount of time in seconds a user +# must wait between LIST commands. For example, if this is set to 60 +# (the default) then the user may not /LIST more than once a minute. +# If not defined, the default value is 60 seconds. +# +# The second value, 'maxlisters', indicates the maximum number of users +# which may be retrieving a LIST at once. It is not recommended you raise +# this value, as increasing it too high can make your network vulnerable +# to floodbots which waste your bandwidth and CPU time with LIST requests. +# +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # SAJOIN module: Adds the /SAJOIN command @@ -1151,10 +1628,28 @@ # 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. # +# +#-#-#-#-#-#-#-#-#-# SECURELIST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-# +# # +# Securelist can be harmful to some irc search engines such as # +# netsplit.de and searchirc.com. To prevent securelist blocking these # +# sites from listing, define exception tags as shown below: # + + + +# # +# Define the following variable to change how long a user must wait # +# before issuing a LIST. If not defined, defaults to 60 seconds. # +# # +# # + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# See nicks module: Allow for SNOMASK +N which shows nick changes. +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Set Idle module: Adds a command for opers to change their @@ -1188,14 +1683,14 @@ #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Show Whois module: Adds the +W usermode which allows opers -# to see when they are whois'ed +# to see when they are whois'ed (can be annoying). # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # 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). +# of many other ircds, modulized here in InspIRCd). # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# @@ -1221,6 +1716,10 @@ # # # m_ssl_gnutls.so is too complex it describe here, see the wiki: # # http://www.inspircd.org/wiki/GnuTLS_SSL_Module # +# # +# NOTE: If you want to use this module to encrypt and sign your # +# server to server traffic, you MUST load it before m_spanningtree in # +# your configuration file! # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # SSL Info module: Allows users to retrieve information about other @@ -1241,14 +1740,18 @@ # # # m_ssl_openssl.so is too complex it describe here, see the wiki: # # http://www.inspircd.org/wiki/OpenSSL_SSL_Module # +# # +# NOTE: If you want to use this module to encrypt and sign your # +# server to server traffic, you MUST load it before m_spanningtree in # +# your configuration file! # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # SSL Cert Oper module: Allows opers to oper up using the key fingerprint # stored within their SSL certificate and key pair. # When using this module, one of m_ssl_gnutls.so or m_ssl_openssl.so must -# be loaded. Any value may be placed in the password field of the OPER -# command if your oper tag is fingerprint enabled. You must symlink the -# source for this module from the directory src/modules/extra. +# be loaded. An extra value should be added to enabled opers, which +# is in the following format: fingerprint="". For more information, +# see the example in the oper blocks. # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# @@ -1259,10 +1762,38 @@ # SILENCE module: Adds support for /SILENCE # +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Extended SILENCE module: Adds support for /SILENCE with additional +# features to silence based on invites, channel messages, etc. +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# SQLite3 module: Allows other SQL modules to access SQLite3 # +# databases through a unified API. You must link the source for this # +# module from the directory src/modules/extra to src/modules, plus # +# the file m_sqlv2.h # +# +# +#-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-# +# # +# m_sqlite.so is more complex than described here, see the wiki for # +# more: http://www.inspircd.org/wiki/SQLite3_Service_Provider_Module # +# +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# SQLutils module: Provides some utilities to SQL client modules, such +# as mapping queries to users and channels. You must copy the source +# for this module from the directory src/modules/extra/m_sqlutils.cpp +# and src/modules/extra/m_sqlutils.h into /src/modules +# Needed for, and loaded before: SQLauth and SQLoper +# + #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # SQL authentication module: Allows IRCd connections to be tied into # a database table (for example a forum). You must copy the source for # this module from the directory src/modules/extra +# Depends on the SQLutils module being loaded first. # # #-#-#-#-#-#-#-#-#-#-#- SQLAUTH CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-# @@ -1287,6 +1818,7 @@ #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # SQL oper module: Allows you to store oper credentials in an SQL table # You must copy the source for this module from the directory src/modules/extra +# Depends on the SQLutils module being loaded first. # # #-#-#-#-#-#-#-#-#-#-#- SQLOPER CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-# @@ -1297,6 +1829,12 @@ # # # +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# SVSHold module: Implements SVSHOLD. Like Q:Lines, but can only be # +# added/removed by Services. # +# + + #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # SWHOIS module: Allows you to add arbitary lines to user WHOIS. # @@ -1343,6 +1881,17 @@ # maintain notify lists. # +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# ZipLinks module: Adds support for zlib deflate on server to server +# connections. Both ends of the connection must load this module. +# +# +# +# To use this module, you must enable it as a transport type in your +# tags or tags using the transport name 'zip'. +# See the documentation of and , respectively. +# + #-#-#-#-#-#-#-#-#-#-#-#-#-#- BAN OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-#-# # # # The ban tags define nick masks, host masks and ip ranges which are # @@ -1387,11 +1936,35 @@ +#-#-#-#-#-#-#-#-#-#-#- INSANE BAN OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-#-# +# # +# This optional tag allows you to specify how wide a gline, eline, # +# kline, zline or qline can be before it is forbidden from being # +# set. By setting hostmasks="yes", you can allow all G, K, E lines, # +# no matter how many users the ban would cover. This is not # +# recommended! By setting ipmasks="yes", you can allow all Z lines, # +# no matter how many users these cover too. Needless to say we # +# don't recommend you do this, or, set nickmasks="yes", which will # +# allow any qline. # +# # +# The trigger value indicates how wide any mask will be before it is # +# prevented from being set. The default value is 95.5% if this tag is # +# not defined in your configuration file, meaning that if your # +# network has 1000 users, a gline matching over 955 of them will be # +# prevented from being added. # +# # +# Please note that remote servers (and services) are exempt from # +# these restrictions and expected to enforce their own policies # +# locally! # +# # + + + #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#- YAWN -#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # # # You should already know what to do here :) # - + #########################################################################