X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=conf%2Fmodules.conf.example;h=262233ee3565dad11fe95610351140a6846db796;hb=d7e00b3269bde268819bf221279cb15b4ba5dc99;hp=241d22f865f2d24b45ab642cd352279c1757b9e5;hpb=e68b35af5d27520838f3260557938d782f4158b9;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/conf/modules.conf.example b/conf/modules.conf.example index 241d22f86..262233ee3 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. # # @@ -664,6 +713,8 @@ #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # 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. # # #-#-#-#-#-#-#-#-#-#-#-# GEOIP CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-# @@ -709,8 +760,12 @@ #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # HIDECHANS module: Allows opers to hide their channels list from non- # opers by setting user mode +I on themselves. -# This module is oper-only. # +# +# 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. +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # HIDEOPER module: Allows opers to hide their oper status from non- @@ -779,11 +834,6 @@ # http stats module: Provides basic stats pages over HTTP # Requires m_httpd.so to be loaded for it to function. # -# -#-#-#-#-#-#-#-#-#-#-#-#- HTTPD STATS CONFIGURATION -#-#-#-#-#-#-#-#-#-# -# -# -# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Ident: Provides RFC 1413 ident lookup support @@ -800,7 +850,7 @@ # the user in a 'connecting' state until the lookup is complete. # # The bind value indicates which IP to bind outbound requests to. # # # -# +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Invite except module: Adds support for channel invite exceptions (+I) @@ -841,6 +891,8 @@ # 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. # # # # # # # @@ -884,6 +936,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. # +# # +# +# # +# Configuration: # +# # +# +# # +# 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. # @@ -897,6 +969,12 @@ # # +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# 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. # +# + #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Msg flood module: Adds message/notice flood protection (+f) # @@ -905,6 +983,9 @@ # 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. +# # # #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-# @@ -918,6 +999,9 @@ # 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. +# # # #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-# @@ -933,6 +1017,17 @@ # This is supported by mIRC, x-chat, klient, and maybe more. # +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# 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. +# +# +# + #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Nickchange flood protection module: Allows up to X nick changes in Y seconds. # Provides channel mode +F. @@ -960,6 +1055,11 @@ # mask from changing their nick. # +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# No part message module: adds extban 'p' to block part messages from # +# matching users. # +# + #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # No Notice module: adds the channel mode +T # @@ -969,11 +1069,6 @@ # This module is oper-only. # -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Oper flood module: Removes flood limits from users upon opering up -# This module is oper-only. -# - #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Oper invex/extban module: Adds +beI type O, to ban, exempt, and invex # given oper type masks. @@ -1012,6 +1107,15 @@ # This module is oper-only. # +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Oper prefixing module: Gives IRC operators a prefix status character +# on all channels they are in. +# +# +# +# You may additionally customise the prefix character. +# + #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Oper MOTD module: Provides support for seperate message of the day # on oper-up @@ -1022,7 +1126,10 @@ # # # 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". # +# # +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Override module: Adds support for oper override @@ -1087,6 +1194,9 @@ # 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. +# # # #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-# @@ -1160,12 +1270,6 @@ # alternative to /KICK # -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Restrict banned users module: -# Disallows banned users on a channel from messaging the channel, -# changing nick, or changing the topic, if loaded. -# - #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Restricted channels module: Allows only opers to create channels # @@ -1258,6 +1362,12 @@ # To use, SAQUIT must be in one of your oper class blocks. # +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# SATOPIC module: Adds the oper /SATOPIC command +# This module is oper-only. +# To use, SATOPIC must be in one of your oper class blocks. +# + #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # SASL authentication module: Provides support for IRC Authentication # Layer (aka: atheme SASL) via AUTHENTICATE. @@ -1299,30 +1409,21 @@ # To use, SETIDLE must be in one of your oper class blocks. # -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# 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. *** -# - #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # 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!! # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# @@ -1354,6 +1455,16 @@ # to see when they are whois'ed (can be annoying). # This module is oper-only. # +# +# 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. +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Shun module: Provides the /shun command, which stops a user executing @@ -1366,8 +1477,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. -# +# You can (optionally) let the user know that their command was blocked. +# +# You may also let SHUN affect opers (defaults to no). +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Spy module: Provides the ability to see the complete names list of @@ -1409,6 +1522,9 @@ # scripts to validate users. For this to work, one of m_ssl_gnutls.so # or m_ssl_openssl.so must be loaded. You must symlink the source for # this module from the directory src/modules/extra. +# This modules is in extras. Re-run configure with: ./configure --enable-extras=m_sslinfo.cpp +# and run make install, then uncomment this module to enable it. +# # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# @@ -1456,6 +1572,9 @@ # 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. # +# # # #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-# @@ -1471,6 +1590,9 @@ # 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. +# # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# @@ -1478,6 +1600,9 @@ # 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. +# # # #-#-#-#-#-#-#-#-#-#-#- SQLAUTH CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-# @@ -1489,6 +1614,9 @@ # 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. +# # # #-#-#-#-#-#-#-#-#-#-#- SQLLOG CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-# @@ -1503,6 +1631,9 @@ # 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. +# # # #-#-#-#-#-#-#-#-#-#-#- SQLOPER CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-# @@ -1606,6 +1737,8 @@ #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # 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. # # # @@ -1613,3 +1746,30 @@ # tags or tags using the transport name 'zip'. # See the documentation of and , 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. +# +# + +