X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=docs%2Fconf%2Fmodules.conf.example;h=9cb78daee74bc4720668b299f807d8f9885b119a;hb=bb1f892f68cb70537b224bca85cc40f1ed23017d;hp=517c5572033a28c6cefa838bcf50575af8d980c9;hpb=87b1461e2a4710a38b32186c2582da9fe9bb3804;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/docs/conf/modules.conf.example b/docs/conf/modules.conf.example index 517c55720..9cb78daee 100644 --- a/docs/conf/modules.conf.example +++ b/docs/conf/modules.conf.example @@ -116,6 +116,10 @@ # 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, # # as well as actually being on the network. If the # @@ -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. # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# @@ -550,11 +554,13 @@ # +# prefix="net-" +# ignorecase="no"> # # +# prefix="net-" +# ignorecase="no"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Clones module: Adds an oper command /CLONES for detecting cloned @@ -652,8 +658,8 @@ # bootwait - Amount of time in seconds to wait before enforcing # the throttling when the server just booted. # -# +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Custom prefixes: Allows for channel prefixes to be configured. @@ -675,7 +681,7 @@ # You can also override the configuration of prefix modes added by both the core # and other modules by adding a customprefix tag with change="yes" specified. # -# +# # # Do /RELOADMODULE customprefix after changing the settings of this module. @@ -828,9 +834,10 @@ #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # 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 : # @@ -855,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. # # # @@ -1166,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. @@ -1335,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 @@ -1638,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. @@ -1665,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. # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# @@ -2075,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. @@ -2088,25 +2119,35 @@ #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # 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. @@ -2179,7 +2220,7 @@ #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # 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). # # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# @@ -2266,17 +2307,24 @@ # Requires SHA-1 hash support available in the sha1 module. # # -# Whether to re-encode messages as UTF-8 before sending to WebSocket -# clients. This is recommended as the WebSocket protocol requires all -# text frames to be sent as UTF-8. If you do not have this enabled -# messages will be sent as binary frames instead. -# +# behindproxy: Whether the server is behind a proxy that sends the +# X-Real-IP or X-Forwarded-For headers. If enabled the +# server will use the IP address specified by those HTTP +# headers. You should NOT enable this unless you are using +# a HTTP proxy like nginx as it will allow IP spoofing. +# sendastext: Whether to re-encode messages as UTF-8 before sending to +# WebSocket clients. This is recommended as the WebSocket +# protocol requires all text frames to be sent as UTF-8. +# If you do not have this enabled messages will be sent as +# binary frames instead. +# # # If you use the websocket module you MUST specify one or more origins # 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. -# +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # X-line database: Stores all *-lines (G/Z/K/R/any added by other modules) @@ -2286,8 +2334,9 @@ # 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. +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # ____ _ _____ _ _ ____ _ _ _ #