docs/conf/modules/unrealircd.conf.example

   1 <module name="md5">
   2 <module name="sha256">
   3 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
   4 # Alias module: Allows you to define server-side command aliases.
   5 <module name="alias">
   6 <fantasy prefix="!" allowbots="no">
   7 # Aliases
   8 <alias text="NICKSERV" replace="PRIVMSG NickServ :$2-" requires="NickServ" uline="yes">
   9 <alias text="CHANSERV" replace="PRIVMSG ChanServ :$2-" requires="ChanServ" uline="yes">
  10 <alias text="OPERSERV" replace="PRIVMSG OperServ :$2-" requires="OperServ" uline="yes" operonly="yes">
  11 <alias text="BOTSERV" replace="PRIVMSG BotServ :$2-" requires="BotServ" uline="yes">
  12 <alias text="HOSTSERV" replace="PRIVMSG HostServ :$2-" requires="HostServ" uline="yes">
  13 <alias text="MEMOSERV" replace="PRIVMSG MemoServ :$2-" requires="MemoServ" uline="yes">
  14 <alias text="NS" replace="PRIVMSG NickServ :$2-" requires="NickServ" uline="yes">
  15 <alias text="CS" replace="PRIVMSG ChanServ :$2-" requires="ChanServ" uline="yes">
  16 <alias text="OS" replace="PRIVMSG OperServ :$2-" requires="OperServ" uline="yes" operonly="yes">
  17 <alias text="BS" replace="PRIVMSG BotServ :$2-" requires="BotServ" uline="yes">
  18 <alias text="HS" replace="PRIVMSG HostServ :$2-" requires="HostServ" uline="yes">
  19 <alias text="MS" replace="PRIVMSG MemoServ :$2-" requires="MemoServ" uline="yes">
  20 #
  21 # An example of using the format value to create an alias with two
  22 # different behaviours depending on the format of the parameters.
  23 #
  24 #<alias text="ID" format="#*" replace="PRIVMSG ChanServ :IDENTIFY $2 $3"
  25 #  requires="ChanServ" uline="yes">
  26 #
  27 #<alias text="ID" replace="PRIVMSG NickServ :IDENTIFY $2"
  28 #  requires="NickServ" uline="yes">
  29 #
  30 # This alias fixes a glitch in xchat 2.6.x and above and the way it
  31 # assumes IDENTIFY must be prefixed by a colon (:) character. It should
  32 # be placed ABOVE the default NICKSERV alias (the first example) listed
  33 # above.
  34 #
  35 #<alias text="NICKSERV" format=":IDENTIFY *" replace="PRIVMSG NickServ :IDENTIFY $3-"
  36 #  requires="NickServ" uline="yes">
  37
  38 <module name="allowinvite">
  39 <module name="alltime">
  40 <module name="auditorium">
  41 <auditorium showops="yes" operoverride="yes">
  42 <module name="banexception">
  43 <module name="blockcaps">
  44 <blockcaps percent="50"
  45            minlen="5"
  46            capsmap="ABCDEFGHIJKLMNOPQRSTUVWXYZ! ">
  47 <module name="blockcolor">
  48 <module name="botmode">
  49 <module name="censor">
  50 <include file="inspircd.censor.example">
  51
  52 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
  53 # CGI:IRC module: Adds support for automatic host changing in CGI:IRC
  54 # (http://cgiirc.sourceforge.net).
  55 #<module name="cgiirc">
  56 #
  57 #-#-#-#-#-#-#-#-#-#-#-# CGIIRC  CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#
  58 #
  59 # Optional - If you specify to use cgiirc, then you must specify one
  60 # or more cgihost tags which indicate authorised CGI:IRC servers which
  61 # will be connecting to your network, and an optional cgiirc tag.
  62 # For more information see: https://wiki.inspircd.org/Modules/3.0/cgiirc
  63 #
  64 # Set to yes if you want to notice opers when CGI clients connect
  65 # <cgiirc opernotice="no">
  66 #
  67 # The type field indicates where the module should get the real
  68 # client's IP address from, for further information, please see the
  69 # CGI:IRC documentation.
  70 #
  71 # Old style:
  72 # <cgihost type="pass" mask="www.mysite.com">       # Get IP from PASS
  73 # <cgihost type="ident" mask="otherbox.mysite.com"> # Get IP from ident
  74 # <cgihost type="passfirst" mask="www.mysite.com">  # See the docs
  75 # New style:
  76 # <cgihost type="webirc" password="foobar"
  77 #   mask="somebox.mysite.com">                      # Get IP from WEBIRC
  78 #
  79 # IMPORTANT NOTE:
  80 # ---------------
  81 #
  82 # When you connect CGI:IRC clients, there are two connect classes which
  83 # apply to these clients. When the client initially connects, the connect
  84 # class which matches the cgi:irc site's host is checked. Therefore you
  85 # must raise the maximum local/global clients for this ip as high as you
  86 # want to allow cgi clients. After the client has connected and is
  87 # determined to be a cgi:irc client, the class which matches the client's
  88 # real IP is then checked. You may set this class to a lower value, so that
  89 # the real IP of the client can still be restricted to, for example, 3
  90 # sessions maximum.
  91 #
  92
  93 <module name="chanfilter">
  94 <chanfilter hidemask="yes">
  95
  96 <module name="check">
  97 <module name="chghost">
  98 <hostname charmap="abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ.-_/0123456789">
  99
 100 <module name="chgident">
 101 <module name="chgname">
 102 <module name="cloaking">
 103 <cloak mode="half"
 104        key="secret"
 105        prefix="net-">
 106
 107 <module name="close">
 108 <module name="clones">
 109 <module name="commonchans">
 110
 111 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 112 # Auto join on connect module: Allows you to force users to join one
 113 # or more channels automatically upon connecting to the server.
 114 #<module name="conn_join">
 115 #
 116 #-#-#-#-#-#-#-#-#-#-#-#- CONNJOIN CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#
 117 #
 118 # If you have the conn_join module loaded, you can configure it below:
 119 #
 120 #<autojoin channel="#one,#two,#three">
 121
 122 <module name="conn_umodes">
 123 <module name="cycle">
 124
 125 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 126 # Connection throttle module.
 127 #<module name="connflood">
 128 #
 129 #-#-#-#-#-#-#-#-#-#-#- CONTHROTTLE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
 130 #  seconds, maxconns -  Amount of connections per <seconds>.
 131 #
 132 #  timeout           -  Time to wait after the throttle was activated
 133 #                       before deactivating it. Be aware that the time
 134 #                       is seconds + timeout.
 135 #
 136 #  quitmsg           -  The message that users get if they attempt to
 137 #                       connect while the throttle is active.
 138 #
 139 #  bootwait          -  Amount of time to wait before enforcing the
 140 #                       throttling when the server just booted.
 141 #
 142 #<connflood seconds="30" maxconns="3" timeout="30"
 143 #   quitmsg="Throttled" bootwait="10">
 144
 145 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 146 # DCCALLOW module: Adds the /DCCALLOW command.
 147 <module name="dccallow">
 148 #
 149 #-#-#-#-#-#-#-#-#-#-#-  DCCALLOW CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#
 150 #  blockchat         - Whether to block DCC CHAT as well as DCC SEND
 151 #  length            - Default duration of entries in DCCALLOW list
 152 #  action            - Default action to take if no action is specified
 153 #                      can be 'block' or 'allow'
 154 #
 155 # File configuration:
 156 #  pattern           - The glob pattern to match against
 157 #  action            - Action to take if a user attempts to send a file
 158 #                      that matches this pattern, can be 'block' or 'allow'
 159 #
 160 #<dccallow blockchat="yes" length="5m" action="block">
 161 #<banfile pattern="*.exe" action="block">
 162 #<banfile pattern="*.txt" action="allow">
 163 #
 164 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 165
 166 <module name="deaf">
 167 <module name="denychans">
 168 #<badchan name="#gods*" allowopers="yes" reason="Tortoises!">         #
 169 #<badchan name="#heaven" redirect="#hell" reason="Nice try!">         #
 170
 171 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 172 # Filter module: Provides message filtering, similar to SPAMFILTER.
 173 <module name="filter">
 174 #                                                                     #
 175 # This module depends upon a regex provider such as regex_pcre or     #
 176 # regex_glob to function. You must specify which of these you want    #
 177 # the filter module to use via the tag below.                         #
 178 #                                                                     #
 179 # Valid engines are:                                                  #
 180 #                                                                     #
 181 # glob   - Glob patterns, provided via regex_glob.                    #
 182 # pcre   - PCRE regexps, provided via regex_pcre, needs libpcre.      #
 183 # tre    - TRE regexps, provided via regex_tre, requires libtre.      #
 184 # posix  - POSIX regexps, provided via regex_posix, not available     #
 185 #          on Windows, no dependencies on other operating systems.    #
 186 # stdlib - stdlib regexps, provided via regex_stdlib, see comment     #
 187 #          at the <module> tag for info on availability.              #
 188 #                                                                     #
 189 <filteropts engine="glob">
 190 #                                                                     #
 191 # Your choice of regex engine must match on all servers network-wide.
 192 #
 193 # To learn more about the configuration of this module, read          #
 194 # examples/filter.conf.example, which covers the various types of     #
 195 # filters and shows how to add exemptions.                            #
 196 #
 197 #-#-#-#-#-#-#-#-#-#-#-  FILTER  CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#-#
 198 #                                                                     #
 199 # Optional - If you specify to use the filter module, then            #
 200 # specfiy below the path to the filter.conf file, or define some      #
 201 # <filter> tags.                                                      #
 202 #                                                                     #
 203 #<include file="filter.conf">
 204
 205 <module name="gecosban">
 206 <module name="globops">
 207 <module name="globalload">
 208 <module name="halfop">
 209 <module name="helpop">
 210 <include file="inspircd.helpop-full.example">
 211
 212 <module name="hidechans">
 213 <hidechans affectsopers="false">
 214
 215 <module name="hideoper">
 216 <module name="ident">
 217 <ident timeout="1">
 218 <module name="inviteexception">
 219 <module name="joinflood">
 220 <module name="jumpserver">
 221 <module name="knock">
 222 <module name="messageflood">
 223 <module name="namesx">
 224 <module name="nickflood">
 225 <module name="noctcp">
 226 <module name="nokicks">
 227 <module name="nonicks">
 228 <module name="nopartmsg">
 229 <module name="nonotice">
 230 <module name="operchans">
 231
 232 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 233 # Oper join module: Auto-joins opers to a channel upon oper-up.
 234 # This module is oper-only. For the user equivalent, see the conn_join
 235 # module.
 236 <module name="operjoin">
 237 #
 238 #-#-#-#-#-#-#-#-#-#-#   OPERJOIN CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#
 239 #                                                                     #
 240 # If you are using the operjoin module, specify options here:         #
 241 #                                                                     #
 242 # channel     -      The channel name to join, can also be a comma    #
 243 #                    separated list eg. "#channel1,#channel2".        #
 244 #                                                                     #
 245 # override    -      Lets the oper join walking thru any modes that   #
 246 #                    might be set, even bans. Use "yes" or "no".      #
 247 #                                                                     #
 248 #<operjoin channel="#channel" override="no">
 249 #
 250 # Alternatively you can use the autojoin="channellist" in a <type>    #
 251 # tag to set specific autojoins for a type of oper, for example:      #
 252 #
 253 #<type name="Helper" autojoin="#help" classes="...">
 254
 255 <module name="operlog">
 256
 257 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 258 # Oper MOTD module: Provides support for separate message of the day
 259 # on oper-up.
 260 # This module is oper-only.
 261 #<module name="opermotd">
 262 #
 263 #-#-#-#-#-#-#-#-#-#-#   OPERMOTD CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#
 264 #                                                                     #
 265 # If you are using the opermotd module, specify the motd here         #
 266 #                                                                     #
 267 # onoper        - If on, the message is sent on /OPER, otherwise it's #
 268 #                 only sent when /OPERMOTD is used.                   #
 269 #                                                                     #
 270 #<opermotd file="oper.motd" onoper="yes">
 271
 272 <module name="override">
 273 #-#-#-#-#-#-#-#-#-#-#   OVERRIDE CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#
 274 #                                                                     #
 275 # The override module is too complex to describe here, see the wiki:  #
 276 # https://wiki.inspircd.org/Modules/3.0/override                      #
 277
 278 <module name="operlevels">
 279 <module name="opermodes">
 280 <module name="password_hash">
 281 <module name="muteban">
 282
 283 <module name="redirect">
 284 <module name="regex_glob">
 285
 286 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 287 # Regular expression provider for PCRE (Perl-Compatible Regular
 288 # Expressions). You need libpcre installed to compile and load this
 289 # module. You must have at least 1 provider loaded to use the filter
 290 # or the rline module.
 291 #<module name="regex_pcre">
 292
 293 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 294 # Regular expression provider for POSIX Regular Expressions.
 295 # You shouldn't need any additional libraries on a POSIX-compatible
 296 # system (ie: any Linux, BSD, but not Windows). You must have at least
 297 # 1 provider loaded to use the filter or rline module.
 298 # On POSIX-compliant systems, regex syntax can be found by using the
 299 # command: 'man 7 regex'.
 300 #<module name="regex_posix">
 301
 302 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 303 # Regular expression provider for TRE Regular Expressions.
 304 # This is the same regular expression engine used by UnrealIRCd, so
 305 # if you are most familiar with the syntax of /spamfilter from there,
 306 # this is the provider you want. You need libtre installed in order
 307 # to compile and load this module.
 308 #<module name="regex_tre">
 309
 310 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 311 # Registered users only channel creation module. If enabled, only
 312 # registered users and opers can create new channels.
 313 #
 314 # You probably *DO NOT* want to load this module on a public network.
 315 #
 316 #<module name="regonlycreate">
 317
 318 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 319 # Restricted channels module: Allows only opers to create channels.
 320 #
 321 # You probably *DO NOT* want to load this module on a public network.
 322 #
 323 #<module name="restrictchans">
 324
 325 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 326 # Restrict message module: Allows users to only message opers.
 327 #
 328 # You probably *DO NOT* want to load this module on a public network.
 329 #
 330 #<module name="restrictmsg">
 331
 332 <module name="sajoin">
 333 <module name="sakick">
 334 <module name="samode">
 335 <module name="sanick">
 336 <module name="sapart">
 337 <module name="saquit">
 338 <module name="satopic">
 339 <module name="servprotect">
 340 <module name="seenicks">
 341 <module name="setidle">
 342 <module name="services_account">
 343 <module name="sethost">
 344 <module name="setident">
 345 <module name="setname">
 346 <module name="showwhois">
 347 <showwhois opersonly="yes" showfromopers="yes">
 348
 349 <module name="shun">
 350 <shun enabledcommands="PING PONG QUIT PART JOIN" notifyuser="no" affectopers="no">
 351
 352 <module name="sslmodes">
 353
 354 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 355 # GnuTLS SSL module: Adds support for SSL connections using GnuTLS,
 356 # if enabled. You must answer 'yes' in ./configure when asked or symlink
 357 # the source for this module from the directory src/modules/extra, if
 358 # you want to enable this, or it will not load.
 359 #<module name="ssl_gnutls">
 360 #
 361 #-#-#-#-#-#-#-#-#-#-#-  GNUTLS CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#
 362 #                                                                     #
 363 # ssl_gnutls is too complex to describe here, see the wiki:           #
 364 # https://wiki.inspircd.org/Modules/3.0/ssl_gnutls                    #
 365
 366 <module name="sslinfo">
 367
 368 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 369 # OpenSSL SSL module: Adds support for SSL connections using OpenSSL,
 370 # if enabled. You must answer 'yes' in ./configure when asked or symlink
 371 # the source for this module from the directory src/modules/extra, if
 372 # you want to enable this, or it will not load.
 373 #<module name="ssl_openssl">
 374 #
 375 #-#-#-#-#-#-#-#-#-#-#- OPENSSL CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#
 376 #                                                                     #
 377 # ssl_openssl is too complex to describe here, see the wiki:          #
 378 # https://wiki.inspircd.org/Modules/3.0/ssl_openssl                   #
 379
 380 <module name="stripcolor">
 381 <module name="svshold">
 382 <module name="swhois">
 383 <module name="tline">
 384 <module name="uhnames">
 385 <module name="userip">
 386 <module name="watch">
 387 <watch maxentries="32">
 388
 389 <module name="spanningtree">