X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=conf%2Fmodules.conf.example;h=784a39a2a840af2c4c3487239466751a56f71155;hb=7c8a2de390271eb39248e12c925238725504f74d;hp=0f70aa695fc0d2aabe55e8fa0d864acecc86ec5f;hpb=a6d924bf70d389583b8706e9774f056dd6af9fc3;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/conf/modules.conf.example b/conf/modules.conf.example index 0f70aa695..784a39a2a 100644 --- a/conf/modules.conf.example +++ b/conf/modules.conf.example @@ -10,7 +10,7 @@ # # # By default, ALL modules are commented out. You must uncomment them # # or add lines to your config to load modules. Please refer to # -# http://www.inspircd.org/wiki/Modules_List for a list of modules and# +# 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 tag to load all modules which # @@ -73,11 +73,14 @@ # # 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 -#-#-#-#-#-#-#-#-#-#-#-#-#-# # # @@ -148,9 +151,15 @@ # # # +# +# +# # # # +# +# +# # # An example of using the format value to create an alias with two # different behaviours depending on the format of the parameters. @@ -175,7 +184,7 @@ # command must be preceded by the fantasy prefix when used. # # +# replace="PRIVMSG ChanServ :$1 $chan $2-" requires="ChanServ" uline="yes"> # # This would be used as "!cs ", with the channel # being automatically inserted after the command in the message to @@ -315,7 +324,7 @@ # # # Optional - If you specify to use the m_censor module, then you must # # specify some censor tags. See also: # -# http://www.inspircd.org/wiki/Censor_Module # +# http://wiki.inspircd.org/Modules/censor # # # @@ -329,7 +338,7 @@ # 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://www.inspircd.org/wiki/CGI-IRC_Module +# For more information see: http://wiki.inspircd.org/Modules/cgiirc # # Set to yes if you want to notice opers when CGI clients connect # @@ -343,7 +352,7 @@ # # Get IP from ident # # See the docs # New style: -# # Get IP from WEBIRC # # IMPORTANT NOTE: @@ -371,6 +380,10 @@ # Channel filter module: Allows channel-op defined message # filtering using simple string matches (channel mode +g) # +# +# If hidemask is set to yes, the user will not be shown the mask when +# his/her message is blocked. +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Channel logging module: used to send snotice output to channels, to @@ -392,8 +405,8 @@ # # #-#-#-#-#-#-#-#-# /CHGHOST - /SETHOST CONFIGURATION #-#-#-#-#-#-#-#-# @@ -591,12 +607,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 @@ -669,7 +688,7 @@ #<module name="m_dnsbl.so"> # # # # For configuration options please see the wiki page for m_dnsbl at # -# http://inspircd.org/wiki/DNS_Blacklist_Module # +# http://wiki.inspircd.org/Modules/dnsbl # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Filter module: Provides message filtering, similar to SPAMFILTER. @@ -691,6 +710,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 # @@ -699,10 +721,6 @@ # # #<include file="filter.conf"> -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Foobar module: does nothing - historical relic -#<module name="m_foobar.so"> - #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Gecosban: Implements extended ban r:, which stops anyone matching # a mask like +b r:*realname?here* from joining a channel. @@ -712,6 +730,9 @@ # 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 #-#-#-#-#-#-#-#-#-#-#-#-# @@ -777,7 +798,7 @@ #-#-#-#-#-#-#-#-#-#-#- HOSTCHANGE CONFIGURATION -#-#-#-#-#-#-#-#-#-# # # # Optional - If you choose to use the m_hostchange.so module. # -# Config Help - See http://www.inspircd.org/wiki/Host_Changer_Module # +# Config Help - See http://wiki.inspircd.org/Modules/hostchange # # # #<host suffix="polarbears.org" separator="." prefix=""> #<hostchange mask="*@fbi.gov" action="addnick"> @@ -858,11 +879,8 @@ # 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. +# This module is oper-only and seen by many to be quite abusive. # #<module name="m_invisible.so"> @@ -988,7 +1006,7 @@ #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-# # # # m_mssql.so is more complex than described here, see wiki for more # -# info http://www.inspircd.org/wiki/SQLServer_Service_Provider_Module # +# info http://wiki.inspircd.org/Modules/mssql # # #<database name="db" username="user" password="pass" hostname="localhost" id="db1"> @@ -1004,7 +1022,7 @@ #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-# # # # m_mysql.so is more complex than described here, see the wiki for # -# more: http://www.inspircd.org/wiki/SQL_Service_Provider_Module # +# more: http://wiki.inspircd.org/Modules/mysql # # #<database name="mydb" username="myuser" password="mypass" hostname="localhost" id="my_database2"> @@ -1038,11 +1056,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"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# @@ -1058,9 +1078,24 @@ #<module name="m_nopartmsg.so"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# No Notice module: adds the channel mode +T +# 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 # This module is oper-only. @@ -1136,7 +1171,7 @@ #-#-#-#-#-#-#-#-#-#-# OVERRIDE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-# # # # m_override.so is too complex it describe here, see the wiki: # -# http://www.inspircd.org/wiki/Oper_Override_Module # +# http://wiki.inspircd.org/Modules/override # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Oper levels module: Gives each oper a level and prevents @@ -1184,6 +1219,15 @@ # 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. +# +# The conf file generated has a path relative to the inspircd binary, hence '../conf/'. +# +#<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."> @@ -1199,7 +1243,7 @@ #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-# # # # m_pgsql.so is more complex than described here, see the wiki for # -# more: http://www.inspircd.org/wiki/SQL_Service_Provider_Module # +# more: http://wiki.inspircd.org/Modules/pgsql # # #<database name="mydb" username="myuser" password="mypass" hostname="localhost" id="my_database" ssl="no"> @@ -1260,6 +1304,9 @@ #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # 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"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# @@ -1268,11 +1315,17 @@ #<module name="m_remove.so"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Restricted channels module: Allows only opers to create channels +# 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 +# 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"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# @@ -1335,6 +1388,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. @@ -1474,8 +1533,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 @@ -1488,13 +1549,6 @@ # does not do anything useful without a working SSL module (see below) #<module name="m_sslmodes.so"> -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Dummy ssl module: If you have other servers on your network which -# have SSL, but your server does not have ssl enabled, you should load -# this module, which will handle SSL metadata (e.g. the "Is using ssl" -# field in the WHOIS information). -#<module name="m_ssl_dummy.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 @@ -1505,7 +1559,7 @@ #-#-#-#-#-#-#-#-#-#-#- GNUTLS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-# # # # m_ssl_gnutls.so is too complex it describe here, see the wiki: # -# http://www.inspircd.org/wiki/GnuTLS_SSL_Module # +# 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 # @@ -1515,10 +1569,14 @@ # SSL Info module: Allows users to retrieve information about other # user's peer SSL certificates and keys. This can be used by client # scripts to validate users. For this to work, one of m_ssl_gnutls.so -# or m_ssl_openssl.so must be loaded. You must symlink the source for -# this module from the directory src/modules/extra. -# 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. +# 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"> @@ -1532,22 +1590,12 @@ #-#-#-#-#-#-#-#-#-#-#- OPENSSL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-# # # # m_ssl_openssl.so is too complex it describe here, see the wiki: # -# http://www.inspircd.org/wiki/OpenSSL_SSL_Module # +# 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! # -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# SSL Cert Oper module: Allows opers to oper up using the key fingerprint -# stored within their SSL certificate and key pair. -# When using this module, one of m_ssl_gnutls.so or m_ssl_openssl.so must -# be loaded. An extra value should be added to enabled opers, which -# is in the following format: fingerprint="<hash>". For more information, -# see the example in the oper blocks. -# This module is oper-only. -#<module name="m_ssl_oper_cert.so"> - #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Strip colour module: Adds the channel mode +S #<module name="m_stripcolor.so"> @@ -1575,7 +1623,7 @@ #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-# # # # m_sqlite.so is more complex than described here, see the wiki for # -# more: http://www.inspircd.org/wiki/SQLite3_Service_Provider_Module # +# more: http://wiki.inspircd.org/Modules/sqlite3 # # #<database hostname="/full/path/to/database.db" id="anytext"> @@ -1603,7 +1651,7 @@ #-#-#-#-#-#-#-#-#-#-#- SQLAUTH CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-# # # # m_sqlauth.so is too complex it describe here, see the wiki: # -# http://www.inspircd.org/wiki/SQL_Authentication_Module # +# http://wiki.inspircd.org/Modules/sqlauth # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # SQL logging module: Allows you to log network-wide data for your @@ -1618,7 +1666,7 @@ # # # dbid - Database ID to use (see m_sql) # # # -# See also: http://www.inspircd.org/wiki/SQL_Logging_Module # +# See also: http://wiki.inspircd.org/Modules/sqllog # # # #<sqllog dbid="1"> @@ -1636,7 +1684,7 @@ # dbid - Database ID to use (see m_sql) # # hash - Hashing provider to use for password hashing # # # -# See also: http://www.inspircd.org/wiki/SQL_Oper_Storage_Module # +# See also: http://wiki.inspircd.org/Modules/sqloper # # # #<sqloper dbid="1" hash="md5"> @@ -1652,20 +1700,7 @@ #<module name="m_swhois.so"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Taxonomy module: Adds the /TAXONOMY command, used to view all -# metadata attached to a user. -# This module is oper-only. -# To use, TAXONOMY must be in one of your oper class blocks. -#<module name="m_taxonomy.so"> - -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Test command module: Does nothing significant. Read: pointless. -#<module name="m_testcommand.so"> - -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Timed bans module: Adds timed bans and the /TBAN command -# This module is oper-only. -# To use, TBAN must be in one of your oper class blocks. +# Timed bans module: Adds timed channel bans and the /TBAN command #<module name="m_timedbans.so"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# @@ -1705,10 +1740,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