X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=docs%2Fconf%2Fmodules.conf.example;h=67813904922a5770e2adf585d7c2e8de9803a1c9;hb=9982ec4e5b027ed24b1fda5e6fd3ab35b98de1a7;hp=fe189e7c45a08a5e49224811058abc20c06a284e;hpb=14e1d1f844c89e14cac24799c80af47ed6767cf2;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/docs/conf/modules.conf.example b/docs/conf/modules.conf.example index fe189e7c4..678139049 100644 --- a/docs/conf/modules.conf.example +++ b/docs/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 # -# https://wiki.inspircd.org/3.0/Modules for a list of modules and # +# https://docs.inspircd.org/3/modules for a list of modules and # # each modules link for any additional conf tags they require. # # # # ____ _ _____ _ _ ____ _ _ _ # @@ -116,10 +116,14 @@ # to successfully trigger. If they are not, then # # the user receives a 'no such nick' 401 numeric. # # # +# stripcolor - If this is true, the text from the user will be # +# stripped of color and format codes before # +# matching against 'text'. # +# # # uline - Setting this to true will ensure that the user # -# given in 'requires' is also on a u-lined server, # +# given in 'requires' is also 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, # +# user is online, but not on a U-lined server, # # then an oper alert is sent out as this is # # possibly a sign of a user trying to impersonate # # a service. # @@ -282,7 +286,7 @@ # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# CallerID module: Adds usermode +g which activates hybrid-style +# CallerID module: Adds user mode +g which activates hybrid-style # callerid: block all private messages unless you /ACCEPT first. # # @@ -403,12 +407,12 @@ # # # If hidemask is set to yes, the user will not be shown the mask when -# his/her message is blocked. +# their message is blocked. # # If maxlen is set then it defines the maximum length of a filter entry. # # If notifyuser is set to no, the user will not be notified when -# his/her message is blocked. +# their message is blocked. # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# @@ -453,10 +457,12 @@ #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Channelban: Implements extended ban j:, which stops anyone already -# in a channel matching a ban like +b j:#channel*mask from joining. +# in a channel matching a ban like +b j:#channel from joining. +# It is also possible to ban based on their status in that channel, +# like so: +b j:@#channel, this example prevents the ops from joining. # Note that by default wildcard characters * and ? are allowed in -# channel names. To disallow them, load m_channames and add characters -# 42 and 63 to denyrange (see above). +# channel names. To disallow them, load the channames module and +# add characters 42 and 63 to denyrange (see above). # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# @@ -501,7 +507,7 @@ # Connection class ban module: Adds support for extban 'n' which # matches against the class name of the user's connection. # This module assumes that connection classes are named in a uniform -# way on all servers of the network. +# way on all servers of the network. Wildcards are accepted. # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# @@ -510,7 +516,7 @@ # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Cloaking module: Adds usermode +x and cloaking support. +# Cloaking module: Adds user mode +x and cloaking support. # Relies on the md5 module being loaded. # To cloak users when they connect, load the conn_umodes module and set # to include the +x mode. The example tag @@ -548,11 +554,13 @@ # +# prefix="net-" +# ignorecase="no"> # # +# prefix="net-" +# ignorecase="no"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Clones module: Adds an oper command /CLONES for detecting cloned @@ -650,7 +658,7 @@ # bootwait - Amount of time in seconds to wait before enforcing # the throttling when the server just booted. # -# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# @@ -719,7 +727,7 @@ # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Deaf module: Adds support for the usermodes +dD: +# Deaf module: Adds support for user modes +d and +D: # d - deaf to channel messages and notices. # D - deaf to user messages and notices. # The +D user mode is not enabled by default to enable link compatibility @@ -733,8 +741,8 @@ # the starting character of a message. # If 'bypasscharsuline' is empty, then 'bypasschars' will # match for both regular and U-lined users. -# enableprivdeaf - Whether to enable usermode +D (privdeaf). -# privdeafuline - Whether U-lined users bypass usermode +D (privdeaf). +# enableprivdeaf - Whether to enable user mode +D (privdeaf). +# privdeafuline - Whether U-lined users bypass user mode +D (privdeaf). # # @@ -820,15 +828,16 @@ # more blacklists. # # # # -# For configuration options please see the wiki page for dnsbl at # -# https://wiki.inspircd.org/Modules/3.0/dnsbl # +# For configuration options please see the docs page for dnsbl at # +# https://docs.inspircd.org/3/modules/dnsbl # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Exempt channel operators module: Provides support for allowing # # users of a specified channel status to be exempt from some channel # -# restriction modes. Supported restrictions are # -# blockcaps, blockcolor, censor, filter, flood, nickflood, noctcp, # -# nonick, nonotice, regmoderated, stripcolor, and topiclock. # +# restriction modes. Supported restrictions are: # +# anticaps, auditorium-see, auditorium-vis, blockcaps, blockcolor, # +# censor, filter, flood, nickflood, noctcp, nonick, nonotice, # +# regmoderated, stripcolor, and topiclock. # # See in inspircd.conf.example for a more # # detailed list of the restriction modes that can be exempted. # # These are settable using: /MODE #chan +X : # @@ -853,8 +862,14 @@ # at the tag for info on availability. # # # # If notifyuser is set to no, the user will not be notified when # -# his/her message is blocked. # -# +# their message is blocked. # +# # +# If warnonselfmsg is set to yes when a user sends a message to # +# themself that matches a filter the filter will be ignored and a # +# warning will be sent to opers instead. This stops spambots which # +# send their spam message to themselves first to check if it is being # +# filtered by the server. # +# # # # Your choice of regex engine must match on all servers network-wide. # # # @@ -1011,7 +1026,7 @@ # #-#-#-#-#-#-#-#-#-#-#- HOSTCHANGE CONFIGURATION -#-#-#-#-#-#-#-#-#-# # # -# See https://wiki.inspircd.org/Modules/3.0/hostchange for help. # +# See https://docs.inspircd.org/3/modules/hostchange for help. # # # # # @@ -1164,6 +1179,13 @@ # another user into a channel. This respects . # +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# IRCv3 message id module: Provides the msgid IRCv3 extension which +# adds a unique identifier to each message when the message-tags cap +# has been requested. This enables support for modern features such as +# reactions and replies. +# + #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # IRCv3 server-time module. Adds the 'time' tag which adds a timestamp # to all messages received from the server. @@ -1333,6 +1355,12 @@ # Message flood module: Adds message/notice flood protection via # channel mode +f. # +# +# The weight to give each message type. TAGMSGs are considered to be +# 1/5 of a NOTICE or PRIVMSG to avoid users being accidentally flooded +# out of a channel by automatic client features such as typing +# notifications. +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # MLOCK module: Adds support for server-side enforcement of services @@ -1363,8 +1391,8 @@ # #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-# # # -# mysql is more complex than described here, see the wiki for more # -# info: https://wiki.inspircd.org/Modules/3.0/mysql # +# mysql is more complex than described here, see the docs for more # +# info: https://docs.inspircd.org/3/modules/mysql # # # @@ -1445,7 +1473,7 @@ #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Network business 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. +# channel which makes them immune to kicks. # # # Specify the prefix that +Y will grant here. @@ -1499,26 +1527,26 @@ #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Oper prefixing module: Adds a channel prefix mode +y which is given -# to all IRC operators automatically on all channels they are in. +# to all server operators automatically on all channels they are in. # This prefix mode is more powerful than channel op and other regular # prefix modes. # -# Load this module if you want all your IRC operators to have channel -# operator powers. +# Load this module if you want all your server operators to have +# channel operator powers. # # # You may additionally customise the prefix character. # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Oper MOTD module: Provides support for separate message of the day +# Oper MOTD module: Provides support for a separate message of the day # on oper-up. # This module is oper-only. # # #-#-#-#-#-#-#-#-#-#-# OPERMOTD CONFIGURATION -#-#-#-#-#-#-#-#-#-#-# # # -# If you are using the opermotd module, specify the motd here. # +# If you are using the opermotd module, specify the motd file here. # # # # onoper - If on, the message is sent on /OPER, otherwise it's # # only sent when /OPERMOTD is used. # @@ -1534,15 +1562,15 @@ # # # Much of override's configuration relates to your oper blocks. # # For more information on how to allow opers to override, see: # -# https://wiki.inspircd.org/Modules/3.0/override # +# https://docs.inspircd.org/3/modules/override # # # # noisy - If enabled, all oper overrides will be announced # # via channel notice. # # # # requirekey - If enabled, overriding on join requires a channel # -# key of "override" to be specified # +# key of "override" to be specified. # # # -# enableumode - If enabled, usermode +O is required for override. # +# enableumode - If enabled, user mode +O is required for override. # # # # @@ -1636,7 +1664,12 @@ # # If 'listmodes' is true then all list modes (+b, +I, +e, +g...) will be # saved. Defaults to false. -# +# +# 'saveperiod' determines how often to check if the database needs to be +# saved to disk. Defaults to every five seconds. +# # # # You may also create channels on startup by using the block. @@ -1652,8 +1685,8 @@ # #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-# # # -# pgsql is more complex than described here, see the wiki for # -# more: https://wiki.inspircd.org/Modules/3.0/pgsql # +# pgsql is more complex than described here, see the docs for # +# more: https://docs.inspircd.org/3/modules/pgsql # # # @@ -1663,7 +1696,7 @@ # # # If notifyuser is set to no, the user will not be notified when -# his/her message is blocked. +# their message is blocked. # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# @@ -1773,7 +1806,7 @@ # less CPU usage. Increasing this beyond 512 doesn't have # any effect, as the maximum length of a message on IRC # cannot exceed that. -# +# # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# @@ -1807,13 +1840,15 @@ # 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 'matchonnickchange' to yes. +# If you additionally want Z-lines to be added on matches, then +# set 'zlineonmatch' to yes. # 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 # regex_ must be loaded, or rline will be non-functional # until you load it or change the engine to one that is loaded. # -# +# # # Generally, you will NOT want to use 'glob' here, as this turns an # R-line into just another G-line. The exceptions are that R-lines will @@ -1931,7 +1966,7 @@ # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Services support module: Adds several usermodes such as +R and +M. +# Services support module: Adds several user modes such as +R and +M. # This module implements the 'identified' state via account names, # and is similar in operation to the way asuka and ircu handle services. # @@ -1977,6 +2012,7 @@ #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Serverban: Implements extended ban 's', which stops anyone connected # to a server matching a mask like +b s:server.mask.here from joining. +# Wildcards are accepted. # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# @@ -2018,7 +2054,7 @@ # endtext="End of server rules."> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Show whois module: Adds the +W usermode which allows opers to see +# Show whois module: Adds the +W user mode which allows opers to see # when they are /WHOIS'd. # This module is oper-only by default. # @@ -2070,7 +2106,7 @@ # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# GnuTLS SSL module: Adds support for SSL connections using GnuTLS, +# GnuTLS SSL module: Adds support for SSL/TLS connections using GnuTLS, # if enabled. You must answer 'yes' in ./configure when asked or # manually symlink the source for this module from the directory # src/modules/extra, if you want to enable this, or it will not load. @@ -2078,30 +2114,40 @@ # #-#-#-#-#-#-#-#-#-#-#- GNUTLS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-# # # -# ssl_gnutls is too complex to describe here, see the wiki: # -# https://wiki.inspircd.org/Modules/3.0/ssl_gnutls # +# ssl_gnutls is too complex to describe here, see the docs: # +# https://docs.inspircd.org/3/modules/ssl_gnutls # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # SSL info module: Allows users to retrieve information about other -# users' peer SSL certificates and keys. This can be used by client -# scripts to validate users. For this to work, one of ssl_gnutls -# or ssl_openssl must be loaded. This module also adds the -# "* is using a secure connection" whois line, the ability for -# opers to use SSL cert 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 if you use SSL on your -# network. -# For how to use the oper features, please see the first example tag -# in opers.conf.example. +# users' peer SSL certificates and keys via the SSLINFO command. +# This can be used by client scripts to validate users. For this to +# work, one of ssl_gnutls, ssl_mbedtls or ssl_openssl must be loaded. +# This module also adds the " is using a secure connection" +# and " has client certificate fingerprint " +# WHOIS lines, the ability for opers to use SSL cert 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 if you use SSL on your network. +# For how to use the oper features, please see the first +# example tag in opers.conf.example. # # +# +# If you want to prevent users from viewing SSL certificate information +# and fingerprints of other users, set operonly to yes. +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # mbedTLS SSL module: Adds support for SSL/TLS connections using mbedTLS. # +# +#-#-#-#-#-#-#-#-#-#-#- MBEDTLS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-# +# # +# ssl_mbedtls is too complex to describe here, see the docs: # +# https://docs.inspircd.org/3/modules/ssl_mbedtls # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# OpenSSL SSL module: Adds support for SSL connections using OpenSSL, +# OpenSSL SSL module: Adds support for SSL/TLS connections using OpenSSL, # if enabled. You must answer 'yes' in ./configure when asked or symlink # the source for this module from the directory src/modules/extra, if # you want to enable this, or it will not load. @@ -2109,8 +2155,8 @@ # #-#-#-#-#-#-#-#-#-#-#- OPENSSL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-# # # -# ssl_openssl is too complex to describe here, see the wiki: # -# https://wiki.inspircd.org/Modules/3.0/ssl_openssl # +# ssl_openssl is too complex to describe here, see the docs: # +# https://docs.inspircd.org/3/modules/ssl_openssl # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Strip color module: Adds channel mode +S that strips color codes and @@ -2139,8 +2185,8 @@ # #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-# # # -# sqlite is more complex than described here, see the wiki for more # -# info: https://wiki.inspircd.org/Modules/3.0/sqlite3 # +# sqlite is more complex than described here, see the docs for more # +# info: https://docs.inspircd.org/3/modules/sqlite3 # # # @@ -2152,8 +2198,8 @@ # #-#-#-#-#-#-#-#-#-#-#- SQLAUTH CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-# # # -# sqlauth is too complex to describe here, see the wiki: # -# https://wiki.inspircd.org/Modules/3.0/sqlauth # +# sqlauth is too complex to describe here, see the docs: # +# https://docs.inspircd.org/3/modules/sqlauth # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # SQL oper module: Allows you to store oper credentials in an SQL @@ -2167,14 +2213,14 @@ # # # dbid - Database ID to use (see SQL modules). # # # -# See also: https://wiki.inspircd.org/Modules/3.0/sqloper # +# See also: https://docs.inspircd.org/3/modules/sqloper # # # # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # StartTLS module: Implements STARTTLS, which allows clients # # connected to non SSL enabled ports to enable SSL, if a proper SSL # -# module is loaded (either ssl_gnutls or ssl_openssl). # +# module is loaded (either ssl_gnutls, ssl_mbedtls or ssl_openssl). # # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# @@ -2271,18 +2317,19 @@ # which are allowed to connect to the server. You should set this as # strict as possible to prevent malicious webpages from connecting to # your server. -# +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# XLine database: Stores all *-lines (G/Z/K/R/any added by other modules) +# X-line database: Stores all *-lines (G/Z/K/R/any added by other modules) # in a file which is 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. # -# Specify the filename for the xline database here. -# +# Specify the filename for the xline database and how often to check whether +# the database needs to be saved here. +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # ____ _ _____ _ _ ____ _ _ _ #