docs/conf/modules/charybdis.conf.example

   1 <module name="m_md5.so">
   2 <module name="m_sha256.so">
   3 <module name="m_alias.so">
   4 <alias text="NICKSERV" replace="PRIVMSG NickServ :$2-" requires="NickServ" uline="yes">
   5 <alias text="CHANSERV" replace="PRIVMSG ChanServ :$2-" requires="ChanServ" uline="yes">
   6 <alias text="OPERSERV" replace="PRIVMSG OperServ :$2-" requires="OperServ" uline="yes" operonly="yes">
   7 <alias text="BOTSERV" replace="PRIVMSG BotServ :$2-" requires="BotServ" uline="yes">
   8 <alias text="HOSTSERV" replace="PRIVMSG HostServ :$2-" requires="HostServ" uline="yes">
   9 <alias text="MEMOSERV" replace="PRIVMSG MemoServ :$2-" requires="MemoServ" uline="yes">
  10 <alias text="NS" replace="PRIVMSG NickServ :$2-" requires="NickServ" uline="yes">
  11 <alias text="CS" replace="PRIVMSG ChanServ :$2-" requires="ChanServ" uline="yes">
  12 <alias text="OS" replace="PRIVMSG OperServ :$2-" requires="OperServ" uline="yes" operonly="yes">
  13 <alias text="BS" replace="PRIVMSG BotServ :$2-" requires="BotServ" uline="yes">
  14 <alias text="HS" replace="PRIVMSG HostServ :$2-" requires="HostServ" uline="yes">
  15 <alias text="MS" replace="PRIVMSG MemoServ :$2-" requires="MemoServ" uline="yes">
  16 <alias text="ID" replace="PRIVMSG NickServ :IDENTIFY $2" requires="NickServ" uline="yes">
  17
  18 <module name="m_banexception.so">
  19 <module name="m_banredirect.so">
  20 <module name="m_blockcolor.so">
  21 <module name="m_callerid.so">
  22 <callerid maxaccepts="16"
  23           operoverride="no"
  24           tracknick="no"
  25           cooldown="60">
  26
  27 <module name="m_cap.so">
  28 <module name="m_cban.so">
  29
  30 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
  31 # CGI:IRC module: Adds support for automatic host changing in CGI:IRC
  32 # (http://cgiirc.sourceforge.net).
  33 #<module name="m_cgiirc.so">
  34 #
  35 #-#-#-#-#-#-#-#-#-#-#-# CGIIRC  CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#
  36 #
  37 # Optional - If you specify to use m_cgiirc, then you must specify one
  38 # or more cgihost tags which indicate authorised CGI:IRC servers which
  39 # will be connecting to your network, and an optional cgiirc tag.
  40 # For more information see: http://wiki.inspircd.org/Modules/cgiirc
  41 #
  42 # Set to yes if you want to notice opers when CGI clients connect
  43 # <cgiirc opernotice="no">
  44 #
  45 # The type field indicates where the module should get the real
  46 # client's IP address from, for further information, please see the
  47 # CGI:IRC documentation.
  48 #
  49 # Old style:
  50 # <cgihost type="pass" mask="www.mysite.com">       # Get IP from PASS
  51 # <cgihost type="ident" mask="otherbox.mysite.com"> # Get IP from ident
  52 # <cgihost type="passfirst" mask="www.mysite.com">  # See the docs
  53 # New style:
  54 # <cgihost type="webirc" password="foobar"
  55 #   mask="somebox.mysite.com">                      # Get IP from WEBIRC
  56 #
  57 # IMPORTANT NOTE:
  58 # ---------------
  59 #
  60 # When you connect CGI:IRC clients, there are two connect classes which
  61 # apply to these clients. When the client initially connects, the connect
  62 # class which matches the cgi:irc site's host is checked. Therefore you
  63 # must raise the maximum local/global clients for this ip as high as you
  64 # want to allow cgi clients. After the client has connected and is
  65 # determined to be a cgi:irc client, the class which matches the client's
  66 # real IP is then checked. You may set this class to a lower value, so that
  67 # the real IP of the client can still be restricted to, for example, 3
  68 # sessions maximum.
  69 #
  70
  71 <module name="m_chancreate.so">
  72 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
  73 # Channel names module: Allows disabling channels which have certain
  74 # characters in the channel name such as bold, colorcodes, etc. which
  75 # can be quite annoying and allow users to on occasion have a channel
  76 # that looks like the name of another channel on the network.
  77 <module name="m_channames.so">
  78
  79 <channames
  80         # denyrange: characters or range of characters to deny in channel
  81         # names.
  82         denyrange="2"
  83
  84         # allowrange: characters or range of characters to specifically allow
  85         # in channel names.
  86         allowrange="">
  87
  88 <module name="m_channelban.so">
  89 <module name="m_chghost.so">
  90 <hostname charmap="abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ.-_/0123456789">
  91 <module name="m_chgident.so">
  92 <module name="m_chgname.so">
  93 <module name="m_cloaking.so">
  94 #
  95 #-#-#-#-#-#-#-#-#-#-#- CLOAKING  CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
  96 #                                                                     #
  97 # If you specify the m_cloaking.so module as above, you must define   #
  98 # cloak keys, and optionally a cloak prefix as shown below. The cloak #
  99 # keys must be shared across the network for correct cloaking.        #
 100 #                                                                     #
 101 # There are four methods of cloaking:                                 #
 102 #                                                                     #
 103 #   half           Cloak only the "unique" portion of a host; show    #
 104 #                  the last 2 parts of the domain, /16 subnet of IPv4 #
 105 #                  or /48 subnet of the IPv6 address.                 #
 106 #                                                                     #
 107 #   full           Cloak the users completely, using three slices for #
 108 #                  common CIDR bans (IPv4: /16, /24; IPv6: /48, /64)  #
 109 #                                                                     #
 110 # These methods use a single key that can be any length of text.      #
 111 # An optional prefix may be specified to mark cloaked hosts.          #
 112 #                                                                     #
 113 # The following methods are maintained for backwards compatibility;   #
 114 # they are slightly less secure, and always hide unresolved IPs       #
 115 #                                                                     #
 116 #   compat-host    InspIRCd 1.2-compatible host-based cloaking        #
 117 #   compat-ip      InspIRCd 1.2-compatible ip-always cloaking         #
 118 #                                                                     #
 119 # You must specify key1, key2, key3, key4 for the compat cloaking     #
 120 # modes; the values must be less than 0x80000000 and should be picked #
 121 # at random. Prefix is mandatory, will default to network name if not #
 122 # specified, and will always have a "-" appended.                     #
 123 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 124 #
 125 <cloak mode="half"
 126        key="secret"
 127        prefix="net-">
 128
 129 <module name="m_close.so">
 130 <module name="m_conn_umodes.so">
 131
 132 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 133 # Connectban: Provides IP connection throttling. Any IP range that connects
 134 # too many times (configurable) in an hour is zlined for a (configurable)
 135 # duration, and their count resets to 0.
 136 #
 137 # ipv4cidr and ipv6cidr allow you to turn the comparison from individual
 138 # IP addresses (32 and 128 bits) into CIDR masks, to allow for throttling
 139 # over whole ISPs/blocks of IPs, which may be needed to prevent attacks.
 140 #
 141 #<connectban threshold="10" duration="10m" ipv4cidr="32" ipv6cidr="128">
 142 # This allows for 10 connections in an hour with a 10 minute ban if that is exceeded.
 143 #
 144 #<module name="m_connectban.so">
 145
 146 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 147 # Connection throttle module.
 148 #<module name="m_connflood.so">
 149 #
 150 #-#-#-#-#-#-#-#-#-#-#- CONTHROTTLE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
 151 #  seconds, maxconns -  Amount of connections per <seconds>.
 152 #
 153 #  timeout           -  Time to wait after the throttle was activated
 154 #                       before deactivating it. Be aware that the time
 155 #                       is seconds + timeout.
 156 #
 157 #  quitmsg           -  The message that users get if they attempt to
 158 #                       connect while the throttle is active.
 159 #
 160 #  bootwait          -  Amount of time to wait before enforcing the
 161 #                       throttling when the server just booted.
 162 #
 163 #<connflood seconds="30" maxconns="3" timeout="30"
 164 #   quitmsg="Throttled" bootwait="10">
 165
 166 <module name="m_deaf.so">
 167 <module name="m_dnsbl.so">
 168 <module name="m_gecosban.so">
 169 <module name="m_globalload.so">
 170 <module name="m_ident.so">
 171 <ident timeout="1">
 172 <module name="m_inviteexception.so">
 173 <module name="m_joinflood.so">
 174 <module name="m_knock.so">
 175 <module name="m_namesx.so">
 176 <module name="m_operchans.so">
 177 <module name="m_operlog.so">
 178 <module name="m_opermodes.so">
 179 <module name="m_password_hash.so">
 180 <module name="m_permchannels.so">
 181 <module name="m_muteban.so">
 182 <module name="m_redirect.so">
 183
 184 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 185 # Regular expression provider for glob or wildcard (?/*) matching.
 186 # You must have at least 1 provider loaded to use m_filter or m_rline
 187 # modules. This module has no additional requirements, as it uses the
 188 # matching already present in InspIRCd core.
 189 #<module name="m_regex_glob.so">
 190
 191 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 192 # Regular expression provider for PCRE (Perl-Compatible Regular
 193 # Expressions). You need libpcre installed to compile and load this
 194 # module. You must have at least 1 provider loaded to use m_filter or
 195 # m_rline.
 196 #<module name="m_regex_pcre.so">
 197
 198 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 199 # Regular expression provider for POSIX regular expressions.
 200 # You shouldn't need any additional libraries on a POSIX-compatible
 201 # system (ie: any Linux, BSD, but not Windows). You must have at least
 202 # 1 provider loaded to use m_filter or m_rline.
 203 # On POSIX-compliant systems, regex syntax can be found by using the
 204 # command: 'man 7 regex'.
 205 #<module name="m_regex_posix.so">
 206
 207 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 208 # Registered users only channel creation
 209 # Allows only registered users and opers to create new channels.
 210 #
 211 # You probably *DO NOT* want to load this module on a public network.
 212 #
 213 #<module name="m_regonlycreate.so">
 214
 215 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 216 # Ban users through regular expression patterns
 217 #<module name="m_rline.so">
 218 #
 219 #-#-#-#-#-#-#-#-#-#-#-#- RLINE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
 220 #
 221 # If you wish to re-check a user when they change nickname (can be
 222 # useful under some situations, but *can* also use CPU with more users
 223 # on a server) then set the following configuration value:
 224 # Also, this is where you set what Regular Expression engine is to be
 225 # used. If you ever change it while running, all of your R-Lines will be
 226 # wiped. This is the regex engine used by all R-Lines set, and
 227 # m_regex_<engine>.so must be loaded, or rline will be nonfunctional
 228 # until you load it or change the engine to one that is loaded.
 229 #
 230 #<rline matchonnickchange="yes" engine="pcre">
 231 #
 232 # Generally, you will NOT want to use 'glob' here, as this turns
 233 # rline into just another gline. The exceptions are that rline will
 234 # always use the full nick!user@host realname string, rather than only
 235 # user@host, but beware that only the ? and * wildcards are available,
 236 # and are the only way to specify where the space can occur if you do
 237 # use glob. For this reason, is recommended to use a real regex engine
 238 # so that at least \s or [[:space:]] is available.
 239
 240 <module name="m_sasl.so">
 241 <module name="m_servprotect.so">
 242 <module name="m_services_account.so">
 243 <module name="m_sethost.so">
 244 <module name="m_serverban.so">
 245 <module name="m_showwhois.so">
 246 <showwhois opersonly="yes" showfromopers="yes">
 247
 248 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 249 # SSL channel mode module: Adds support for SSL-only channels via
 250 # channel mode +z and the 'z' extban which matches SSL client
 251 # certificate fingerprints.
 252 # Does not do anything useful without a working SSL module (see below).
 253 #<module name="m_sslmodes.so">
 254
 255 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 256 # GnuTLS SSL module: Adds support for SSL connections using GnuTLS,
 257 # if enabled. You must answer 'yes' in ./configure when asked or
 258 # manually symlink the source for this module from the directory
 259 # src/modules/extra, if you want to enable this, or it will not load.
 260 #<module name="m_ssl_gnutls.so">
 261 #
 262 #-#-#-#-#-#-#-#-#-#-#-  GNUTLS CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#
 263 #                                                                     #
 264 # m_ssl_gnutls.so is too complex to describe here, see the wiki:      #
 265 # http://wiki.inspircd.org/Modules/ssl_gnutls                         #
 266
 267 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 268 # SSL Info module: Allows users to retrieve information about other
 269 # user's peer SSL certificates and keys. This can be used by client
 270 # scripts to validate users. For this to work, one of m_ssl_gnutls.so
 271 # or m_ssl_openssl.so must be loaded. This module also adds the
 272 # "* <user> is using a secure connection" whois line, the ability for
 273 # opers to use SSL fingerprints to verify their identity and the ability
 274 # to force opers to use SSL connections in order to oper up.
 275 # It is highly recommended to load this module especially if
 276 # you use SSL on your network.
 277 # For how to use the oper features, please see the first example <oper> tag
 278 # in opers.conf.example.
 279 #
 280 #<module name="m_sslinfo.so">
 281
 282 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 283 # OpenSSL SSL module: Adds support for SSL connections using OpenSSL,
 284 # if enabled. You must answer 'yes' in ./configure when asked or symlink
 285 # the source for this module from the directory src/modules/extra, if
 286 # you want to enable this, or it will not load.
 287 #<module name="m_ssl_openssl.so">
 288 #
 289 #-#-#-#-#-#-#-#-#-#-#- OPENSSL CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#
 290 #                                                                     #
 291 # m_ssl_openssl.so is too complex to describe here, see the wiki:     #
 292 # http://wiki.inspircd.org/Modules/ssl_openssl                        #
 293
 294 <module name="m_stripcolor.so">
 295 <module name="m_svshold.so">
 296 <module name="m_tline.so">
 297 <module name="m_uhnames.so">
 298 <module name="m_watch.so">
 299 <watch maxentries="32">
 300 <module name="m_xline_db.so">
 301
 302 <module name="m_spanningtree.so">