docs/conf/modules/unrealircd.conf.example

   1 <module name="m_md5.so">
   2 <module name="m_sha256.so">
   3 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
   4 # Alias module: Allows you to define server-side command aliases
   5 <module name="m_alias.so">
   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="m_allowinvite.so">
  39 <module name="m_alltime.so">
  40 <module name="m_auditorium.so">
  41 <auditorium showops="yes" operoverride="yes">
  42 <module name="m_banexception.so">
  43 <module name="m_blockcaps.so">
  44 <blockcaps percent="50"
  45            minlen="5"
  46            capsmap="ABCDEFGHIJKLMNOPQRSTUVWXYZ! ">
  47 <module name="m_blockcolor.so">
  48 <module name="m_botmode.so">
  49 <module name="m_censor.so">
  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="m_cgiirc.so">
  56 #
  57 #-#-#-#-#-#-#-#-#-#-#-# CGIIRC  CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#
  58 #
  59 # Optional - If you specify to use m_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: http://wiki.inspircd.org/Modules/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="m_chanfilter.so">
  94 <chanfilter hidemask="yes">
  95
  96 <module name="m_check.so">
  97 <module name="m_chghost.so">
  98 <hostname charmap="abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ.-_/0123456789">
  99
 100 <module name="m_chgident.so">
 101 <module name="m_chgname.so">
 102 <module name="m_cloaking.so">
 103 <cloak mode="half"
 104        key="secret"
 105        prefix="net-">
 106
 107 <module name="m_close.so">
 108 <module name="m_clones.so">
 109 <module name="m_commonchans.so">
 110
 111 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 112 # Conn-Join: Allows you to force users to join one or more channels
 113 # automatically upon connecting to the server.
 114 #<module name="m_conn_join.so">
 115 #
 116 #-#-#-#-#-#-#-#-#-#-#-#- CONNJOIN CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#
 117 #
 118 # If you have m_conn_join.so loaded, you can configure it using the
 119 # follow values:
 120 #
 121 #<autojoin channel="#one,#two,#three">
 122
 123 <module name="m_conn_umodes.so">
 124 <module name="m_cycle.so">
 125
 126 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 127 # Connection throttle module. Configuration:
 128 #<module name="m_connflood.so">
 129 #
 130 #-#-#-#-#-#-#-#-#-#-#- CONTHROTTLE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
 131 #  seconds, maxconns -  Amount of connections per <seconds>.
 132 #
 133 #  timeout           -  Time to wait after the throttle was activated
 134 #                       before deactivating it. Be aware that the time
 135 #                       is seconds + timeout.
 136 #
 137 #  quitmsg           -  The message that users get if they attempt to
 138 #                       connect while the throttle is active.
 139 #
 140 #  bootwait          -  Amount of time to wait before enforcing the
 141 #                       throttling when the server just booted.
 142 #
 143 #<connflood seconds="30" maxconns="3" timeout="30"
 144 #   quitmsg="Throttled" bootwait="10">
 145
 146 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 147 # DCCALLOW module: Adds the /DCCALLOW command
 148 <module name="m_dccallow.so">
 149 #
 150 #-#-#-#-#-#-#-#-#-#-#-  DCCALLOW CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#
 151 #  blockchat         - Whether to block DCC CHAT as well as DCC SEND
 152 #  length            - Default duration of entries in DCCALLOW list
 153 #  action            - Default action to take if no action is specified
 154 #                      can be 'block' or 'allow'
 155 #
 156 # File configuration:
 157 #  pattern           - The glob pattern to match against
 158 #  action            - Action to take if a user attempts to send a file
 159 #                      that matches this pattern, can be 'block' or 'allow'
 160 #
 161 #<dccallow blockchat="yes" length="5m" action="block">
 162 #<banfile pattern="*.exe" action="block">
 163 #<banfile pattern="*.txt" action="allow">
 164 #
 165 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 166
 167 <module name="m_deaf.so">
 168 <module name="m_denychans.so">
 169 #<badchan name="#gods*" allowopers="yes" reason="Tortoises!">         #
 170 #<badchan name="#heaven" redirect="#hell" reason="Nice try!">         #
 171
 172 <module name="m_devoice.so">
 173
 174 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 175 # Filter module: Provides message filtering, similar to SPAMFILTER.
 176 <module name="m_filter.so">
 177 #                                                                     #
 178 # This module depends upon a regex provider such as m_regex_pcre or   #
 179 # m_regex_glob to function. You must specify which of these you want  #
 180 # m_filter to use via the tag below.                                  #
 181 #                                                                     #
 182 # Valid engines are:                                                  #
 183 #                                                                     #
 184 # glob  - Glob patterns, provided via m_regex_glob.so                 #
 185 # pcre  - PCRE regexps, provided via m_regex_pcre.so, needs libpcre   #
 186 # tre   - TRE regexps, provided via m_regex_tre.so, requires libtre   #
 187 # posix - POSIX regexps, provided via m_regex_posix.so, not availale  #
 188 #         on windows, no dependencies on other operating systems.     #
 189 #                                                                     #
 190 <filteropts engine="glob">
 191 #                                                                     #
 192 # Your choice of regex engine must match on all servers network-wide.
 193 #
 194 # You may specify specific channels that are exempt from being filtered:
 195 #<exemptfromfilter channel="#blah">
 196 #
 197 #-#-#-#-#-#-#-#-#-#-#-  FILTER  CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#-#
 198 #                                                                     #
 199 # Optional - If you specify to use the m_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="m_gecosban.so">
 206 <module name="m_globops.so">
 207 <module name="m_globalload.so">
 208 <module name="m_halfop.so">
 209 <module name="m_helpop.so">
 210 <include file="inspircd.helpop-full.example">
 211
 212 <module name="m_hidechans.so">
 213 <hidechans affectsopers="false">
 214
 215 <module name="m_hideoper.so">
 216 <module name="m_ident.so">
 217 <ident timeout="1">
 218 <module name="m_inviteexception.so">
 219 <module name="m_joinflood.so">
 220 <module name="m_jumpserver.so">
 221 <module name="m_knock.so">
 222 <module name="m_messageflood.so">
 223 <module name="m_namesx.so">
 224 <module name="m_nickflood.so">
 225 <module name="m_noctcp.so">
 226 <module name="m_nokicks.so">
 227 <module name="m_nonicks.so">
 228 <module name="m_nopartmsg.so">
 229 <module name="m_nonotice.so">
 230 <module name="m_operchans.so">
 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 m_conn_join.
 235 <module name="m_operjoin.so">
 236 #
 237 #-#-#-#-#-#-#-#-#-#-#   OPERJOIN CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#
 238 #                                                                     #
 239 # If you are using the m_operjoin.so module, specify options here:    #
 240 #                                                                     #
 241 # channel     -      The channel name to join, can also be a comma    #
 242 #                    separated list eg. "#channel1,#channel2".        #
 243 #                                                                     #
 244 # override    -      Lets the oper join walking thru any modes that   #
 245 #                    might be set, even bans. Use "yes" or "no".      #
 246 #                                                                     #
 247 #<operjoin channel="#channel" override="no">
 248 #
 249 # Alternatively you can use the autojoin="channellist" in a <type>    #
 250 # tag to set specific autojoins for a type of oper, for example:      #
 251 #
 252 #<type name="Helper" autojoin="#help" classes="...">
 253
 254 <module name="m_operlog.so">
 255
 256 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 257 # Oper MOTD module: Provides support for separate message of the day
 258 # on oper-up
 259 # This module is oper-only.
 260 #<module name="m_opermotd.so">
 261 #
 262 #-#-#-#-#-#-#-#-#-#-#   OPERMOTD CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#
 263 #                                                                     #
 264 # If you are using the m_opermotd.so module, specify the motd here    #
 265 #                                                                     #
 266 # onoper      -      Should the message be sent on /OPER or only when #
 267 #                    /OPERMOTD is used. Use "yes" or "no".            #
 268 #                                                                     #
 269 #<opermotd file="oper.motd" onoper="yes">
 270
 271 <module name="m_override.so">
 272 #-#-#-#-#-#-#-#-#-#-#   OVERRIDE CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#
 273 #                                                                     #
 274 # m_override.so is too complex it describe here, see the wiki:        #
 275 # http://wiki.inspircd.org/Modules/override                           #
 276
 277 <module name="m_operlevels.so">
 278 <module name="m_opermodes.so">
 279 <module name="m_password_hash.so">
 280 <module name="m_muteban.so">
 281
 282 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 283 # Random Quote module: provides a random quote on connect.
 284 # NOTE: Some of these may mimic fatal errors and confuse users and
 285 # opers alike! - BEWARE!
 286 #<module name="m_randquote.so">
 287 #
 288 #-#-#-#-#-#-#-#-#-#-  RANDOMQUOTES CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
 289 #                                                                     #
 290 # Optional - If you specify to use the m_randquote.so module, then    #
 291 # specify below the path to the randquotes.conf file.                 #
 292 #                                                                     #
 293 #<randquote file="randquotes.conf">
 294
 295 <module name="m_redirect.so">
 296 <module name="m_regex_glob.so">
 297
 298 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 299 # Regular Expression Provider for PCRE (Perl-Compatible Regular
 300 # Expressions). You need libpcre installed to compile and load this
 301 # module. You must have at least 1 provider loaded to use m_filter or
 302 # m_rline.
 303 #<module name="m_regex_pcre.so">
 304
 305 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 306 # Regular Expression Provider for POSIX Regular Expressions.
 307 # You shouldn't need any additional libraries on a POSIX-compatible
 308 # system (ie: any Linux, BSD, but not Windows). You must have at least
 309 # 1 provider loaded to use m_filter or m_rline.
 310 # On POSIX-compliant systems, regex syntax can be found by using the
 311 # command: 'man 7 regex'.
 312 #<module name="m_regex_posix.so">
 313
 314 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 315 # Regular Expression Provider for TRE Regular Expressions.
 316 # This is the same regular expression engine used by UnrealIRCd, so
 317 # if you are most familiar with the syntax of /spamfilter from there,
 318 # this is the provider you want. You need libtre installed in order
 319 # to compile and load this module.
 320 #<module name="m_regex_tre.so">
 321
 322 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 323 # Registered users only channel creation
 324 # Allows only registered users and opers to create new channels.
 325 #
 326 # You probably *DO NOT* want to load this module on a public network.
 327 #
 328 #<module name="m_regonlycreate.so">
 329
 330 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 331 # Restricted channels module: Allows only opers to create channels.
 332 #
 333 # You probably *DO NOT* want to load this module on a public network.
 334 #
 335 #<module name="m_restrictchans.so">
 336
 337 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 338 # Restrict message module: Allows users to only message opers.
 339 #
 340 # You probably *DO NOT* want to load this module on a public network.
 341 #
 342 #<module name="m_restrictmsg.so">
 343
 344 <module name="m_sajoin.so">
 345 <module name="m_sakick.so">
 346 <module name="m_samode.so">
 347 <module name="m_sanick.so">
 348 <module name="m_sapart.so">
 349 <module name="m_saquit.so">
 350 <module name="m_satopic.so">
 351 <module name="m_servprotect.so">
 352 <module name="m_seenicks.so">
 353 <module name="m_setidle.so">
 354 <module name="m_services_account.so">
 355 <module name="m_sethost.so">
 356 <module name="m_setident.so">
 357 <module name="m_setname.so">
 358 <module name="m_showwhois.so">
 359 <showwhois opersonly="yes" showfromopers="yes">
 360
 361 <module name="m_shun.so">
 362 <shun enabledcommands="PING PONG QUIT PART JOIN" notifyuser="no" affectopers="no">
 363
 364 <module name="m_spy.so">
 365 <module name="m_sslmodes.so">
 366
 367 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 368 # GnuTLS SSL module: Adds support for SSL connections using GnuTLS,
 369 # if enabled. You must answer 'yes' in ./configure when asked or symlink
 370 # the source for this module from the directory src/modules/extra, if
 371 # you want to enable this, or it will not load.
 372 #<module name="m_ssl_gnutls.so">
 373 #
 374 #-#-#-#-#-#-#-#-#-#-#-  GNUTLS CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#
 375 #                                                                     #
 376 # m_ssl_gnutls.so is too complex it describe here, see the wiki:      #
 377 # http://wiki.inspircd.org/Modules/ssl_gnutls                         #
 378
 379 <module name="m_sslinfo.so">
 380
 381 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 382 # OpenSSL SSL module: Adds support for SSL connections using OpenSSL,
 383 # if enabled. You must answer 'yes' in ./configure when asked or symlink
 384 # the source for this module from the directory src/modules/extra, if
 385 # you want to enable this, or it will not load.
 386 #<module name="m_ssl_openssl.so">
 387 #
 388 #-#-#-#-#-#-#-#-#-#-#- OPENSSL CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#
 389 #                                                                     #
 390 # m_ssl_openssl.so is too complex it describe here, see the wiki:     #
 391 # http://wiki.inspircd.org/Modules/ssl_openssl                        #
 392
 393 <module name="m_stripcolor.so">
 394 <module name="m_svshold.so">
 395 <module name="m_swhois.so">
 396 <module name="m_tline.so">
 397 <module name="m_uhnames.so">
 398 <module name="m_userip.so">
 399 <module name="m_watch.so">
 400 <watch maxentries="32">
 401
 402 <module name="m_spanningtree.so">
 403