diff options
| author | danieldg <danieldg@e03df62e-2008-0410-955e-edbf42e46eb7> | 2010-02-06 04:29:02 +0000 |
|---|---|---|
| committer | danieldg <danieldg@e03df62e-2008-0410-955e-edbf42e46eb7> | 2010-02-06 04:29:02 +0000 |
| commit | 1d17a9d23e533e0a5e9a0cdec17fd40adf0f0821 (patch) | |
| tree | 908108707eb200c641234eb7c1fc48860b30f9be /docs/modules.conf.example | |
| parent | e071bd88391e00e4d3b0104ada985e08a9eb3210 (diff) | |
Move configuration examples to docs, remove automatic overwrite on make install
git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@12383 e03df62e-2008-0410-955e-edbf42e46eb7
Diffstat (limited to 'docs/modules.conf.example')
| -rw-r--r-- | docs/modules.conf.example | 1849 |
1 files changed, 1849 insertions, 0 deletions
diff --git a/docs/modules.conf.example b/docs/modules.conf.example new file mode 100644 index 000000000..cc8620e89 --- /dev/null +++ b/docs/modules.conf.example @@ -0,0 +1,1849 @@ +#-#-#-#-#-#-#-#-#-#-#-#-#- MODULE OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-# +# # +# These tags define which modules will be loaded on startup by your # +# server. Add modules without any paths. When you make your ircd # +# using the 'make' command, all compiled modules will be moved into # +# the folder you specified when you ran ./configure. The module tag # +# automatically looks for modules in this location. # +# If you attempt to load a module outside of this location, either # +# in the config, or via /LOADMODULE, you will receive an error. # +# # +# By default, ALL modules are commented out. You must uncomment them # +# or add lines to your config to load modules. Please refer to # +# http://wiki.inspircd.org/Modules for a list of modules and # +# each modules link for any additional conf tags they require. # +# # +# You may use wildcards in a <module> 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) # +# # +# ____ _ _____ _ _ ____ _ _ _ # +# | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | # +# | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | # +# | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| # +# |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) # +# # +# To link servers to InspIRCd, you MUST load the m_spanningtree # +# module. Since several features (like SSL server links) rely on # +# other modules being loaded before m_spanningtree, the module itself # +# is at the bottom of this file. DO NOT forget to load it. If you DO # +# NOT do this, server links will NOT work at all. ie. The ports will # +# NOT bind, and /connect will not work properly. This is by design, # +# to allow for the implementation of other linking protocols in # +# modules in the future. # +# # + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# 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_password_hash.so may rely on +# this module being loaded to function. +# +#<module name="m_md5.so"> +# +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# SHA256 Module - Allows other modules to generate SHA256 hashes, +# usually for cryptographic uses and security. +# +# IMPORTANT: +# Other modules such as m_password_hash.so may rely on this module being +# loaded to function. Certain modules such as m_spanningtree.so will +# function without this module but when it is loaded their features will +# be enhanced (for example the addition of HMAC authentication). +# +#<module name="m_sha256.so"> +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# RIPEMD160 Module - Allows other modules to generate RIPEMD160 hashes, +# usually for cryptographic uses and security. +# +# IMPORTANT: +# Other modules may rely on this module being loaded to function. +#<module name="m_ripemd160.so"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Abbreviation module: Provides the ability to abbreviate commands a-la +# BBC BASIC keywords. +#<module name="m_abbreviation.so"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Alias module: Allows you to define server-side command aliases +#<module name="m_alias.so"> +# +# Fantasy settings: +# +#<fantasy prefix="!" allowbots="no"> +# +# prefix: +# Set the prefix for in-channel aliases (fantasy commands) to the +# specified character. If not set, the default is "!". +# allowbots: +# If this is set to no, +B clients will not be able to use fantasy +# commands. If not set, the default is no. +# +#-#-#-#-#-#-#-#-#-#-#- 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 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. # +# # +# usercommand - If this is true, the alias can be run simply as # +# /aliasname. Defaults to true. # +# # +# channelcommand - If this is true, the alias can be used as an # +# in-channel alias or 'fantasy command', prefixed # +# by the fantasy prefix character, !aliasname by # +# default. Defaults to false. # +# # +# 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 :$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 separate multiple # +# commands with a newline (which can be written in # +# the file literally, or encoded as &nl; or \n # +# depending on the config format setting). # +# # +# 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. # +# # +#<alias text="NICKSERV" replace="PRIVMSG NickServ :$2-" requires="NickServ" uline="yes"> +#<alias text="CHANSERV" replace="PRIVMSG ChanServ :$2-" requires="ChanServ" uline="yes"> +#<alias text="OPERSERV" replace="PRIVMSG OperServ :$2-" requires="OperServ" uline="yes" operonly="yes"> +#<alias text="BOTSERV" replace="PRIVMSG BotServ :$2-" requires="BotServ" uline="yes"> +#<alias text="HOSTSERV" replace="PRIVMSG HostServ :$2-" requires="HostServ" uline="yes"> +#<alias text="MEMOSERV" replace="PRIVMSG MemoServ :$2-" requires="MemoServ" uline="yes"> +#<alias text="NS" replace="PRIVMSG NickServ :$2-" requires="NickServ" uline="yes"> +#<alias text="CS" replace="PRIVMSG ChanServ :$2-" requires="ChanServ" uline="yes"> +#<alias text="OS" replace="PRIVMSG OperServ :$2-" requires="OperServ" uline="yes" operonly="yes"> +#<alias text="BS" replace="PRIVMSG BotServ :$2-" requires="BotServ" uline="yes"> +#<alias text="HS" replace="PRIVMSG HostServ :$2-" requires="HostServ" uline="yes"> +#<alias text="MS" replace="PRIVMSG MemoServ :$2-" requires="MemoServ" uline="yes"> +# +# An example of using the format value to create an alias with two +# different behaviours depending on the format of the parameters. +# +#<alias text="ID" format="#*" replace="PRIVMSG ChanServ :IDENTIFY $2 $3" +# requires="ChanServ" uline="yes"> +# +#<alias text="ID" replace="PRIVMSG NickServ :IDENTIFY $2" +# requires="NickServ" uline="yes"> +# +# 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. +# +#<alias text="NICKSERV" format=":IDENTIFY *" replace="PRIVMSG NickServ :IDENTIFY $3-" +# requires="NickServ" uline="yes"> +# +# You may also add aliases to trigger based on something said in a +# channel, aka 'fantasy' commands, configured in the same manner as any +# other alias, with usercommand="no" and channelcommand="yes" The +# command must be preceded by the fantasy prefix when used. +# +#<alias text="CS" usercommand="no" channelcommand="yes" +# replace="PRIVMSG ChanServ :$1 $chan $2-" requires="ChanServ" uline="yes"> +# +# This would be used as "!cs <command> <options>", with the channel +# being automatically inserted after the command in the message to +# ChanServ, assuming the fantasy prefix is "!". + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Allowinvite module: Gives channel mode +A to allow all users to use +# /invite, and extban A to deny invite from specific masks +#<module name="m_allowinvite.so"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Alltime module: Shows time on all connected servers at once. +# This module is oper-only and provides /alltime. +# To use, ALLTIME must be in one of your oper class blocks. +#<module name="m_alltime.so"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Antibear security module: Prevents 'bear.txt' based trojans from +# connecting to your network by sending them a numeric they can't handle. +#<module name="m_antibear.so"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Antibottler module: Labels bottler leech bots +#<module name="m_antibottler.so"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Auditorium module: Adds channel mode +u which makes everyone else +# except you in the channel invisible, used for large meetings etc. +#<module name="m_auditorium.so"> +# +# Auditorium settings: +# +#<auditorium showops="no" operoverride="no"> +# +# showops: +# Setting this value to yes makes m_auditorium behave like unrealircd +# +u channel mode, e.g. ops see users joining, parting, etc, and users +# joining the channel see the ops. Without this flag, the mode acts +# like ircnet's +a (anonymous channels), showing only the user in the +# names list, and not even showing the ops in the list, or showing the +# ops that the user has joined. +# operoverride: +# Setting this value to yes makes m_auditorium affect the userlist for +# regular users only. Opers will view all users in the channel normally. + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Autoop module: Adds basic channel access controls via the +w listmode. +# For example, +w o:R:Brain will op anyone identified to the account "Brain" +# on join. +#<module name="m_autoop.so"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Ban except module: Adds support for channel ban exceptions (+e) +#<module name="m_banexception.so"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Ban redirection module: Allows bans which redirect to a specified +# channel. e.g. +b nick!ident@host#channelbanneduserissentto +#<module name="m_banredirect.so"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Block amsg module: Attempt to block all usage of /amsg and /ame +#<module name="m_blockamsg.so"> +# +#-#-#-#-#-#-#-#-#-#-#- BLOCKAMSG CONFIGURATION -#-#-#-#-#-#-#-#-#-#-# +# # +# If you have the m_blockamsg.so module loaded, you can configure it # +# with the <blockamsg> 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. # +# +#<blockamsg delay="3" action="killopers"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Block CAPS module: Blocking all-CAPS messages with cmode +B +#<module name="m_blockcaps.so"> +# # +#-#-#-#-#-#-#-#-#-#-#- 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. # +#<blockcaps percent="50" +# minlen="5" +# capsmap="ABCDEFGHIJKLMNOPQRSTUVWXYZ! "> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Block colour module: Blocking colour-coded messages with cmode +c +#<module name="m_blockcolor.so"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Botmode module: Adds the user mode +B +#<module name="m_botmode.so"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# CallerID module: Adds usermode +g which activates hybrid-style +# callerid (== block all private messages unless you /accept first) +#<module name="m_callerid.so"> +# +#-#-#-#-#-#-#-#-#-#-#- CALLERID CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-# +# maxaccepts - Maximum number of entires a user can add to his # +# /accept list. Default is 16 entries. # +# operoverride - Can opers (note: ALL opers) ignore callerid mode? # +# Default is no. # +# tracknick - Preserve /accept entries when a user changes nick? # +# If no (the default), the user is removed from # +# everyone's accept list if he changes nickname. # +# cooldown - Amount of time (in seconds) that must pass since # +# the last notification sent to a user before he can # +# be sent another. Default is 60 (1 minute). # +#<callerid maxaccepts="16" +# operoverride="no" +# tracknick="no" +# cooldown="60"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# CAP module: Provides the CAP negotiation mechanism seen in +# ratbox-derived ircds +#<module name="m_cap.so"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# CBAN module: Lets you disallow channels from being used at runtime. +# This module is oper-only and provides /cban. +# To use, CBAN must be in one of your oper class blocks. +#<module name="m_cban.so"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Censor module: Adds the channel mode +G +#<module name="m_censor.so"> +# +#-#-#-#-#-#-#-#-#-#-#- CENSOR CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-# +# # +# Optional - If you specify to use the m_censor module, then you must # +# specify some censor tags. See also: # +# http://wiki.inspircd.org/Modules/censor # +# +#<include file="censor.conf"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# CGI:IRC module: Adds support for automatic host changing in CGI:IRC +# (http://cgiirc.sourceforge.net). +#<module name="m_cgiirc.so"> +# +#-#-#-#-#-#-#-#-#-#-#-# CGIIRC CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-# +# +# Optional - If you specify to use m_cgiirc, then you must specify one +# or more cgihost tags which indicate authorised CGI:IRC servers which +# will be connecting to your network, and an optional cgiirc tag. +# For more information see: http://wiki.inspircd.org/Modules/cgiirc +# +# Set to yes if you want to notice opers when CGI clients connect +# <cgiirc opernotice="no"> +# +# 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. +# +# Old style: +# <cgihost type="pass" mask="www.mysite.com"> # Get IP from PASS +# <cgihost type="ident" mask="otherbox.mysite.com"> # Get IP from ident +# <cgihost type="passfirst" mask="www.mysite.com"> # See the docs +# New style: +# <cgihost type="webirc" password="foobar" +# mask="somebox.mysite.com"> # Get IP from WEBIRC +# +# IMPORTANT NOTE: +# --------------- +# +# When you connect CGI:IRC clients, there are two connect classes which +# apply to these clients. When the client initially connects, the connect +# class which matches the cgi:irc site's host is checked. Therefore you +# must raise the maximum local/global clients for this ip as high as you +# want to allow cgi clients. After the client has connected and is +# determined to be a cgi:irc client, the class which matches the client's +# real IP is then checked. You may set this class to a lower value, so that +# the real IP of the client can still be restricted to, for example, 3 +# sessions maximum. +# + + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Channel create module: Adds snomask +j, which will notify opers of +# any new channels that are created. +# This module is oper-only. +#<module name="m_chancreate.so"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Channel filter module: Allows channel-op defined message +# filtering using simple string matches (channel mode +g) +#<module name="m_chanfilter.so"> +# +# If hidemask is set to yes, the user will not be shown the mask when +# his/her message is blocked. +#<chanfilter hidemask="yes"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Channel History module: Displays the last 'X' lines of chat to a user +# joining a channel with +H 'X:T' set; 'T' is the maximum time to keep +# lines in the history buffer. Designed so that the new user knows what +# the current topic of conversation is when joining the channel. +# NOTE: Currently hard-limited to a maximum of 50 lines. +#<module name="m_chanhistory.so"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Channel logging module: used to send snotice output to channels, to +# allow staff to centrally monitor and discuss network activity. +# +# The "channel" field is where you want the messages to go, "snomasks" +# is what snomasks you want to be sent to that channel. Multiple tags +# are allowed. +#<module name="m_chanlog.so"> +#<chanlog snomasks="AOcC" channel="#opers"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Channel Names module: Allows disabling channels which have certain +# characters in the channel name such as bold, colourcodes, etc which +# can be quite annoying and allow users to on occasion have a channel +# that looks like the name of another channel on the network. +#<module name="m_channames.so"> + +<channames + # denyrange: characters or range of characters to deny in channel + # names. + denyrange="2,3" + + # allowrange: characters or range of characters to specifically allow + # in channel names. + allowrange=""> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Channelban: Implements extended ban j:, which stops anyone in already +# in a channel matching a mask like +b j:#channel*mask from joining. +#<module name="m_channelban.so"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Chanprotect module: gives +q and +a channel modes +#<module name="m_chanprotect.so"> + +<chanprotect + # noservices: With this set to yes, when a user joins a empty channel, + # the server will set +q on them. If set to no, it will only set +o + # on them until they register the channel. + noservices="no" + + # qprefix: Prefix (symbol) to use for +q users. + qprefix="~" + + # aprefix: Prefix (symbol) to use for +a users. + aprefix="&" + + # deprotectself: If this value is set (true, yes or 1), it will allow + # +a and +q users to remove the +a and +q from themselves, otherwise, + # the status will have to be removed by services. + deprotectself="yes" + + # deprotectothers: If this value is set to yes, true, or 1, then any + # user with +q or +a may remove the +q or +a from other users. + deprotectothers="yes"> + + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Check module: gives /check +# Check is useful for looking up information on channels, +# users, IP addresses and hosts. +# This module is oper-only. +# To use, CHECK must be in one of your oper class blocks. +#<module name="m_check.so"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# CHGHOST module: Adds the /CHGHOST command +# This module is oper-only. +# To use, CHGHOST must be in one of your oper class blocks. +# NOTE: Services will not be able to set vhosts on users if this module +# isn't loaded. If you're planning on running services, you probably +# want to load this. +#<module name="m_chghost.so"> +# +#-#-#-#-#-#-#-#-# /CHGHOST - /SETHOST CONFIGURATION #-#-#-#-#-#-#-#-# +# Optional - If you want to use special chars for hostnames you can # +# specify your own custom list of chars with the <hostname> tag: # +# # +# charmap - A list of chars accepted as valid by the /CHGHOST # +# and /SETHOST commands. Also note that the list is # +# case-sensitive. # +#<hostname charmap="abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ.-_/0123456789"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# CHGIDENT module: Adds the /CHGIDENT command +# This module is oper-only. +# To use, CHGIDENT must be in one of your oper class blocks. +#<module name="m_chgident.so"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# CHGNAME module: Adds the /CHGNAME command +# This module is oper-only. +# To use, CHGNAME must be in one of your oper class blocks. +#<module name="m_chgname.so"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# 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. +# To use, you should enable m_conn_umodes and add +x as +# an enabled mode. See the m_conn_umodes module for more information. +#<module name="m_cloaking.so"> +# +#-#-#-#-#-#-#-#-#-#-#- CLOAKING CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-# +# # +# If you specify the m_cloaking.so module as above, you must define # +# cloak keys, and optionally a cloak prefix as shown below. The cloak # +# keys must be shared across the network for correct cloaking. # +# # +# There are four methods of cloaking: # +# # +# half Cloak only the "unique" portion of a host; show # +# the last 2 parts of the domain, /16 subnet of IPv4 # +# or /48 subnet of the IPv6 address. # +# # +# full Cloak the users completely, using three slices for # +# common CIDR bans (IPv4: /16, /24; IPv6: /48, /64) # +# # +# These methods use a single key that can be any length of text. # +# An optional prefix may be specified to mark cloaked hosts. # +# # +# The following methods are maintained for backwards compatibility; # +# they are slightly less secure, and always hide unresolved IPs # +# # +# compat-host InspIRCd 1.2-compatible host-based cloaking # +# compat-ip InspIRCd 1.2-compatible ip-always cloaking # +# # +# You must specify key1, key2, key3, key4 for the compat cloaking # +# modes; the values must be less than 0x80000000 and should be picked # +# at random. Prefix is mandatory, will default to network name if not # +# specified, and will always have a "-" appended. # +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# +#<cloak mode="half" +# key="secret" +# prefix="net-"> + +#-#-#-#-#-#-#-#-#-#-#-#- CLOSE MODULE #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Close module: Allows an oper to close all unregistered connections. +# This module is oper-only and provides /close. +# To use, CLOSE must be in one of your oper class blocks. +#<module name="m_close.so"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Clones module: Adds an oper command /CLONES for detecting cloned +# users. Warning: This module may be resource intensive when its +# command is issued, use with care. +# This module is oper-only. +# To use, CLONES must be in one of your oper class blocks. +#<module name="m_clones.so"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Common channels module: Adds user mode +c, which, when set, requires +# that users must share a common channel with you to PRIVMSG or NOTICE +# you. +#<module name="m_commonchans.so"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Conn-Join: Allows you to force users to join one or more channels +# automatically upon connecting to the server. +#<module name="m_conn_join.so"> +# +#-#-#-#-#-#-#-#-#-#-#-#- CONNJOIN CONFIGURATION -#-#-#-#-#-#-#-#-#-#-# +# +# If you have m_conn_join.so loaded, you can configure it using the +# follow values: +# +#<autojoin channel="#one,#two,#three"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Conn-Usermodes: Set modes on users when they connect +# When this module is loaded <connect:allow> tags may have an optional +# modes="" value, which contains modes to add or remove from users +# when they connect to the server. +#<module name="m_conn_umodes.so"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Conn-Wait-for-Pong: Don't let a user connect until they PONG +#<module name="m_conn_waitpong.so"> +# +#-#-#-#-#-#-#-#-#-#-#- WAITPONG CONFIGURATION -#-#-#-#-#-#-#-#-#-#-# +# # +# If you have the m_conn_waitpong.so module loaded, configure it with # +# the <waitpong> 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. # +# # +#<waitpong sendsnotice="yes" killonbadreply="yes"> + + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Channel cycle module. Server side /hop, with +ilk etc bypass. +#<module name="m_cycle.so"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Connectban: Provides IP connection throttling. Any IP range that connects +# too many times (configurable) in an hour is zlined for a (configurable) +# duration, and their count resets to 0. +# +# ipv4cidr and ipv6cidr allow you to turn the comparison from individual +# IP addresses (32 and 128 bits) into CIDR masks, to allow for throttling +# over whole ISPs/blocks of IPs, which may be needed to prevent attacks. +# +#<connectban threshold="10" duration="10m" ipv4cidr="32" ipv6cidr="128"> +# This allows for 10 connections in an hour with a 10 minute ban if that is exceeded. +# +#<module name="m_connectban.so"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Connection throttle module. Configuration: +#<module name="m_connflood.so"> +# +#-#-#-#-#-#-#-#-#-#-#- CONTHROTTLE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-# +# seconds, maxconns - Amount of connections per <seconds>. +# +# 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. +# +#<connflood seconds="30" maxconns="3" timeout="30" +# quitmsg="Throttled" bootwait="10"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Custom title module: Adds the /TITLE command which allows for trusted +# users to gain a custom whois line and a optional +# vhost can be specified. +#<module name="m_customtitle.so"> +# +#-#-#-#-#-#-#-#-#-#- CUSTOM TITLE CONFIGURATION -#-#-#-#-#-#-#-#-#-# +# name - The username used to identify +# password - The password used to identify +# hash - The hash for the specific user's password (optional) +# m_password_hash.so and a hashing module must be loaded for this to work +# host - Allowed hostmask [optional] +# title - Title shown in whois +# vhost - Displayed host [optional] +# +#<title name="foo" password="bar" title="Official Chat Helper"> +#<title name="bar" password="foo" host="ident@host.name" title="Official Chat Helper" vhost="helper.network.chat"> +#<title name="foo" password="fcde2b2edba56bf408601fb721fe9b5c338d10ee429ea04fae5511b68fbf8fb9" hash="sha256" title="Official Chat Helper"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# DCCALLOW module: Adds the /DCCALLOW command +#<module name="m_dccallow.so"> +# +#-#-#-#-#-#-#-#-#-#-#- 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' +# +#<dccallow blockchat="yes" length="5m" action="block"> +#<banfile pattern="*.exe" action="block"> +#<banfile pattern="*.txt" action="allow"> +# +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Deaf module: adds support for ircu style usermode +d - deaf to +# channel messages and channel notices. +#<module name="m_deaf.so"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Delay join module: Adds the channel mode +D which delays all JOIN +# messages from users until they speak. If they quit or part before +# speaking, their quit or part message will not be shown to the channel +# which helps cut down noise on large channels in a more friendly way +# than the auditorium mode. Only channel ops may set the +D mode. +#<module name="m_delayjoin.so"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Delay message module: Adds the channel mode +d which disallows a user +# from talking in the channel unless they've been joined for X seconds. +# Settable a la: /mode +d 30 +#<module name="m_delaymsg.so> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Deny Channels: Deny Channels from being used by users +#<module name="m_denychans.so"> +# +#-#-#-#-#-#-#-#-#-#-#- 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. (glob masks are ok) # +# # +# allowopers - If operators are allowed to override the deny. # +# # +# reason - Reason given for the deny. # +# # +# redirect - Redirect the user to a different channel # +# # +#<badchan name="#gods*" allowopers="yes" reason="Tortoises!"> # +#<badchan name="#heaven" redirect="#hell" reason="Nice try!"> # +# # +# Redirects will not work if the target channel is set +L. # +# # +# Additionally, you may specify channels which are allowed, even if # +# a badchan tag specifies it would be denied: # +#<goodchan name="#godsleeps"> # +# Glob masks are accepted here also. + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Devoice Module: Let users devoice themselves. +#<module name="m_devoice.so"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# DNS Blacklist Module: Provides support for looking up IPs on one or # +# more blacklists. # +#<module name="m_dnsbl.so"> # +# # +# For configuration options please see the wiki page for m_dnsbl at # +# http://wiki.inspircd.org/Modules/dnsbl # + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Exempt Channel Operators Module: Provides support for allowing # +# channel operators to be exempt from some channel modes. Supported # +# modes are blockcaps, noctcp, blockcolor, nickflood, flood, censor, # +# filter, regmoderated, nonick, nonotice, and stripcolor. # +#<module name="m_exemptchanops.so"> # +# # +#-#-#-#-#-#-#-#-#-#- EXEMPTCHANOPS CONFIGURATION -#-#-#-#-#-#-#-#-#-# +# alwaysexempt - Modes channel operators are always exempt from, +# regardless of channel setting. +# neverexempt - Modes channel operators are never exempt from, +# regardless of channel setting. +#<exemptchanops alwaysexempt="nickflood censor flood filter" neverexempt="regmoderated"> + + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Filter module: Provides message filtering, similar to SPAMFILTER. +#<module name="m_filter.so"> +# # +# This module depends upon a regex provider such as m_regex_pcre or # +# m_regex_glob to function. You must specify which of these you want # +# m_filter to use via the tag below. # +# # +# Valid engines are: # +# # +# glob - Glob patterns, provided via m_regex_glob.so # +# pcre - PCRE regexps, provided via m_regex_pcre.so, needs libpcre # +# tre - TRE regexps, provided via m_regex_tre.so, requires libtre # +# posix - POSIX regexps, provided via m_regex_posix.so, not availale # +# on windows, no dependencies on other operating systems. # +# # +#<filteropts engine="glob"> # +# # +# Your choice of regex engine must match on all servers network-wide. +# +# You may specify specific channels that are exempt from being filtered: +#<exemptfromfilter channel="#blah"> +# +#-#-#-#-#-#-#-#-#-#-#- FILTER CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-# +# # +# Optional - If you specify to use the m_filter module, then # +# specfiy below the path to the filter.conf file, or define some # +# <filter> tags. # +# # +#<include file="filter.conf"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Gecosban: Implements extended ban r:, which stops anyone matching +# a mask like +b r:*realname?here* from joining a channel. +#<module name="m_gecosban.so"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# GeoIP module: Allows the server admin to ban users by country code. +# This modules is in extras. Re-run configure with: ./configure --enable-extras=m_geoip.cpp +# and run make install, then uncomment this module to enable it. +# This module requires GeoIP to be installed on your system, +# use your package manager to find the appropriate packages +# or check the InspIRCd wiki page for this module. +#<module name="m_geoip.so"> +# +#-#-#-#-#-#-#-#-#-#-#-# GEOIP CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-# +# # +# <geoip banunknown="false"> # +# # +# Set this value to true or yes to block unknown IP ranges which are # +# not in the database (usually LAN addresses, localhost, etc) # +# # +# <geoban country="TR" reason="This country not permitted"> # +# # +# Use one or more of these tags to ban countries by country code. # +# The country code must be in capitals and should be an ISO country # +# code such as TR, GB, or US. # + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Globops module: gives /GLOBOPS and SNOMASK +g +# This module is oper-only. +# To use, GLOBOPS must be in one of your oper class blocks. +#<module name="m_globops.so"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Global load module: Allows loading and unloading of modules network- +# wide (USE WITH EXTREME CAUTION!) +# This module is oper-only and provides /gloadmodule, /gunloadmodule +# and /greloadmodule. +# To use, GLOADMODULE, GUNLOADMODULE and GRELOADMODULE +# must be in one of your oper class blocks. +#<module name="m_globalload.so"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Halfop module: Provides the +h (halfops) channel status mode. +#<module name="m_halfop.so"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# HELPOP module: Provides the /HELPOP command +#<module name="m_helpop.so"> +# +#-#-#-#-#-#-#-#-#-#-#-#- HELPOP CONFIGURATION -#-#-#-#-#-#-#-#-#-#-# +# # +# Optional - If you specify to use the m_helpop.so module, then # +# specify below the path to the helpop.conf file, or if you like to # +# make a mess, define your helpop tags in this conf. # +# # +#<include file="helpop.conf"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# HIDECHANS module: Allows opers to hide their channels list from non- +# opers by setting user mode +I on themselves. +# <module name="m_hidechans.so"> +# +# HIDECHANS can optionally prevent opers from seeing channels on a +I +# user, for more privacy if set to true. +# This setting is not recommended for most mainstream networks. +#<hidechans affectsopers="false"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# HIDEOPER module: Allows opers to hide their oper status from non- +# opers by setting user mode +H on themselves. +# This module is oper-only. +# <module name="m_hideoper.so"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Hostchange module: Allows a different style of cloaking +#<module name="m_hostchange.so"> +# +#-#-#-#-#-#-#-#-#-#-#- HOSTCHANGE CONFIGURATION -#-#-#-#-#-#-#-#-#-# +# # +# Optional - If you choose to use the m_hostchange.so module. # +# Config Help - See http://wiki.inspircd.org/Modules/hostchange # +# # +#<host suffix="polarbears.org" separator="." prefix=""> +#<hostchange mask="*@fbi.gov" action="addnick"> +#<hostchange mask="*r00t@*" action="suffix"> +#<hostchange mask="a@b.com" action="set" value="blah.blah.blah"> +#<hostchange mask="localhost" ports="7000,7001,7005-7007" action="set" value="blahblah.foo"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# httpd module: Provides http server support for InspIRCd +#<module name="m_httpd.so"> +# +#-#-#-#-#-#-#-#-#-#-#-#- HTTPD CONFIGURATION -#-#-#-#-#-#-#-#-#-#-# +# +# If you choose to use the m_httpd.so module, then you will need to add +# a <bind> tag with type "httpd", and load at least one of the other +# m_httpd_* modules to provide pages to display. +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# http ACL module: Provides access control lists for m_httpd dependent +# modules. Use this module to restrict pages by IP address and by +# password. +# +#<module name="m_httpd_acl.so"> +# +#-#-#-#-#-#-#-#-#-#-#-#- HTTPD ACL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-# +# +# Restrict access to the m_httpd_stats module to all but the local +# network and when the correct password is specified: +# +# <httpdacl path="/stats*" types="password,whitelist" +# username="secretstuff" password="mypasshere" whitelist="127.0.0.*,10.*"> +# +# Deny all connections to all but the main index page: +# +# <httpdacl path="/*" types="blacklist" blacklist="*"> +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# http config module: Allows the server's configuration to be viewed +# over HTTP. Requires m_httpd.so to be loaded for it to function. +#<module name="m_httpd_config.so"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# http stats module: Provides basic stats pages over HTTP +# Requires m_httpd.so to be loaded for it to function. +#<module name="m_httpd_stats.so"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Ident: Provides RFC 1413 ident lookup support +# When this module is loaded <connect:allow> tags may have an optional +# useident="yes|no" boolean value, determining whether or not to lookup +# ident on users matching that connect tag. +#<module name="m_ident.so"> +# +#-#-#-#-#-#-#-#-#-#-#-#- 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. # +# The bind value indicates which IP to bind outbound requests to. # +# # +#<ident timeout="5"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Invite except module: Adds support for channel invite exceptions (+I) +#<module name="m_inviteexception.so"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Invisible module - Adds support for usermode +Q (quiet) which lets an +# oper go 'invisible' similar to unrealircd 3.1's +I mode. Note that +# opers are still able to see invisible users, and if an oper with +Q +# deopers, they will become visible. +# +# This module is oper-only and seen by many to be quite abusive. +# +#<module name="m_invisible.so"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Join flood module: Adds support for join flood protection (+j) +#<module name="m_joinflood.so"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Jump Server module: Adds support for the RPL_REDIR numeric +# This module is oper-only. +# To use, JUMPSERVER must be in one of your oper class blocks. +#<module name="m_jumpserver.so"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Anti-Auto-Rejoin: Adds support for prevention of auto-rejoin (+J) +#<module name="m_kicknorejoin.so"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Knock module: adds the /KNOCK command and +K channel mode +#<module name="m_knock.so"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# LDAP authentication module: Adds the ability to authenticate users # +# via LDAP. This is an extra module which must be enabled explicitly # +# by symlinking it from modules/extra, and requires the OpenLDAP libs # +# This modules is in extras. Re-run configure with: ./configure --enable-extras=m_ldapauth.cpp +# and run make install, then uncomment this module to enable it. # +# # +#<module name="m_ldapauth.so"> # +# # +# Configuration: # +# # +# <ldapauth baserdn="ou=People,dc=brainbox,dc=cc" # +# attribute="uid" # +# server="ldap://brainwave.brainbox.cc" # +# allowpattern="Guest*" # +# killreason="Access denied" # +# searchscope="subtree" # +# binddn="cn=Manager,dc=brainbox,dc=cc" # +# bindauth="mysecretpass" # +# verbose="yes"> # +# # +# The baserdn indicates the base DN to search in for users. Usually # +# this is 'ou=People,dc=yourdomain,dc=yourtld'. # +# # +# The attribute value indicates the attribute which is used to locate # +# a user account by name. On POSIX systems this is usually 'uid'. # +# # +# The server parameter indicates the LDAP server to connect to. The # +# ldap:// style scheme before the hostname proper is MANDITORY. # +# # +# The allowpattern value allows you to specify a wildcard mask which # +# will always be allowed to connect regardless of if they have an # +# account, for example guest users. # +# # +# Killreason indicates the QUIT reason to give to users if they fail # +# to authenticate. # +# # +# The searchscope value indicates the subtree to search under. On our # +# test system this is 'subtree'. Your mileage may vary. # +# # +# Setting the verbose value causes an oper notice to be sent out for # +# every failed authentication to the server, with an error string. # +# # +# The binddn and bindauth indicate the DN to bind to for searching, # +# and the password for the distinguished name. Some LDAP servers will # +# allow anonymous searching in which case these two values do not # +# need defining, otherwise they should be set similar to the examples # +# above. # + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# LDAP oper configuration module: Adds the ability to authenticate # +# opers via LDAP. This is an extra module which must be enabled # +# explicitly by symlinking it from modules/extra, and requires the # +# OpenLDAP libs. Re-run configure with: ./configure --enable-extras=m_ldapoper.cpp +# and run make install, then uncomment this module to enable it. # +# # +#<module name="m_ldapoper.so"> +# # +# Configuration: # +# # +# <ldapoper baserdn="ou=People,dc=brainbox,dc=cc" +# server="ldap://brainwave.brainbox.cc" +# searchscope="subtree" +# binddn="cn=Manager,dc=brainbox,dc=cc" +# bindauth="mysecretpass"> +# # +# Available configuration items are identical to the same items in # +# m_ldapauth above. # + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# 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 <class> 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. +# +# This module is oper-only. +# +#<module name="m_lockserv.so"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Map hiding module: replaces /MAP and /LINKS output to users with a # +# message to see a website, set by maphide="http://link.to/site" in # +# the security tag, instead. # +#<module name="m_maphide.so"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Msg flood module: Adds message/notice flood protection (+f) +#<module name="m_messageflood.so"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# MsSQL module: Allows other SQL modules to access MS SQL Server +# through a unified API. You must copy the source for this module +# from the directory src/modules/extra, plus the file m_sqlv2.h +# This modules is in extras. Re-run configure with: ./configure --enable-extras=m_mssql.cpp +# and run make install, then uncomment this module to enable it. +# +#<module name="m_mssql.so"> +# +#-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-# +# # +# m_mssql.so is more complex than described here, see wiki for more # +# info http://wiki.inspircd.org/Modules/mssql # +# +#<database name="db" username="user" password="pass" hostname="localhost" id="db1"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# 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 +# This modules is in extras. Re-run configure with: ./configure --enable-extras=m_mysql.cpp +# and run make install, then uncomment this module to enable it. +# +#<module name="m_mysql.so"> +# +#-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-# +# # +# m_mysql.so is more complex than described here, see the wiki for # +# more: http://wiki.inspircd.org/Modules/mysql # +# +#<database name="mydb" username="myuser" password="mypass" hostname="localhost" id="my_database2"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Named Modes module: This module allows for the display and set/unset +# of channel settings and modes via long-form mode names in channels with +# channelmode +Z set. For example, to set a channelban with named modes: +# /mode #channel +Z ban=foo!bar@baz . Currently this doesn't serve much +# purpose outside of making channel administration a bit easier in some +# cases, but eventually modules will start using named modes only because +# we're running out of channelmodes. :D +#<module name="m_namedmodes.so"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# 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. +#<module name="m_namesx.so"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# National characters module: +# 1) Allows using national characters in nicknames. +# 2) Allows using custom (national) casemapping over the network. +# file -- filename of existing file in "locales" directory +# casemapping -- custom value for 005 numeric (if you want it to be +# different from the filename. +# +#<nationalchars file="bynets/russian-w1251-charlink" casemapping="ru_RU.cp1251-charlink"> +#<module name="m_nationalchars.so"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Nickchange flood protection module: Allows up to X nick changes in Y seconds. +# Provides channel mode +F. +#<module name="m_nickflood.so"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Nicklock module: Let opers change a user's nick and then stop that +# user from changing their nick again. +# This module is oper-only. +# To use, NICKLOCK and NICKUNLOCK must be in one of your oper class blocks. +#<module name="m_nicklock.so"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# No ctcp module: Adds the channel mode +C to block CTCPs and extban C +# to block CTCPs sent by specific users. +#<module name="m_noctcp.so"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# No kicks module: Adds the +Q channel mode and the Q: extban to deny +# certain users from kicking. +#<module name="m_nokicks.so"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# No nicks module: Adds the +N channel mode, as well as the +b N: +# extended bantype. +N stops all users from changing their nick, +# the +b N: extban stops anyone from matching a +b N:nick!user@host +# mask from changing their nick. +#<module name="m_nonicks.so"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# No part message module: adds extban 'p' to block part messages from # +# matching users. # +#<module name="m_nopartmsg.so"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# No Notice module: adds the channel mode +T and the extban T to block +# specific users from noticing the channel. +#<module name="m_nonotice.so"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Network buisness join module +# Allows an oper to join a channel using /OJOIN, giving them +Y on the +# channel which makes them immune to kick/deop/etc. +#<module name="m_ojoin.so"> +# +#<ojoin prefix="!" notice="yes" op="yes"> +# Specify the prefix that +Y will grant here +# Leave prefix empty if you do not wish +Y to grant a prefix +# If notice is set to on, upon ojoin, the server will notice +# the channel saying that the oper is joining on network business +# If op is set to on, it will give them +o along with +Y + + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Oper channels mode: Adds the +O channel mode and +beI type O:<mask> +# to ban, exempt, and invex given oper type masks. +# e.g, /mode #channel +iI O:* is equivilant to chmode +O, but you +# may also, e.g. /mode #channel +iI O:AdminTypeOnly to only allow admins. +# +be work in a similar fashion. +# +#<module name="m_operchans.so"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Oper Join module: Auto-joins opers to a channel upon oper-up +# This module is oper-only. For the user equivalent, see m_conn_join. +#<module name="m_operjoin.so"> +# +#-#-#-#-#-#-#-#-#-#-# OPERJOIN CONFIGURATION -#-#-#-#-#-#-#-#-#-#-# +# # +# If you are using the m_operjoin.so module, specify options here: # +# # +# channel - The channel name to join, can also be a comma # +# seperated list eg. "#channel1,#channel2". # +# # +# override - Lets the oper join walking thru any modes that # +# might be set, even bans. Use "yes" or "no". # +# # +#<operjoin channel="#channel" override="no"> +# +# Alternatively you can use the autojoin="channellist" in a <type> # +# tag to set specific autojoins for a type of oper, for example: # +# +#<type name="Helper" autojoin="#help" classes="..."> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Oper log module: Logs all oper commands to the ircd log at default +# loglevel. +# This module is oper-only. +#<module name="m_operlog.so"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Oper prefixing module: Gives IRC operators a prefix status character +# on all channels they are in. +# +#<module name="m_operprefix.so"> +# +# You may additionally customise the prefix character. +#<operprefix prefix="!"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Oper MOTD module: Provides support for seperate message of the day +# on oper-up +# This module is oper-only. +#<module name="m_opermotd.so"> +# +#-#-#-#-#-#-#-#-#-#-# OPERMOTD CONFIGURATION -#-#-#-#-#-#-#-#-#-#-# +# # +# If you are using the m_opermotd.so module, specify the motd here # +# # +# onoper - Should the message be sent on /OPER or only when # +# /OPERMOTD is used. Use "yes" or "no". # +# # +#<opermotd file="oper.motd" onoper="yes"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Override module: Adds support for oper override +# This module is oper-only. +#<module name="m_override.so"> +# +#-#-#-#-#-#-#-#-#-#-# OVERRIDE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-# +# # +# m_override.so is too complex it describe here, see the wiki: # +# http://wiki.inspircd.org/Modules/override # + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# 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 <type> tag +# # This module is oper-only. +#<module name="m_operlevels.so"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Oper modes module: Allows you to specify modes to add/remove on oper +# Specify the modes as the 'modes' parameter of the <type> tag +# and/or as the 'modes' parameter of the <oper> tag. +# This module is oper-only. For the user equivalent, see m_conn_umodes +#<module name="m_opermodes.so"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Oper password hash module: Allows hashed oper passwords +# Relies on the module m_md5.so and/or m_sha256.so being loaded before +# m_password_hash.so in the configuration file. +# This module is oper-only. +#<module name="m_password_hash.so"> +# +#-#-#-#-#-#-#-#-#-#-# OPER HASH CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-# +# +# To use this module, you must define a hash type for each oper's +# password you want to hash. For example: +# +# <oper name="Brain" +# host="ident@dialup15.isp.com" +# hash="sha256" +# password="a41d730937a53b79f788c0ab13e9e1d5" +# type="NetAdmin"> +# +# 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). + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Permanent Channels module: Channels with the permanent channels mode +# will remain open even after everyone else has left the channel, and +# therefore keep things like modes, ban lists and topic. Permanent +# channels -may- need support from your Services package to function +# properly with them. This adds channel mode +P. +# This module is oper-only. +#<module name="m_permchannels.so"> +# +# If you like, m_permchannels can write a config file of permanent channels +# whenever +P is set, unset, or the topic/modes on a +P channel is changed. +# If you want to do this, set the filename below, and uncomment the include. +# +#<permchanneldb filename="conf/permchannels.conf"> +#<include file="permchannels.conf"> +# +# You may also create channels on startup by using the <permchannels> block. +#<permchannels channel="#opers" modes="is" topic="Opers only."> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# 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 +# This modules is in extras. Re-run configure with: ./configure --enable-extras=m_pgsql.cpp +# and run make install, then uncomment this module to enable it. +# +#<module name="m_pgsql.so"> +# +#-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-# +# # +# m_pgsql.so is more complex than described here, see the wiki for # +# more: http://wiki.inspircd.org/Modules/pgsql # +# +#<database name="mydb" username="myuser" password="mypass" hostname="localhost" id="my_database" ssl="no"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Muteban: Implements extended ban m:, which stops anyone matching +# a mask like +b m:nick!user@host from speaking on channel. +#<module name="m_muteban.so"> +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Random Quote module: provides a random quote on connect. +# NOTE: Some of these may mimic fatal errors and confuse users and +# opers alike! - BEWARE! +#<module name="m_randquote.so"> +# +#-#-#-#-#-#-#-#-#-#- RANDOMQUOTES CONFIGURATION -#-#-#-#-#-#-#-#-#-#-# +# # +# Optional - If you specify to use the m_randquote.so module, then # +# specify below the path to the randquotes.conf file. # +# # +#<randquote file="randquotes.conf"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Redirect module: Adds channel redirection (mode +L) +#<module name="m_redirect.so"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Regular Expression Provider for Glob or wildcard (?/*) matching. +# You must have at least 1 provider loaded to use m_filter or m_rline +# modules. This module has no additional requirements, as it uses the +# matching already present in InspIRCd core. +#<module name="m_regex_glob.so"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Regular Expression Provider for PCRE (Perl-Compatible Regular +# Expressions). You need libpcre installed to compile and load this +# module. You must have at least 1 provider loaded to use m_filter or +# m_rline. +#<module name="m_regex_pcre.so"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Regular Expression Provider for POSIX Regular Expressions. +# You shouldn't need any additional libraries on a POSIX-compatible +# system (ie: any Linux, BSD, but not Windows). You must have at least +# 1 provider loaded to use m_filter or m_rline. +# On POSIX-compliant systems, regex syntax can be found by using the +# command: 'man 7 regex'. +#<module name="m_regex_posix.so"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Regular Expression Provider for TRE Regular Expressions. +# This is the same regular expression engine used by UnrealIRCd, so +# if you are most familiar with the syntax of /spamfilter from there, +# this is the provider you want. You need libtre installed in order +# to compile and load this module. +#<module name="m_regex_tre.so"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Registered users only channel creation +# Allows only registered users and opers to create new channels. +# +# You probably *DO NOT* want to load this module on a public network. +# +#<module name="m_regonlycreate.so"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Remove module: Adds the /REMOVE command which is a peaceful +# alternative to /KICK +#<module name="m_remove.so"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Restricted channels module: Allows only opers to create channels. +# +# You probably *DO NOT* want to load this module on a public network. +# +#<module name="m_restrictchans.so"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Restrict message module: Allows users to only message opers. +# +# You probably *DO NOT* want to load this module on a public network. +# +#<module name="m_restrictmsg.so"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Ban users through regular expression patterns +#<module name="m_rline.so"> +# +#-#-#-#-#-#-#-#-#-#-#-#- RLINE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-# +# +# If you wish to re-check a user when they change nickname (can be +# useful under some situations, but *can* also use CPU with more users +# on a server) then set the following configuration value: +# Also, this is where you set what Regular Expression engine is to be +# used. If you ever change it while running, all of your R-Lines will be +# wiped. This is the regex engine used by all R-Lines set, and +# m_regex_<engine>.so must be loaded, or rline will be nonfunctional +# until you load it or change the engine to one that is loaded. +# +#<rline matchonnickchange="yes" engine="pcre"> +# +# Generally, you will NOT want to use 'glob' here, as this turns +# rline into just another gline. The exceptions are that rline will +# always use the full nick!user@host realname string, rather than only +# user@host, but beware that only the ? and * wildcards are available, +# and are the only way to specify where the space can occur if you do +# use glob. For this reason, is recommended to use a real regex engine +# so that at least \s or [[:space:]] is available. + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# JSON-RPC module: Encode and decode JSON-RPC requests for modules +#<module name="m_rpc_json.so"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# RPC test module: A test of the RPC API +#<module name="m_rpctest.so"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# SAJOIN module: Adds the /SAJOIN command +# This module is oper-only. +# To use, SAJOIN must be in one of your oper class blocks. +#<module name="m_sajoin.so"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# SAKICK module: Adds the /SAKICK command +# This module is oper-only. +# To use, SAKICK must be in one of your oper class blocks. +#<module name="m_sakick.so"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# SAMODE module: Adds the oper /SAMODE command +# This module is oper-only. +# To use, SAMODE must be in one of your oper class blocks. +#<module name="m_samode.so"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# SANICK module: Allows opers to change user's nicks +# This module is oper-only. +# To use, SANICK must be in one of your oper class blocks. +#<module name="m_sanick.so"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# SAPART module: Adds the oper /SAPART command +# This module is oper-only. +# To use, SAPART must be in one of your oper class blocks. +#<module name="m_sapart.so"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# SAQUIT module: Adds the oper /SAQUIT command (abusable!!!) +# This module is oper-only. +# To use, SAQUIT must be in one of your oper class blocks. +#<module name="m_saquit.so"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# SATOPIC module: Adds the oper /SATOPIC command +# This module is oper-only. +# To use, SATOPIC must be in one of your oper class blocks. +#<module name="m_satopic.so"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# SASL authentication module: Provides support for IRC Authentication +# Layer (aka: atheme SASL) via AUTHENTICATE. +#<module name="m_sasl.so"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Secure list module: Prevent /LIST in the first minute of connection, +# crippling most spambots and trojan spreader bots. +#<module name="m_securelist.so"> +# +#-#-#-#-#-#-#-#-#-# 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: # +<securehost exception="*@*.searchirc.org"> +<securehost exception="*@*.netsplit.de"> +<securehost exception="*@echo940.server4you.de"> +<securehost exception="*@*.ircdriven.com"> +# # +# Define the following variable to change how long a user must wait # +# before issuing a LIST. If not defined, defaults to 60 seconds. # +# # +#<securelist waittime="60"> # + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Servprotect module: Provides support for Austhex style +k / +# UnrealIRCD +S services mode +#<module name="m_servprotect.so"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# See nicks module: Allow for SNOMASK +N which shows nick changes. +# This module is oper-only. +#<module name="m_seenicks.so"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Set Idle module: Adds a command for opers to change their +# idle time (mainly a toy) +# This module is oper-only. +# To use, SETIDLE must be in one of your oper class blocks. +#<module name="m_setidle.so"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# 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. +# +# At the same time, this offers +r for users and channels to mark them +# as identified seperately from the idea of a master account, which +# can be useful for services which are heavily nick-as-account centric. +# +# This replaces m_services from 1.1 and earlier. +# +# Also of note is that this module implements two extbans: +# +b R: (stop matching account names from joining) +# +b M: (stop matching account names from speaking) +# +#<module name="m_services_account.so"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Sethost module: Adds the /SETHOST command +# This module is oper-only. +# To use, SETHOST must be in one of your oper class blocks. +# See m_chghost for how to customise valid chars for hostnames +#<module name="m_sethost.so"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Setident module: Adds the /SETIDENT command +# This module is oper-only. +# To use, SETIDENT must be in one of your oper class blocks. +#<module name="m_setident.so"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# SETNAME module: Adds the /SETNAME command +# This module is oper-only. +# To use, SETNAME must be in one of your oper class blocks. +#<module name="m_setname.so"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Serverban: Implements extended ban s:, which stops anyone connected +# to a server matching a mask like +b s:server.mask.here from joining. +#<module name="m_serverban.so"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Show Whois module: Adds the +W usermode which allows opers +# to see when they are whois'ed (can be annoying). +# This module is oper-only. +#<module name="m_showwhois.so"> +# +# If you wish, you may also let users set this mode. Only opers with the +# users/auspex priv will see real hosts of people, though. This setting +# is not reloadable via /rehash, and will require /reloadmodule, as +# it directly affects the mode object itself. +#<showwhois opersonly="yes" +# +# You may also set whether or not users should recieve whois notices, should +# they be /whois'd by an oper. +# showfromopers="yes"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Shun module: Provides the /shun command, which stops a user executing +# most commands. +# This module is oper-only. +# To use, SHUN must be in one of your oper class blocks. +#<module name="m_shun.so"> +# +# You may also configure which commands you wish a user to be able to +# perform. It should be noted that if a shunned user issues QUIT or PART +# then their message will be removed, as if they did not issue one. +# +# You can (optionally) let the user know that their command was blocked. +# +# You may also let SHUN affect opers (defaults to no). +#<shun enabledcommands="PING PONG QUIT PART JOIN" notifyuser="yes" affectopers="no"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Spy module: Provides the ability to see the complete names list of +# channels an oper is not a member of +# This module is oper-only. +#<module name="m_spy.so"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# SSL channel mode module: Adds support for SSL-only channels (+z). +# does not do anything useful without a working SSL module (see below) +#<module name="m_sslmodes.so"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# GnuTLS ssl module: Adds support for client-server SSL using GnuTLS, +# 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. +#<module name="m_ssl_gnutls.so"> +# +#-#-#-#-#-#-#-#-#-#-#- GNUTLS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-# +# # +# m_ssl_gnutls.so is too complex it describe here, see the wiki: # +# http://wiki.inspircd.org/Modules/ssl_gnutls # +# # +# 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 +# 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. This module also adds the +# "* <user> is using a secure connection" whois line, the ability for +# opers to use SSL fingerprints to verify their identity and the ability +# to force opers to use SSL connections in order to oper up. +# It is highly recommended to load this module especially if +# you use SSL on your network. +# For how to use the oper features, please see the first example <oper> tag +# in opers.conf.example. +# +#<module name="m_sslinfo.so"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# 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. +#<module name="m_ssl_openssl.so"> +# +#-#-#-#-#-#-#-#-#-#-#- OPENSSL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-# +# # +# m_ssl_openssl.so is too complex it describe here, see the wiki: # +# http://wiki.inspircd.org/Modules/ssl_openssl # +# # +# 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! # + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Strip colour module: Adds the channel mode +S +#<module name="m_stripcolor.so"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# SILENCE module: Adds support for /SILENCE +#<module name="m_silence.so"> +# +# Configuration tags: +# +#<silence maxentries="32"> +# +# Sets the maximum number of entries on a users silence list. + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# 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 # +# This modules is in extras. Re-run configure with: ./configure --enable-extras=m_aqlite.cpp +# and run make install, then uncomment this module to enable it. # +# +#<module name="m_sqlite3.so"> +# +#-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-# +# # +# m_sqlite.so is more complex than described here, see the wiki for # +# more: http://wiki.inspircd.org/Modules/sqlite3 # +# +#<database hostname="/full/path/to/database.db" id="anytext"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# 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 +# This modules is in extras. Re-run configure with: ./configure --enable-extras=m_sqlutils.cpp +# and run make install, then uncomment this module to enable it. +# +#<module name="m_sqlutils.so"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# 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. +# This modules is in extras. Re-run configure with: ./configure --enable-extras=m_sqlauth.cpp +# and run make install, then uncomment this module to enable it. +# +#<module name="m_sqlauth.so"> +# +#-#-#-#-#-#-#-#-#-#-#- SQLAUTH CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-# +# # +# m_sqlauth.so is too complex it describe here, see the wiki: # +# http://wiki.inspircd.org/Modules/sqlauth # + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# SQL logging module: Allows you to log network-wide data for your +# network in a fully normalised set of SQL tables. You must copy the +# source for this module from the directory src/modules/extra +# This modules is in extras. Re-run configure with: ./configure --enable-extras=m_sqllog.cpp +# and run make install, then uncomment this module to enable it. +# +#<module name="m_sqllog.so"> +# +#-#-#-#-#-#-#-#-#-#-#- SQLLOG CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-# +# # +# dbid - Database ID to use (see m_sql) # +# # +# See also: http://wiki.inspircd.org/Modules/sqllog # +# # +#<sqllog dbid="1"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# 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. +# This modules is in extras. Re-run configure with: ./configure --enable-extras=m_sqloper.cpp +# and run make install, then uncomment this module to enable it. +# +#<module name="m_sqloper.so"> +# +#-#-#-#-#-#-#-#-#-#-#- SQLOPER CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-# +# # +# dbid - Database ID to use (see m_sql) # +# hash - Hashing provider to use for password hashing # +# # +# See also: http://wiki.inspircd.org/Modules/sqloper # +# # +#<sqloper dbid="1" hash="md5"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# SVSHold module: Implements SVSHOLD. Like Q:Lines, but can only be # +# added/removed by Services. # +#<module name="m_svshold.so"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# SWHOIS module: Allows you to add arbitary lines to user WHOIS. +# This module is oper-only. +# To use, SWHOIS must be in one of your oper class blocks. +#<module name="m_swhois.so"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Test module: enable this to create a command useful in testing +# flood control. To avoid accidental use on live networks, the server +# name must contain ".test" to load the module +#<module name="m_testnet.so"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Timed bans module: Adds timed channel bans and the /TBAN command +#<module name="m_timedbans.so"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Test line module: Adds the /TLINE command, used to test how many +# users a /GLINE or /ZLINE etc would match. +# This module is oper-only. +# To use, TLINE must be in one of your oper class blocks. +#<module name="m_tline.so"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# UHNAMES support module: Adds support for the IRCX style UHNAMES +# extension, which displays ident and hostname in the names list for +# each user, saving clients from doing a WHO on the channel. Note that +# this module is not widely supported yet. If a client does not support +# UHNAMES it will not enable it, this will not break incompatible +# clients. +#<module name="m_uhnames.so"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Uninvite module: Adds the /UNINVITE command which lets users remove +# pending invites from channels without waiting for the user to join. +#<module name="m_uninvite.so"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Userip module: Adds the /USERIP command +# This module is oper-only. +# To use, USERIP must be in one of your oper class blocks. +#<module name="m_userip.so"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Vhost module: Adds the VHOST command which allows for adding virtual +# hosts which are accessible using a username and password in the config. +#<module name="m_vhost.so"> +# +#-#-#-#-#-#-#-#-#-#-#- VHOST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-# +# # +# user - Username for the vhost. # +# # +# pass - Password for the vhost. # +# # +# hash - The hash for the specific user (optional) +# m_password_hash.so and a hashing module must be loaded for this to work +# # +# host - Vhost to set. # +# +#<vhost user="some_username" pass="some_password" host="some.host"> +#<vhost user="foo" password="fcde2b2edba56bf408601fb721fe9b5c338d10ee429ea04fae5511b68fbf8fb9" hash="sha256" host="some.other.host"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Watch module: Adds the WATCH command, which is used by clients to +# maintain notify lists. +#<module name="m_watch.so"> +# +# Configuration tags: +# +#<watch maxentries="32"> +# +# Sets the maximum number of entries on a user's watch list. + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# XLine database: Stores all *Lines (G/Z/K/R/any added by other modules) +# in a file "xline.db" which can be re-loaded on restart. This is useful +# for two reasons: it keeps bans so users may not evade them, and on +# bigger networks, server connections will take less time as there will +# be a lot less bans to apply - as most of them will already be there. +#<module name="m_xline_db.so"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# ZipLinks module: Adds support for zlib deflate on server to server +# connections. Both ends of the connection must load this module. +# This modules is in extras. Re-run configure with: ./configure --enable-extras=m_ziplink.cpp +# and run make install, then uncomment this module to enable it. +# +#<module name="m_ziplink.so"> +# +# To use this module, you must enable it as a ssl type in your +# <link> tags or <bind> tags using the ssl name 'ziplinks'. +# See the documentation of <link> and <bind>, respectively. +# + + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# ____ _ _____ _ _ ____ _ _ _ # +# | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | # +# | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | # +# | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| # +# |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) # +# # +# To link servers to InspIRCd, you MUST load the m_spanningtree # +# module. Since several features (like SSL server links) rely on # +# other modules being loaded before m_spanningtree, the module itself # +# is at the bottom of this file. DO NOT forget to load it. If you DO # +# NOT do this, server links will NOT work at all. ie. The ports will # +# NOT bind, and /connect will not work properly. This is by design, # +# to allow for the implementation of other linking protocols in # +# modules in the future. # +# # + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Spanning Tree module - allows linking of servers using the spanning +# tree protocol (see the READ THIS BIT section above). +# You will almost always want to load this. +# +#<module name="m_spanningtree.so"> + + |