diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/conf/censor.conf.example | 12 | ||||
| -rw-r--r-- | docs/conf/filter.conf.example | 20 | ||||
| -rw-r--r-- | docs/conf/helpop-full.conf.example | 42 | ||||
| -rw-r--r-- | docs/conf/helpop.conf.example | 4 | ||||
| -rw-r--r-- | docs/conf/inspircd.conf.example | 39 | ||||
| -rw-r--r-- | docs/conf/modules.conf.example | 81 |
6 files changed, 107 insertions, 91 deletions
diff --git a/docs/conf/censor.conf.example b/docs/conf/censor.conf.example deleted file mode 100644 index 23924d14b..000000000 --- a/docs/conf/censor.conf.example +++ /dev/null @@ -1,12 +0,0 @@ -# Configuration file for the censor module - -# The tags for this module are formatted as follows: -# -# <badword text="simple word" -# replace="text to replace with"> -# -# You can specify <badword text="simple word" replace=""> -# to block lines containing the word - -<badword text="shit" replace="poo"> -<badword text="fuck" replace="(censored)"> diff --git a/docs/conf/filter.conf.example b/docs/conf/filter.conf.example index 26c68d2c3..29e1f530c 100644 --- a/docs/conf/filter.conf.example +++ b/docs/conf/filter.conf.example @@ -6,7 +6,7 @@ # reason="reason for filtering" # action="action to take" # flags="filter flags" -# duration="optional length of gline"> +# duration="optional duration of the G-line, Z-line or shun"> # # Valid actions for 'action' are: # @@ -25,15 +25,21 @@ # kill This disconnects the user, with the 'reason' parameter as # the kill reason. # -# gline G-LINE the user for 'duration' length of time. Durations may +# gline G-line the user for 'duration' length of time. Durations may # be specified using the notation 1y2d3h4m6s in a similar way to -# other glines, omitting the duration or setting it to 0 makes -# any glines set by this filter be permanent. +# other G-lines, omitting the duration or setting it to 0 makes +# any G-lines set by this filter be permanent. # -# zline Z-LINE the user for 'duration' length of time. Durations may +# zline Z-line the user for 'duration' length of time. Durations may # be specified using the notation 1y2d3h4m6s in a similar way to -# other zlines, omitting the duration or setting it to 0 makes -# any zlines set by this filter be permanent. +# other Z-lines, omitting the duration or setting it to 0 makes +# any Z-lines set by this filter be permanent. +# +# shun Shun the user for 'duration' length of time. Durations may +# be specified using the notation 1y2d3h4m6s in a similar way to +# other X-lines, omitting the duration or setting it to 0 makes +# any shuns set by this filter be permanent. +# Requires the shun module to be loaded. # # You can add filters from IRC using the /FILTER command. If you do this, they # will be set globally to your entire network. diff --git a/docs/conf/helpop-full.conf.example b/docs/conf/helpop-full.conf.example index 6834ca7c8..dec0e23d1 100644 --- a/docs/conf/helpop-full.conf.example +++ b/docs/conf/helpop-full.conf.example @@ -475,8 +475,8 @@ numeric lists)"> This command will add a filter when more than one parameter is given, for messages of the types specified by the flags, with the given -filter definition, action, duration (when the action is 'gline' or 'shun'), -and reason. +filter definition, action, duration (when the action is 'gline', +'zline' or 'shun'), and reason. The filter will take effect when a message of any type specified by the flags and matching the definition is sent to the server, and @@ -492,8 +492,8 @@ Block Blocks message and informs +s IRCops of the blocked message and all relevant info Silent Blocks message, but does not notify IRCops Kill Kills the user -Gline Glines the user for the specified duration -Zline Zlines the user for the specified duration +Gline G-lines the user for the specified duration +Zline Z-lines the user for the specified duration Shun Shuns the user for the specified duration (requires the shun module) Valid FILTER Flags @@ -513,8 +513,8 @@ The reason for the filter will be used as the reason for the action, unless the action is 'none', and is sent to the user when their text is blocked by 'block' and 'silent' actions. -A gline duration may be specified in seconds, or in the format -1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours, 5 +A G-line, Z-line or shun duration may be specified in seconds, or in the +format 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours, 5 minutes and 6 seconds. All fields in this format are optional. When only one parameter is provided (the filter pattern) the provided @@ -721,7 +721,7 @@ Unloads and reloads a module on all linked servers."> <helpop key="kline" value="/KLINE <user@host> [<duration> :<reason>] -Sets or removes a k-line (local host based ban) on a host and ident mask. +Sets or removes a K-line (local host based ban) on a host and ident mask. You must specify all three parameters to add a ban, and one parameter to remove a ban (just the user@host section). @@ -731,7 +731,7 @@ The duration may be specified in seconds, or in the format <helpop key="zline" value="/ZLINE <ipmask> [<duration> :<reason>] -Sets or removes a z-line (ip based ban) on an ip range mask. +Sets or removes a Z-line (ip based ban) on an ip range mask. You must specify all three parameters to add a ban, and one parameter to remove a ban (just the ipmask). @@ -741,7 +741,7 @@ The duration may be specified in seconds, or in the format <helpop key="qline" value="/QLINE <nickmask> [<duration> :<reason>] -Sets or removes a q-line (nick based ban) on a nick mask. +Sets or removes a Q-line (nick based ban) on a nick mask. You must specify all three parameters to add a ban, and one parameter to remove a ban (just the nickmask). @@ -751,7 +751,7 @@ The duration may be specified in seconds, or in the format <helpop key="gline" value="/GLINE <user@host> [<duration> :<reason>] -Sets or removes a g-line (host based ban) on host mask. +Sets or removes a G-line (host based ban) on host mask. You must specify all three parameters to add a ban, and one parameter to remove a ban (just the user@host section). @@ -761,7 +761,7 @@ The duration may be specified in seconds, or in the format <helpop key="eline" value="/ELINE <user@host> [<duration> :<reason>] -Sets or removes a e-line (global ban exception) on host mask. +Sets or removes a E-line (global ban exception) on host mask. You must specify at least 3 parameters to add an exception, and one parameter to remove an exception (just the user@host section). @@ -770,9 +770,9 @@ The duration may be specified in seconds, or in the format 5 minutes and 6 seconds. All fields in this format are optional. This command has a few important limitations. Bans on *@<ip> can only -be negated by an eline on *@<ip>, bans on *@<host> can be negated by -elines on *@<ip>, or *@<host>, and bans on <ident>@* or <ident>@<host> -can be negated by any eline that matches."> +be negated by an E-line on *@<ip>, bans on *@<host> can be negated by +E-lines on *@<ip>, or *@<host>, and bans on <ident>@* or <ident>@<host> +can be negated by any E-line that matches."> <helpop key="wallops" value="/WALLOPS <message> @@ -780,9 +780,9 @@ Sends a message to all +w users."> <helpop key="rline" value="/RLINE <regex> [<duration> :<reason>] -Sets or removes an r-line (regex line) on a n!u@h\srealname mask. You -must specify all three parameters to add an rline, and one parameter -to remove an rline (just the regex). +Sets or removes an R-line (regex line) on a n!u@h\srealname mask. You +must specify all three parameters to add an R-line, and one parameter +to remove an R-line (just the regex). The duration may be specified in seconds, or in the format 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours, @@ -794,11 +794,11 @@ Closes all unregistered connections to the local server."> <helpop key="clearchan" value="/CLEARCHAN <channel> [<KILL|KICK|G|Z>] [<reason>] -Quits or kicks all non-opers from a channel, optionally G/Z-Lines them. +Quits or kicks all non-opers from a channel, optionally G/Z-lines them. Useful for quickly nuking bot channels. The default method, KILL, simply disconnects the victims from the server, -while methods G and Z also add G/Z-Lines for all the targets. +while methods G and Z also add G/Z-lines for all the targets. When used, the victims won't see each other getting kicked or quitting."> @@ -1070,8 +1070,8 @@ Note that all /STATS use is broadcast to online IRC operators."> R Allows receipt of remote oper commands (requires the operlog module). t Allows receipt of attempts to use /STATS (local and remote). v Allows receipt of oper-override notices (requires the override module). - x Allows receipt of local Xline notices (g/Z/q/k/e/R/shuns). - X Allows receipt of remote Xline notices (g/Z/q/k/e/R/shuns)."> + x Allows receipt of local X-line notices (G/Z/Q/K/E/R/SHUN/CBan). + X Allows receipt of remote X-line notices (G/Z/Q/K/E/R/SHUN/CBan)."> ###################### # EXTBANS # diff --git a/docs/conf/helpop.conf.example b/docs/conf/helpop.conf.example index 5285a4b6c..a4bfc751b 100644 --- a/docs/conf/helpop.conf.example +++ b/docs/conf/helpop.conf.example @@ -257,8 +257,8 @@ help channel if you have any questions."> R Allows receipt of remote oper commands (requires the operlog module). t Allows receipt of attempts to use /STATS (local and remote). v Allows receipt of oper-override notices (requires the override module). - x Allows receipt of local Xline notices (g/Z/q/k/e/R/shuns). - X Allows receipt of remote Xline notices (g/Z/q/k/e/R/shuns)."> + x Allows receipt of local X-line notices (G/Z/Q/K/E/R/SHUN/CBan). + X Allows receipt of remote X-line notices (G/Z/Q/K/E/R/SHUN/CBan)."> <helpop key="extbans" value="Extended Bans ---------- diff --git a/docs/conf/inspircd.conf.example b/docs/conf/inspircd.conf.example index 952b981f3..890c9cc4c 100644 --- a/docs/conf/inspircd.conf.example +++ b/docs/conf/inspircd.conf.example @@ -367,11 +367,11 @@ # softsendq: amount of data in a client's send queue before the server # begins delaying their commands in order to allow the sendq to drain - softsendq="8192" + softsendq="10240" # recvq: amount of data allowed in a client's queue before they are dropped. - # Entering "8K" is equivalent to "8192", see above. - recvq="8K" + # Entering "10K" is equivalent to "10240", see above. + recvq="10K" # threshold: This specifies the amount of command penalty a user is allowed to have # before being quit or fakelagged due to flood. Normal commands have a penalty of 1, @@ -520,25 +520,6 @@ # up to 100 entries. <maxlist chan="*" limit="100"> -#-#-#-#-#-#-#-#-#-#-#- DISABLED FEATURES -#-#-#-#-#-#-#-#-#-#-#-#-#-# -# # -# This tag is optional, and specifies one or more features which are # -# not available to non-operators. # -# # -# For example you may wish to disable NICK and prevent non-opers from # -# changing their nicknames. # -# Note that any disabled commands take effect only after the user has # -# 'registered' (e.g. after the initial USER/NICK/PASS on connection) # -# so for example disabling NICK will not cripple your network. # -# # -# You can also define if you want to disable any channelmodes # -# or usermodes from your users. # -# # -# `fakenonexistant' will make the ircd pretend that nonexistant # -# commands simply don't exist to non-opers ("no such command"). # -# # -#<disabled commands="TOPIC MODE" usermodes="" chanmodes="" fakenonexistant="yes"> - #-#-#-#-#-#-#-#-#-#-#-#-#- SERVER OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-# # # # Settings to define which features are usable on your server. # @@ -748,7 +729,7 @@ # when a remote whois (/WHOIS <nick> <nick>) is used. #hideserver="*.example.com" - # hidebans: If this value is set to yes, when a user is banned ([gkz]lined) + # hidebans: If this value is set to yes, when a user is banned ([KGZ]-lined) # only opers will see the ban message when the user is removed # from the server. hidebans="no" @@ -960,7 +941,7 @@ <badhost host="root@*" reason="Don't IRC as root!"> <badhost host="*@198.51.100.0/24" reason="This subnet is bad."> -# exception: Hosts that are exempt from [kgz]lines. +# exception: Hosts that are exempt from [KGZ]-lines. <exception # host: ident@hostname to exempt. # Wildcards and CIDR (if you specify an IP) can be used. @@ -971,14 +952,14 @@ #-#-#-#-#-#-#-#-#-#-#- INSANE BAN OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-#-# # # -# This optional tag allows you to specify how wide a gline, eline, # -# kline, zline or qline can be before it is forbidden from being # -# set. By setting hostmasks="yes", you can allow all G, K, E lines, # +# This optional tag allows you to specify how wide a G-line, E-line, # +# K-line, Z-line or Q-line can be before it is forbidden from being # +# set. By setting hostmasks="yes", you can allow all G-, K-, E-lines, # # no matter how many users the ban would cover. This is not # -# recommended! By setting ipmasks="yes", you can allow all Z lines, # +# recommended! By setting ipmasks="yes", you can allow all Z-lines, # # no matter how many users these cover too. Needless to say we # # don't recommend you do this, or, set nickmasks="yes", which will # -# allow any qline. # +# allow any Q-line. # # # <insane diff --git a/docs/conf/modules.conf.example b/docs/conf/modules.conf.example index 3b7d30e8f..ba674d2bd 100644 --- a/docs/conf/modules.conf.example +++ b/docs/conf/modules.conf.example @@ -312,16 +312,21 @@ #<module name="cban"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Censor module: Adds channel and user mode +G. +# Censor module: Adds channel and user mode +G which block phrases that +# are listed in the server bad words list. #<module name="censor"> # #-#-#-#-#-#-#-#-#-#-#- CENSOR CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-# # # -# Optional - If you specify to use the censor module, then you must # -# specify some censor tags. See also: # -# https://wiki.inspircd.org/Modules/3.0/censor # -# -#<include file="examples/censor.conf.example"> +# If you have the censor module loaded you should specify one or more # +# phrases to replace/block in user messages. The config for this is # +# formatted as follows: # +# # +# Replaces "eggplant" with "aubergine" within messages: # +# <badword text="eggplant" replace="aubergine"> # +# # +# Blocks messages that contain "fluffy capybaras": # +#<badword text="fluffy capybaras"> # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # CGI:IRC module: Enables forwarding the real IP address of a user from @@ -500,8 +505,8 @@ #<module name="classban"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Clear chan module: Allows opers to masskick, masskill or mass-G/ZLine -# all users on a channel using /CLEARCHAN. +# Clear chan module: Allows opers to masskick, masskill or +# mass G/Z-line all users on a channel using /CLEARCHAN. #<module name="clearchan"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# @@ -619,7 +624,7 @@ #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Connectban: Provides IP connection throttling. Any IP range that -# connects too many times (configurable) in an hour is Z-Lined for a +# connects too many times (configurable) in an hour is Z-lined for a # (configurable) duration, and their count resets to 0. #<module name="connectban"> # @@ -765,6 +770,43 @@ # Glob masks are accepted here also. # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Disable module: Provides support for disabling commands and modes. # +#<module name="disable"> +# +#-#-#-#-#-#-#-#-#-#-#-#- DISABLE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-# +# # +# If you have the disable module loaded then you need to specify the # +# commands and modes that you want disabled. Users who have not fully # +# connected yet are exempt from this module so you can e.g. disable # +# the NICK command but still allow users to connect to the server. # +# # +# commands - A space-delimited list of commands that can not be used # +# by users. You can exempt server operators from this with # +# the servers/use-disabled-commands privilege. # +# # +# chanmodes - One or more channel modes that can not be added/removed # +# by users. You can exempt server operators from this # +# with the servers/use-disabled-commands privilege. # +# # +# usermodes - One or more user modes that can not be added/removed by # +# users. You can exempt server operators from this with # +# the servers/use-disabled-commands privilege. # +# # +# fakenonexistent - Whether to pretend that a disabled command/mode # +# does not exist when executed/changed by a user. # +# Defaults to no. # +# # +# notifyopers - Whether to send a notice to snomask `a` when a user # +# is prevented from using a disabled command/mode. # +# Defaults to no. # +# # +#<disabled commands="KICK TOPIC" # +# chanmodes="kp" # +# usermodes="iw" # +# fakenonexistent="yes" # +# notifyopers="no"> # + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # DNS blacklist module: Provides support for looking up IPs on one or # # more blacklists. # #<module name="dnsbl"> # @@ -1021,7 +1063,6 @@ # 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. # -# The bind value indicates which IP to bind outbound requests to. # # nolookupprefix: If on, the idents of users being in a connect class # # with ident lookups disabled (i.e. <connect useident="off">) will be # # prefixed with a "~". If off, the ident of those users will not be # @@ -1621,7 +1662,7 @@ #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Regular expression provider for glob or wildcard (?/*) matching. -# You must have at least 1 provider loaded to use the filter or rline +# You must have at least 1 provider loaded to use the filter or R-line # modules. This module has no additional requirements, as it uses the # matching already present in InspIRCd core. #<module name="regex_glob"> @@ -1630,7 +1671,7 @@ # Regular expression provider for PCRE (Perl-Compatible Regular # Expressions). You need libpcre installed to compile and load this # module. You must have at least 1 provider loaded to use the filter or -# rline modules. +# R-line modules. #<module name="regex_pcre"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# @@ -1643,7 +1684,7 @@ # Regular expression provider for POSIX regular expressions. # You shouldn't need any additional libraries on a POSIX-compatible # system (i.e.: any Linux, BSD, but not Windows). You must have at -# least 1 provider loaded to use filter or rline. +# least 1 provider loaded to use the filter or R-line modules. # On POSIX-compliant systems, regex syntax can be found by using the # command: 'man 7 regex'. #<module name="regex_posix"> @@ -1723,7 +1764,7 @@ #<module name="restrictmsg"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# R-Line module: Ban users through regular expression patterns. +# R-line module: Ban users through regular expression patterns. #<module name="rline"> # #-#-#-#-#-#-#-#-#-#-#-#- RLINE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-# @@ -1732,15 +1773,15 @@ # useful under some situations, but *can* also use CPU with more users # on a server) then set 'matchonnickchange' 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 +# 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_<engine> must be loaded, or rline will be non-functional # until you load it or change the engine to one that is loaded. # #<rline matchonnickchange="yes" engine="pcre"> # -# Generally, you will NOT want to use 'glob' here, as this turns -# rline into just another gline. The exceptions are that rline will +# 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 # always use the full "nick!user@host realname" string, rather than only # user@host, but beware that only the ? and * wildcards are available, # and are the only way to specify where the space can occur if you do @@ -2089,7 +2130,7 @@ #<module name="starttls"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# SVSHold module: Implements SVSHOLD. Like Q:Lines, but can only be # +# SVSHold module: Implements SVSHOLD. Like Q-lines, but can only be # # added/removed by Services. # #<module name="svshold"> # SVSHOLD does not generate server notices by default, you can turn @@ -2185,7 +2226,7 @@ # <wsorigin allow="https://*.example.com/"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# XLine database: Stores all *Lines (G/Z/K/R/any added by other modules) +# XLine 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 |