X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=docs%2Finspircd.conf.example;h=3945a2ece945bb9941bab1a76f524fd40e7e93d0;hb=8c9976bb52f799154a7b221723bb501890e0bde2;hp=3c78a2e0d55186d4ad06444c62b7993577b4cd6e;hpb=6dfd6f39848f9133da16a81f2cf7407d3410af78;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/docs/inspircd.conf.example b/docs/inspircd.conf.example index 3c78a2e0d..3945a2ece 100644 --- a/docs/inspircd.conf.example +++ b/docs/inspircd.conf.example @@ -14,13 +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 # +# Last updated on : 04/09/2006 # # Written by : CC (cc@backchat.co.za) # # Updated by : katsklaw (katsklaw@gmail.com) # # Updated by : brain (brain@inspircd.org) # @@ -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,12 +79,18 @@ # # # 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 address ports bind to. Leaving this # +# field blank binds the port to all IPs available. # +# # +# 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 # -# format. # +# format. SSL support is provided by modules, to # +# enable SSL support, please read the module section # +# of this configuration file. # +# # # ____ _ _____ _ _ ____ _ _ _ # # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | # # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | # @@ -97,8 +106,14 @@ # # # 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. # # # @@ -132,7 +147,7 @@ # slash (/) in which case it is treated as an absolute path. # # # # Syntax is as follows: # -# # +# # # # #-#-#-#-#-#-#-#-#-#- CONNECTIONS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-# @@ -151,21 +166,26 @@ # # # # # # -# # +# # # # # # +# 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 # # is closed if USER/NICK/PASS are not given. This value is in secs # # # # 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 +209,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,9 +221,10 @@ # # - + + #-#-#-#-#-#-#-#-#-#-#-#- CLASS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#- @@ -226,12 +247,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 -#-#-#-#-#-#-#-#-#-#-# @@ -241,16 +267,20 @@ # This works alongside with the classes specified above. # # # # 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 # # 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. # # # # Syntax is as follows: # # # -# # +# # # # # ____ _ _____ _ _ ____ _ _ _ # # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | # @@ -273,27 +303,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 # -# # -# 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 - Sefines the kind of operator. This must match a type # +# tag you defined above, and is case sensitive. # # # # Syntax is as follows: # # # # # @@ -303,9 +355,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. # # # @@ -333,6 +391,32 @@ # UNLESS the connection fails (e.g. due to a bad # # password or servername) # # # +# 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 # +# 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. # +# # # 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. # @@ -341,11 +425,11 @@ # that server to operoverride modes. This should only be used for # # services and protected oper servers! # # # -# IMPORTANT NOTE: When specifying the ip address and/or host, the # -# server software will prioritize RESOLVED hostnames above ip # -# addresses, so for example if your target server resolves to a.b.com # -# you MUST put a.b.com into your link block, and NOT the IP address # -# of a.b.com. The system uses reverse resolution. # +# 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. # # # # ____ _ _____ _ _ ____ _ _ _ # # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | # @@ -362,13 +446,16 @@ @@ -378,17 +465,19 @@ #-#-#-#-#-#-#-#-#-#- MISCELLANEOUS CONFIGURATION -#-#-#-#-#-#-#-#-#-# # # # These options let you define the path to your motd and rules # -# files. # +# files. These should be absolute paths. # # # - + #-#-#-#-#-#-#-#-#-#-#-#-#-#-# 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. # # # # ____ _ _____ _ _ ____ _ _ _ # # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | # @@ -405,15 +494,29 @@ # 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. # +# # +# An example of using IPV4 nameservers over IPV6 +# + #-#-#-#-#-#-#-#-#-#-#-#-#-#-# 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. This is IMPORTANT and you must define # +# it or the ircd will refuse to start. # # # @@ -440,8 +543,8 @@ # 'registered' (e.g. after the initial USER/NICK/PASS on connection) # # so for example disabling NICK will not cripple your network. # # # -# # -# # + +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#- RTFM LINE -#-#-#-#-#-#-#-#-#-#-#-#-#-# @@ -462,6 +565,7 @@ # loglevel - specifies what detail of messages to log in the # # log file. You may select from debug, verbose, # # default, sparse and none. # +# # # allowhalfop - allows the +h channel mode # # # # noservices - If noservices is true, yes, or 1, then the first # @@ -469,6 +573,18 @@ # only useful on networks running the m_chanprotect # # module without services. # # # +# qaprefixes - If qaprefixes is true, yes, or 1, then users # +# with +q or +a will get the ~ or & prefixes # +# used in unreal. This is only useful on networks # +# running the m_chanprotect module # +# # +# 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 # +# clients from being confused by host changes, # +# especially in the case of bots, and it is # +# recommended that this option is enabled. # +# # # netbuffersize - size of the buffer used to receive data from # # clients. The ircd may only read() this amount # # of text in one go at any time. (OPTIONAL) # @@ -498,12 +614,16 @@ # 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 # +# ones if channels are secret (+s), private (+p) or # +# if the target user is invisible +i. # # # # customversion - If you specify this configuration item, and it is # # not set to an empty value, then when a user does # @@ -513,23 +633,82 @@ # 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. # +# # +# 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 # +# 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. # +# # @@ -549,9 +728,6 @@ # 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. # # ____ _ _____ _ _ ____ _ _ _ # # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | # # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | # @@ -571,235 +747,581 @@ # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Foobar module - does nothing -# +# Alias module: Allows you to define server-side command aliases +# +# +#-#-#-#-#-#-#-#-#-#-#- ALIAS DEFINITIONS -#-#-#-#-#-#-#-#-#-#-#-#-#-# +# # +# 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 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 # +# replace - The text to replace 'text' with. Usually this # +# 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 # +# actually being on the network. If the user is # +# online, but not on a u-lined server, then an # +# 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. # +# # +# +# +# +# +# +# +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Chanprotect module: gives +q and +a channel modes -# +# Antibear security module: Prevents 'bear.txt' based trojans from +# connecting to your network by sending them a numeric they can't handle. +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Globops module: gives /GLOBOPS and usermode +g -# +# Antibottler module: Labels bottler leech bots +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Noinvite module: Gives channel mode +V -# +# Ban except module: Adds support for channel ban exceptions (+e) +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Oper MD5 module: Allows MD5 hashed oper passwords -# +# 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. # +# +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Restricted channels module: Allows only opers to create channels -# +# Block CAPS module: Blocking all-CAPS messages with cmode +P +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Deny Channels: Deny Channels from being used by users -# +# Block colour module: Blocking colour-coded messages with cmode +c +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Services support module: Adds several usermodes such as +R and +M -# +# Botmode module: Adds the user mode +B +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Userip module: Adds the /USERIP command -# +# CBAN module: Lets you disallow channels from being used at runtime. +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Alias module: Allows you to define server-side command aliases -# +# Censor module: Adds the channel mode +G +# +# +#-#-#-#-#-#-#-#-#-#-#- 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 # +# +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Channel filter module: Allows channel-op defined message +# filtering using simple string matches (channel mode +g) +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Chanprotect module: gives +q and +a channel modes +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # CHGHOST module: Adds the /CHGHOST command # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# HELPOP module: Provides the /HELPOP command -# +# CHGIDENT module: Adds the /CHGIDENT command +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# No kicks module: Adds the +Q channel mode -# +# 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, and should # +# be large numbers. Using small numbers such as "7" or "1924" will # +# seriously weaken the security of your cloak. # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Oper MOTD module: Provides support for seperate message of the day -# on oper-up -# +# Conn-Lusers: Shows the LUSERS output on connect +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Restrict message module: Allows users to only message opers -# +# 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. +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Sethost module: Adds the /SETHOST command -# +# 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 other # +# older ircds # +# # +# killonbadreply - Whether to kill the user if they send the wrong # +# PONG reply. # +# # +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Antibottler module: Labels bottler leech bots -# +# Connection throttle module. Configuration: +# +# +#-#-#-#-#-#-#-#-#-#-#- 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. +# +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Watch module: Adds the WATCH command, which is used by clients to -# maintain notify lists. -# +# 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' +# +# +# +# +# +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Cloaking module: Adds usermode +x and cloaking support -# +# Deny Channels: Deny Channels from being used by users +# +# +#-#-#-#-#-#-#-#-#-#-#- DENYCHAN DEFINITIONS -#-#-#-#-#-#-#-#-#-#-#-# +# # +# If you have the m_denychans.so module loaded, you need to specify # +# 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. # +# # +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Hostchange module: Allows a different style of cloaking -# +# Devoice Module: Let users devoice themselves. +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# No nicks module: Adds the +N channel mode -# +# Filter module: Provides glob-based message filtering +# +#OR +# PCRE filter module: Filters messages using regular expressions +# +# +#-#-#-#-#-#-#-#-#-#-#- 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. # +# # +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Override module: Adds support for oper override -# +# Foobar module: does nothing - historical relic +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# SAJOIN module: Adds the /SAJOIN command -# +# Globops module: gives /GLOBOPS and usermode +g +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Set Idle module: Adds a command for opers to change their -# idle time (mainly a toy) -# +# Global load module: Allows loading and unloading of modules network- +# wide (USE WITH EXTREME CAUTION!) +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Block colour module: Adds the +c channel mode -# +# HELPOP module: Provides the /HELPOP command +# +# +#-#-#-#-#-#-#-#-#-#-#-#- HELPOP CONFIGURATION -#-#-#-#-#-#-#-#-#-#-# +# # +# Optional - If you specify to use the m_helpop.so module, then # +# specify below the path to the helpop.conf file. # +# # +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Conn-Lusers: Shows the LUSERS output on connect -# +# Hostchange module: Allows a different style of cloaking +# +# +#-#-#-#-#-#-#-#-#-#-#- HOSTCHANGE CONFIGURATION -#-#-#-#-#-#-#-#-#-# +# # +# Optional - If you choose to use the m_hostchange.so module. # +# Config Help - See http://www.inspircd.org/wiki/Host_Changer_Module # +# # +# +# +# +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# httpd module: Provides http server support for InspIRCd +# +# +#-#-#-#-#-#-#-#-#-#-#-#- HTTPD CONFIGURATION -#-#-#-#-#-#-#-#-#-#-# +# +# Optional - If you choose to use the m_httpd.so module, then you must +# specify the port number and other details of your http server: +# +# +# +# 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 +# Requires m_httpd.so to be loaded for it to function. +# +# +#-#-#-#-#-#-#-#-#-#-#-#- HTTPD STATS CONFIGURATION -#-#-#-#-#-#-#-#-#-# +# +# +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Ident: Provides RFC 1413 ident lookup support # +# +#-#-#-#-#-#-#-#-#-#-#-#- IDENT CONFIGURATION -#-#-#-#-#-#-#-#-#-#-# +# # +# Optional - If you are using the m_ident.so module, then you can # +# 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. # +# # +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# No Notice module: adds the channel mode +T -# +# Invite except module: Adds support for channel invite exceptions (+I) +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Parking module: Adds parking support and /PARK and /UNPARK -# +# Join flood module: Adds support for join flood protection (+j) +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# SAMODE module: Adds the oper /SAMODE command -# +# Anti-Auto-Rejoin: Adds support for prevention of auto-rejoin (+J) +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# SETNAME module: Adds the /SETNAME command -# +# Knock module: adds the /KNOCK command and +K channel mode +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Botmode module: Adds the user mode +B -# +# Msg flood module: Adds message/notice flood protection (+f) +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Filter module: Provides glob-based message filtering -# +# MySQL module: Allows other SQL modules to access MySQL databases +# through a unified API. You must copy the source for this module +# from the directory src/modules/extra, plus the file m_sqlv2.h +# +# +#-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-# +# # +# m_mysql.so is more complex than described here, see the wiki for # +# more: http://www.inspircd.org/wiki/SQL_Service_Provider_Module # +# +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Knock module: adds the /KNOCK command and +K channel mode -# +# 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. +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Oper channels mode: Adds the +O channel mode -# +# Nicklock module: Let opers change a user's nick and then stop that +# user from changing their nick again. +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Random Quote module: provides a random quote on connect -# +# No ctcp module: Adds the channel mode +C to block CTCPs +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# SANICK module: Allows opers to change user's nicks -# +# Noinvite module: Gives channel mode +V +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Show Whois module: Adds the +W usermode which allows opers -# to see when they are whois'ed -# +# No kicks module: Adds the +Q channel mode +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Strip colour module: Adds the channel mode +S -# +# No nicks module: Adds the +N channel mode +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Censor module: Adds the channel mode +G -# +# No Notice module: adds the channel mode +T +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Nick locking module: Adds the oper-only /NICKLOCK command -# +# Oper channels mode: Adds the +O channel mode +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Oper Join module: Forces opers to join a channel on oper-up # +# +#-#-#-#-#-#-#-#-#-#-# OPERJOIN CONFIGURATION -#-#-#-#-#-#-#-#-#-#-# +# # +# If you are using the m_operjoin.so module, specify the channel here # +# # +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Redirect module: Adds channel redirection (mode +L) -# +# Oper MOTD module: Provides support for seperate message of the day +# on oper-up +# +# +#-#-#-#-#-#-#-#-#-#-# OPERMOTD CONFIGURATION -#-#-#-#-#-#-#-#-#-#-# +# # +# If you are using the m_opermotd.so module, specify the motd here # +# # +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# SAPART module: Adds the oper /SAPART command -# +# Override module: Adds support for oper override +# +# +#-#-#-#-#-#-#-#-#-#-# OVERRIDE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-# +# # +# m_override.so is too complex it describe here, see the wiki: # +# http://www.inspircd.org/wiki/Oper_Override_Module # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# SILENCE module: Adds support for /SILENCE -# +# Oper levels module: Gives each oper a level and prevents +# actions being taken against higher level opers +# Specify the level as the 'level' parameter of the tag +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Test command module: Does nothing significant -# +# Oper MD5 module: Allows MD5 hashed oper passwords +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Channel filter module: Allows channel-op defined message -# filtering using simple string matches (channel mode +g) -# +# Oper SHA256 module: Allows SHA256 hashed oper passwords +# This module is in src/modules/extra +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# No ctcp module: Adds the channel mode +C to block CTCPs -# +# Oper modes module: Allows you to specify modes to add/remove on oper +# Specify the modes as the 'modes' parameter of the tag +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Oper levels module: Gives each oper a level and prevents -# actions being taken against higher level opers -# +# PostgreSQL module: Allows other SQL modules to access PgSQL databases +# through a unified API. You must copy the source for this module +# from the directory src/modules/extra, plus the file m_sqlv2.h +# +# +#-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-# +# # +# m_pgsql.so is more complex than described here, see the wiki for # +# more: http://www.inspircd.org/wiki/SQL_Service_Provider_Module # +# +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# 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) +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Remove module: Adds the /REMOVE command which is a peaceful # alternative to /KICK # +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Restricted channels module: Allows only opers to create channels +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# 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 +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# SAMODE module: Adds the oper /SAMODE command +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# SANICK module: Allows opers to change user's nicks +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# SAPART module: Adds the oper /SAPART command +# + #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # 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. +# + #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Timed bans module: Adds timed bans and the /TBAN command -# +# Set Idle module: Adds a command for opers to change their +# idle time (mainly a toy) +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Oper modes module: Allows you to specify modes to add/remove on oper -# +# Services support module: Adds several usermodes such as +R and +M +# this module implements the 'identified' state via user mode +r, which +# is similar to the DALnet and dreamforge systems. +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# SWHOIS module: Allows you to add arbitary lines to user WHOIS. -# +# Services support module: Adds several usermodes such as +R and +M +# this module implements the 'identified' state via account names (AC) +# and is similar in operation to the way asuka and ircu handle services. +# it cannot be used at the same time as m_services, above. +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Ban except module: Adds support for channel ban exceptions (+e) -# +# Sethost module: Adds the /SETHOST command +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Invite except module: Adds support for channel invite exceptions (+I) -# +# Setident module: Adds the /SETIDENT command +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# SETNAME module: Adds the /SETNAME command +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Show Whois module: Adds the +W usermode which allows opers +# 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 many other ircds, 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, @@ -807,49 +1329,132 @@ # src/modules/extra, or answer 'yes' in ./configure when asked if you # want to enable this, or it will not load. # +# +#-#-#-#-#-#-#-#-#-#-#- GNUTLS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-# +# # +# m_ssl_gnutls.so is too complex it describe here, see the wiki: # +# http://www.inspircd.org/wiki/GnuTLS_SSL_Module # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# SSL channel mode module: Adds support for SSL-only channels (+z). -# does not do anything useful without a working SSL module (see above) -# +# SSL Info module: Allows users to retrieve information about other +# user's peer SSL certificates and keys. This can be used by client +# scripts to validate users. For this to work, one of m_ssl_gnutls.so +# or m_ssl_openssl.so must be loaded. You must symlink the source for +# this module from the directory src/modules/extra. +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Anti-Auto-Rejoin: Adds support for prevention of auto-rejoin (+J) -# +# OpenSSL ssl module: Adds support for client-server SSL using OpenSSL, +# if enabled. You must copy the source for this module from the directory +# src/modules/extra, or answer 'yes' in ./configure when asked if you +# want to enable this, or it will not load. +# +# +#-#-#-#-#-#-#-#-#-#-#- OPENSSL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-# +# # +# m_ssl_openssl.so is too complex it describe here, see the wiki: # +# http://www.inspircd.org/wiki/OpenSSL_SSL_Module # +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# 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. 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. +# -#-#-#-#-#-#-#-#-#-#-#- FILTER CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-# -# # -# Optional - If you specify to use the m_filter.so module, then # -# specfiy below the path to the filter.conf file. # +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Strip colour module: Adds the channel mode +S +# -# +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# SILENCE module: Adds support for /SILENCE +# +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# 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 +# +# +#-#-#-#-#-#-#-#-#-#-#- SQLAUTH CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-# +# # +# m_sqlauth.so is too complex it describe here, see the wiki: # +# http://www.inspircd.org/wiki/SQL_Authentication_Module # -#-#-#-#-#-#-#-#-#-#-#-#- HELPOP CONFIGURATION -#-#-#-#-#-#-#-#-#-#-# +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# SQL logging module: Allows you to log network-wide data for your +# network in a fully normalized set of SQL tables. You must copy the +# source for this module from the directory src/modules/extra +# +# +#-#-#-#-#-#-#-#-#-#-#- SQLLOG CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-# # # -# Optional - If you specify to use the m_helpop.so module, then # -# specify below the path to the helpop.conf file. # +# dbid - Database ID to use (see m_sql) # +# # +# See also: http://www.inspircd.org/wiki/SQL_Logging_Module # +# # +# - -# +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# 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 +# +# +#-#-#-#-#-#-#-#-#-#-#- SQLOPER CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-# +# # +# dbid - Database ID to use (see m_sql) # +# # +# See also: http://www.inspircd.org/wiki/SQL_Oper_Storage_Module # +# # +# +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# SWHOIS module: Allows you to add arbitary lines to user WHOIS. +# -#-#-#-#-#-#-#-#-#-#- RANDOMQUOTES CONFIGURATION -#-#-#-#-#-#-#-#-#-#-# -# # -# Optional - If you specify to use the m_randquotes.so module, then # -# specify below the path to the randquotes.conf file. # +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Test command module: Does nothing significant. Read: pointless. +# -# +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Timed bans module: Adds timed bans and the /TBAN command +# -#-#-#-#-#-#-#-#-#-#-#-#- IDENT CONFIGURATION -#-#-#-#-#-#-#-#-#-#-# +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Test line module: Adds the /TLINE command, used to test how many +# users a /GLINE or /ZLINE etc would match. +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# 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 +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Vhost module: Adds the VHOST command which allows for adding virtual +# hosts which are accessible using a username and password in the config. +# +# +#-#-#-#-#-#-#-#-#-#-#- VHOST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-# # # -# Optional - If you are using the m_ident.so module, then you can # -# 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. # +# user - Username for the vhost. # +# # +# pass - Password for the vhost. # +# # +# host - Vhost to set. # +# +# -# +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Watch module: Adds the WATCH command, which is used by clients to +# maintain notify lists. +# #-#-#-#-#-#-#-#-#-#-#-#-#-#- BAN OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-#-# # # @@ -861,6 +1466,7 @@ # badip lines ban an ip range (same as a zline) # # # # ipmask - The ip range to ban (wildcards possible) # +# CIDR is supported in the IP mask. # # reason - Reason to display when disconnected # # # # badnick lines ban a nick mask (same as a qline) # @@ -871,11 +1477,13 @@ # badhost lines ban a user@host mask (same as a kline) # # # # host - ident@hostname (wildcards possible) # +# If you specify an IP, CIDR is supported. # # reason - Reason to display on disconnection # # # # exception lines define a hostmask that is excempt from [kzg]lines # # # # host - ident@hostname (wildcards possible) # +# If you specify an IP, CIDR is supported. # # reason - Reason, shown only in /stats e # # # @@ -888,44 +1496,15 @@ + -#-#-#-#-#-#-#-#-#-#-#- ALIAS DEFINITIONS -#-#-#-#-#-#-#-#-#-#-#-#-#-# -# # -# 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.# -# 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. May 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 # -# 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 # -# actually being on the network. If the user is # -# online, but not on a u-lined server, then an # -# oper-alert is sent out as this is possibly signs # -# of a user trying to impersonate a service. # -# # - - - - - - #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#- YAWN -#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # # # You should already know what to do here :) # - + #########################################################################