X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=conf%2Fmodules.conf.example;h=21185cc57965e04c0c92a27d9a6be68067bf16e7;hb=c7e2895cbdbbeaf3b8789ef694315577be1a8df3;hp=4a7e05096d391dbf58d6f021443c54696795b4e6;hpb=0f41486ecf373cdba78fe170faf48161e92a9b1b;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/conf/modules.conf.example b/conf/modules.conf.example index 4a7e05096..21185cc57 100644 --- a/conf/modules.conf.example +++ b/conf/modules.conf.example @@ -24,18 +24,14 @@ # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) # # # # To link servers to InspIRCd, you MUST load the m_spanningtree # -# module, as shown below. 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. 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 @@ -75,6 +71,17 @@ # Alias module: Allows you to define server-side command aliases # # +# Fantasy settings: +# +# +# +# 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 # @@ -90,6 +97,14 @@ # 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 # @@ -156,6 +171,18 @@ # # +# +# 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. +# +# +# +# This would be used as "!cs ", 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 @@ -319,7 +346,7 @@ # # Get IP from ident # # See the docs # New style: -# # Get IP from WEBIRC # # IMPORTANT NOTE: @@ -367,6 +394,28 @@ # Chanprotect module: gives +q and +a channel modes # + + + #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Check module: gives /check # Check is useful for looking up information on channels, @@ -512,7 +561,7 @@ # over whole ISPs/blocks of IPs, which may be needed to prevent attacks. # # -# This allows for 10 quits in an hour with a 10 minute ban if that is exceeded. +# This allows for 10 connections in an hour with a 10 minute ban if that is exceeded. # # @@ -545,12 +594,15 @@ #-#-#-#-#-#-#-#-#-#- 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="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 @@ -645,6 +697,9 @@ # # # 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 # @@ -785,11 +840,6 @@ # 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"> -# -#-#-#-#-#-#-#-#-#-#-#-#- HTTPD STATS CONFIGURATION -#-#-#-#-#-#-#-#-#-# -# -#<httpstats stylesheet="http://remote.style/sheet.css"> -# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Ident: Provides RFC 1413 ident lookup support @@ -806,7 +856,7 @@ # 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" bind=""> +#<ident timeout="5"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Invite except module: Adds support for channel invite exceptions (+I) @@ -817,9 +867,6 @@ # 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. -# -# IMPORTANT NOTE: To allow this mode to be used by a type of oper, you -# must first add the value canquiet="yes" to that oper's type tag. # # This module is oper-only. # @@ -892,6 +939,26 @@ # 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. # @@ -905,6 +972,12 @@ # #<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"> @@ -947,6 +1020,17 @@ # 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. @@ -960,11 +1044,13 @@ #<module name="m_nicklock.so"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# No ctcp module: Adds the channel mode +C to block CTCPs +# 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 +# No kicks module: Adds the +Q channel mode and the Q: extban to deny +# certain users from kicking. #<module name="m_nokicks.so"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# @@ -975,7 +1061,13 @@ #<module name="m_nonicks.so"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# No Notice module: adds the channel mode +T +# 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"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# @@ -983,11 +1075,6 @@ # This module is oper-only. #<module name="m_operchans.so"> -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Oper flood module: Removes flood limits from users upon opering up -# This module is oper-only. -#<module name="m_operflood.so"> - #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Oper invex/extban module: Adds +beI type O, to ban, exempt, and invex # given oper type masks. @@ -1026,6 +1113,15 @@ # 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 @@ -1036,7 +1132,10 @@ # # # If you are using the m_opermotd.so module, specify the motd here # # # -#<opermotd file="oper.motd"> +# 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 @@ -1177,12 +1276,6 @@ # alternative to /KICK #<module name="m_remove.so"> -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Restrict banned users module: -# Disallows banned users on a channel from messaging the channel, -# changing nick, or changing the topic, if loaded. -#<module name="m_restrictbanned.so"> - #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Restricted channels module: Allows only opers to create channels #<module name="m_restrictchans.so"> @@ -1251,6 +1344,12 @@ # 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. @@ -1275,6 +1374,12 @@ # 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. @@ -1316,30 +1421,21 @@ # 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 user mode +r, which -# is similar to the DALnet and dreamforge systems. -# -# N O T E!! -# >> This CAN NOT be used at the same time as m_services_account << -# N O T E!! -# *** This module DOES NOT support Atheme services, please use *** -# *** m_services_account if you are planning on using Atheme. *** -#<module name="m_services.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) # -# N O T E!! -# >> This CAN NOT be used at the same time as m_services << -# N O T E!! #<module name="m_services_account.so"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# @@ -1393,8 +1489,10 @@ # 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 may also (optionally) let the user know that their command was blocked. -#<shun enabledcommands="PING PONG QUIT PART JOIN" notifyuser="yes"> +# 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 @@ -1624,10 +1722,14 @@ # 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 @@ -1660,3 +1762,30 @@ # <link> tags or <bind> tags using the transport name 'zip'. # 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"> + +