X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=docs%2Fconf%2Fmodules.conf.example;h=0b149775bc480cc9d422f77ac8f7d15995233262;hb=e0dc7691c4cff3a38bc12adf10b3709d8c4901ba;hp=0241e9433ba11189b73eec5591b7fd8dc9059443;hpb=d3d4c7cf5c2ccb0169aa62d839479f22984437d9;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/docs/conf/modules.conf.example b/docs/conf/modules.conf.example index 0241e9433..0b149775b 100644 --- a/docs/conf/modules.conf.example +++ b/docs/conf/modules.conf.example @@ -78,13 +78,13 @@ # 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. # +# usercommand - If set to yes, the alias can be run simply as # +# /ALIASNAME. Defaults to yes. # # # -# channelcommand - If this is true, the alias can be used as an # +# channelcommand - If set to yes, 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. # +# default. Defaults to no. # # # # format - If this is defined, the parameters of the alias # # must match this glob pattern. For example if you # @@ -116,11 +116,11 @@ # 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 # +# stripcolor - If set to yes, 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 # +# uline - Setting this to yes 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 # # user is online, but not on a U-lined server, # @@ -128,7 +128,7 @@ # possibly a sign of a user trying to impersonate # # a service. # # # -# operonly - If true, this will make the alias oper only. # +# operonly - If yes, this will make the alias oper only. # # If a non-oper attempts to use the alias, it will # # appear to not exist. # # # @@ -340,7 +340,7 @@ # # CBAN does not allow glob channelmasks by default for compatibility # reasons. You can enable glob support by uncommenting the next line. -# +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Censor module: Adds channel and user mode +G which block phrases that @@ -375,14 +375,14 @@ # message to the server on connection. For more details please read the # IRCv3 WebIRC specification at: https://ircv3.net/specs/extensions/webirc.html # -# When using this method you must specify a wildcard mask or CIDR range -# to allow gateway connections from and at least one of either a TLS (SSL) -# client certificate fingerprint for the gateway or a password to be -# sent in the WEBIRC command. +# When using this method you must specify one or more wildcard masks +# or CIDR ranges to allow gateway connections from and at least one of +# either a TLS (SSL) client certificate fingerprint for the gateway or +# a password to be sent in the WEBIRC command. # # +# mask="192.0.2.0/24 198.51.100.*"> # # # -# Set the maximum number of lines allowed to be stored per channel below. -# This is the hard limit for 'X'. -# If prefixmsg is set to yes, joining users without batch support will get -# a NOTICE before playback telling them about the following lines being -# the pre-join history. -# If bots is set to yes, it will also send to users marked with +B -# +#-#-#-#-#-#-#-#-#-#-#- CHANHISTORY CONFIGURATION -#-#-#-#-#-#-#-#-#-#-# +# # +# bots - Whether to send channel history to bots. Defaults to yes. # +# # +# enableumode - Whether to enable the +N user mode which allows users # +# to opt-out of receiving channel history. Defaults to # +# no. # +# # +# maxlines - The maximum number of lines of chat history to send to a # +# joining users. Defaults to 50. # +# # +# prefixmsg - Whether to send an explanatory message to clients that # +# don't support the chathistory batch type. Defaults to # +# yes. # +# # +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Channel logging module: Used to send snotice output to channels, to @@ -601,6 +614,7 @@ #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Codepage module: Allows using a custom 8-bit codepage for nicknames # and case mapping. +# # # You should include one of the following files to set your codepage: # @@ -871,7 +885,17 @@ # # # # For configuration options please see the docs page for dnsbl at # -# https://docs.inspircd.org/3/modules/dnsbl # +# https://docs.inspircd.org/3/modules/dnsbl. You can also use one or # +# more of the following example configs for popular DNSBLs: # +# # +# DroneBL (https://dronebl.org) # +# +# # +# EFnet RBL (https://rbl.efnetrbl.org) # +# +# # +# dan.me.uk Tor exit node DNSBL (https://www.dan.me.uk/dnsbl) # +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Exempt channel operators module: Provides support for allowing # @@ -883,6 +907,8 @@ # 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 : # +# Furthermore, the exemptions configured in # +# can also be negated by using: /MODE #chan +X :* # # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# @@ -1023,9 +1049,9 @@ # # # This mode can optionally prevent opers from seeing channels on a +I -# user, for more privacy if set to true. +# user, for more privacy if set to yes. # This setting is not recommended for most mainstream networks. -# +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Hide list module: Allows for hiding the list of listmodes from users @@ -1093,7 +1119,7 @@ # a tag with type "httpd", and load at least one of the other # httpd_* modules to provide pages to display. # -# +# # # You can adjust the timeout for HTTP connections below. All HTTP # connections will be closed after (roughly) this time period. @@ -1147,10 +1173,10 @@ # the timeout for ident lookups here. If not defined, it will default # # to 5 seconds. This is a non-blocking timeout which holds the user # # in a 'connecting' state until the lookup is complete. # -# prefixunqueried: If on, the idents of users being in a connect class# -# with ident lookups disabled (i.e. ) will be # -# prefixed with a "~". If off, the ident of those users will not be # -# prefixed. Default is off. # +# prefixunqueried: If yes, the idents of users in a connect class # +# with ident lookups disabled (i.e. ) will be # +# prefixed with a "~". If no, the ident of those users will not be # +# prefixed. Default is no. # # # @@ -1176,7 +1202,7 @@ # The following block can be used to control which extensions are # enabled. Note that extended-join can be incompatible with delayjoin # and host cycling. -# +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # IRCv3 account-tag module. Adds the 'account' tag which contains the @@ -1498,7 +1524,7 @@ # which allows up to X nick changes in Y seconds. # # -# The number of seconds to prevent nick changes for: +# The time period to prevent nick changes for: # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# @@ -1591,8 +1617,8 @@ # # # If the following option is on then all oper commands will be sent to -# the snomask 'r'. The default is off. -# +# the snomask 'r'. The default is no. +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Oper prefixing module: Adds a channel prefix mode +y which is given @@ -1731,8 +1757,8 @@ # 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. # -# If 'listmodes' is true then all list modes (+b, +I, +e, +g...) will be -# saved. Defaults to false. +# If 'listmodes' is yes then all list modes (+b, +I, +e, +g...) will be +# saved. Defaults to no. # # 'saveperiod' determines how often to check if the database needs to be # saved to disk. Defaults to every five seconds. @@ -1844,8 +1870,8 @@ # in the same way as /REMOVE. # # -# supportnokicks: If true, /REMOVE is not allowed on channels where the -# nokicks (+Q) mode is set. Defaults to false. +# supportnokicks: If yes, /REMOVE is not allowed on channels where the +# nokicks (+Q) mode is set. Defaults to no. # protectedrank: Members having this rank or above may not be /REMOVE'd # by anyone. Set to 0 to disable this feature. Defaults to 50000. # @@ -1875,7 +1901,13 @@ # less CPU usage. Increasing this beyond 512 doesn't have # any effect, as the maximum length of a message on IRC # cannot exceed that. -# +# kickmessage - Kick message when * is specified +# # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# @@ -2011,8 +2043,6 @@ # securelist blocking these sites from listing, define exception tags # # as shown below: # # -# -# # # # exemptregistered - Whether the waiting period applies to users who # # are logged in to a services account. # @@ -2162,6 +2192,9 @@ # option is deprecated; you should instead give exempt # server operators the servers/ignore-shun privilege. # +# allowconnect: Whether to only apply shuns to users who are fully +# connected to the server. +# # allowtags: Whether to allow client tags to be attached to enabled # commands. # @@ -2178,6 +2211,7 @@ # @@ -2327,7 +2361,7 @@ # # SVSHOLD does not generate server notices by default, you can turn # notices on by uncommenting the next line. -# +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # SWHOIS module: Allows you to add arbitrary lines to user WHOIS.