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