conf/test/test.conf

   1 ########################################################################
   2 #                                                                      #
   3 #               ___                ___ ____   ____    _                #
   4 #              |_ _|_ __  ___ _ __|_ _|  _ \ / ___|__| |               #
   5 #               | || '_ \/ __| '_ \| || |_) | |   / _` |               #
   6 #               | || | | \__ \ |_) | ||  _ <| |__| (_| |               #
   7 #              |___|_| |_|___/ .__/___|_| \_\\____\__,_|               #
   8 #                            |_|                                       #
   9 #      ____             __ _                       _   _               #
  10 #     / ___|___  _ __  / _(_) __ _ _   _ _ __ __ _| |_(_) ___  _ __    #
  11 #    | |   / _ \| '_ \| |_| |/ _` | | | | '__/ _` | __| |/ _ \| '_ \   #
  12 #    | |__| (_) | | | |  _| | (_| | |_| | | | (_| | |_| | (_) | | | |  #
  13 #     \____\___/|_| |_|_| |_|\__, |\__,_|_|  \__,_|\__|_|\___/|_| |_|  #
  14 #                            |___/                                     #
  15 #                                                                      #
  16 ##################################||####################################
  17                                  #||#
  18 ##################################||####################################
  19 #                                                                      #
  20 #         This is an example of the config file for InspIRCd.          #
  21 #             Change the options to suit your network.                 #
  22 #                                                                      #
  23 #         This is a test.conf with semi-sane defaults if you just want #
  24 #         to get a network up and running as quickly as possible or if #
  25 #         you want a quick testnet for something.                      #
  26 #         It is not extremely secure, but we *STRONGLY* recommend      #
  27 #         using inspircd.conf.example and all the other sub-confs      #
  28 #         instead.                                                     #
  29 #                                                                      #
  30 #         This .conf in it's current form is not supported.            #
  31 #         Please do not ask for help if something isn't working        #
  32 #         as you expected.                                             #
  33 #         For a supported .conf, please use inspircd.conf.example      #
  34 #                                                                      #
  35 #     $Id: inspircd.conf.example 10648 2008-10-16 18:07:27Z brain $
  36 #                                                                      #
  37 #    ____                _   _____ _     _       ____  _ _   _         #
  38 #   |  _ \ ___  __ _  __| | |_   _| |__ (_)___  | __ )(_) |_| |        #
  39 #   | |_) / _ \/ _` |/ _` |   | | | '_ \| / __| |  _ \| | __| |        #
  40 #   |  _ <  __/ (_| | (_| |   | | | | | | \__ \ | |_) | | |_|_|        #
  41 #   |_| \_\___|\__,_|\__,_|   |_| |_| |_|_|___/ |____/|_|\__(_)        #
  42 #                                                                      #
  43 #   Lines prefixed with READ THIS BIT, as shown above, are IMPORTANT   #
  44 #   lines, and you REALLY SHOULD READ THEM. Yes, THIS MEANS YOU. Even  #
  45 #   if you've configured InspIRCd before, these probably indicate      #
  46 #   something new or different to this version and you SHOULD READ IT. #
  47 #                                                                      #
  48 ########################################################################
  49 #                                                                      #
  50 #         Unalphabeticalise the modules list at your own risk          #
  51 #                                                                      #
  52 ########################################################################
  53
  54 #-#-#-#-#-#-#-#-#-#  INCLUDE CONFIGURATION  #-#-#-#-#-#-#-#-#-#-#-#-#-#
  55 #                                                                     #
  56 # This optional tag allows you to include another config file         #
  57 # allowing you to keep your configuration tidy. The configuration     #
  58 # file you include will be treated as part of the configuration file  #
  59 # which includes it, in simple terms the inclusion is transparent.    #
  60 #                                                                     #
  61 # All paths to config files are relative to the directory of the main #
  62 # config file inspircd.conf, unless the filename starts with a forward#
  63 # slash (/) in which case it is treated as an absolute path.          #
  64 #                                                                     #
  65 # You may also include an executable file, in which case if you do so #
  66 # the output of the executable on the standard output will be added   #
  67 # to your config at the point of the include tag.                     #
  68 #                                                                     #
  69 # Syntax is as follows:                                               #
  70 #<include file="file.conf">                                           #
  71 #<include executable="/path/to/executable parameters">                #
  72 #                                                                     #
  73 # Executable Include Example:                                         #
  74 #<include executable="/usr/bin/wget -O - http://mynet.net/inspircd.conf">
  75 #                                                                     #
  76
  77
  78 #-#-#-#-#-#-#-#-#-#-#-#-  SERVER DESCRIPTION  -#-#-#-#-#-#-#-#-#-#-#-#-
  79 #                                                                     #
  80 #   Here is where you enter the information about your server.        #
  81 #                                                                     #
  82
  83 <server
  84         # name: Hostname of your server. Does not need to be valid.
  85         name="test.yournet.net"
  86
  87         # description: Server description. Spaces are allowed.
  88         description="Test IRC Server"
  89
  90         # network: Network name given on connect to clients.
  91         # Should be the same on all servers on the network and
  92         # not contain spaces.
  93         network="TestNet">
  94
  95
  96 #-#-#-#-#-#-#-#-#-#-#-#-   ADMIN INFORMATION   -#-#-#-#-#-#-#-#-#-#-#-#
  97 #                                                                     #
  98 #   Describes the Server Administrator's real name (optionally),      #
  99 #   nick, and email address.                                          #
 100 #                                                                     #
 101
 102 <admin
 103        # name: Real Name
 104        name="NetAdmin"
 105
 106        # nick: Nickname (preferably what you use on the network)
 107        nick="NetAdmin"
 108
 109        # email: email address. Does not have to be valid
 110        # but should be for the users to be able to contact you.
 111        email="admin@localhost">
 112
 113
 114 #-#-#-#-#-#-#-#-#-#-#-#-   PORT CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-
 115 #                                                                     #
 116 #   Enter the port and address bindings here.                         #
 117 #                                                                     #
 118 #                                                                     #
 119 #    ____                _   _____ _     _       ____  _ _   _        #
 120 #   |  _ \ ___  __ _  __| | |_   _| |__ (_)___  | __ )(_) |_| |       #
 121 #   | |_) / _ \/ _` |/ _` |   | | | '_ \| / __| |  _ \| | __| |       #
 122 #   |  _ <  __/ (_| | (_| |   | | | | | | \__ \ | |_) | | |_|_|       #
 123 #   |_| \_\___|\__,_|\__,_|   |_| |_| |_|_|___/ |____/|_|\__(_)       #
 124 #                                                                     #
 125 #  If you want to link servers to InspIRCd you must load the          #
 126 #  m_spanningtree.so module! Please see the modules list below for    #
 127 #  information on how to load this module! If you do not load this    #
 128 #  module, server ports will NOT be bound!                            #
 129 #                                                                     #
 130 # PLEASE NOTE: If you have build InspIRCd with IPv6 support, you MUST #
 131 # specify a bind address if you want the IRCd to bind to a IPv4 IP.   #
 132
 133 #<bind
 134       # address: IP address to bind to if the box that you are hosting
 135       # on has more than one IP, else the ircd will try to bind to all
 136       # IP's on the box if this is not defined
 137       #address=""
 138
 139       # port: Port for users and/or servers to be able to connect to.
 140       # you can select multiple ports by separating them
 141       # with a - character like the example below.
 142       #port="6697"
 143
 144       # type: Type of bind block this is. It can either be clients or
 145       # servers. Whichever you select will be the only type able to connect
 146       # to this bind section.
 147       #type="clients"
 148
 149       # ssl: If you want this bind section to use SSL, define either
 150       # gnutls or openssl here. The appropriate SSL modules must be loaded
 151       # for ssl to work. If you do not want this bind section to support ssl,
 152       # just remove this option.
 153       #ssl="gnutls">
 154
 155 <bind address="" port="6660-6669" type="clients">
 156
 157 # When linking servers, the openssl and gnutls transports are largely
 158 # link-compatible and can be used alongside each other or either/or
 159 # on each end of the link without any significant issues.
 160 # Transports can only be used on server blocks.
 161 # Supported Transports are: "zip", "openssl" and "gnutls".
 162 # You must load m_ziplinks module for zip, m_ssl_openssl for openssl
 163 # or m_ssl_gnutls for gnutls.
 164
 165 #<bind address="" port="7000,7001" type="servers">
 166 #<bind address="1.2.3.4" port="7005" type="servers" transport="openssl">
 167
 168
 169 #-#-#-#-#-#-#-#-#-#-  DIE/RESTART CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-
 170 #                                                                     #
 171 #   You can configure the passwords here which you wish to use for    #
 172 #   the die and restart commands. Only trusted IRCop's who will       #
 173 #   need this ability should know the die and restart password.       #
 174 #                                                                     #
 175
 176 <power
 177
 178       # diepass: Password for opers to use if they need to shutdown (die)
 179       # a server.
 180       diepass="z0mg-die"
 181
 182       # restartpass: Password for opers to use if they need to restart
 183       # a server.
 184       restartpass="restart-n0w">
 185
 186
 187 #-#-#-#-#-#-#-#-#-#-  CONNECTIONS CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#
 188 #                                                                     #
 189 #   This is where you can configure which connections are allowed     #
 190 #   and denied access onto your server. The password is optional.     #
 191 #   You may have as many of these as you require. To allow/deny all   #
 192 #   connections, use a '*' or 0.0.0.0/0.                              #
 193 #                                                                     #
 194
 195 <connect
 196          # allow: What IP addresses/hosts to allow for this block.
 197          allow="*"
 198
 199          # maxchans: Maximum number of channels a user in this class
 200          # be in at one time. This overrides every other maxchans setting.
 201          #maxchans="30"
 202
 203          # timeout: How long (in seconds) the server will wait before
 204          # disconnecting a user if they do not do anything on connect.
 205          # (Note, this is a client-side thing, if the client does not
 206          # send /nick, /user or /pass)
 207          timeout="60"
 208
 209          # flood: After x lines (flood) in x seconds (see threshold)
 210          # the user is disconnected for flooding.
 211          flood="20"
 212
 213          # threshold: In how many seconds can a user flood x lines (see flood)
 214          # before they are disconnected for excess flood.
 215          threshold="1"
 216
 217          # pingfreq: How often the server tries to ping connecting clients/servers.
 218          pingfreq="120"
 219
 220          # sendq: Amount of data that the server is allowed to send to the user
 221          # before they are dropped.
 222          sendq="262144"
 223
 224          # recvq: amount of data allowed in a clients queue before they are dropped.
 225          recvq="8192"
 226
 227          # localmax: Maximum local connections per IP.
 228          localmax="3"
 229
 230          # globalmax: Maximum global (network-wide) connections per IP.
 231          globalmax="3"
 232
 233          # limit: How many users are allowed in this class
 234          limit="5000"
 235
 236          # modes: Usermodes that are set on users in this block on connect.
 237          # Enabling this option requires that the m_conn_umodes module be loaded.
 238          # This entry is highly recommended to use for/with IP Cloaking/masking.
 239          modes="+x">
 240
 241 <connect
 242         # deny: Will not let people connect if they have specified host/IP.
 243         deny="69.254.*">
 244 <connect deny="3ffe::0/32">
 245
 246 #-#-#-#-#-#-#-#-#-#-#-#-  CIDR CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-
 247 #                                                                     #
 248 # CIDR configuration allows detection of clones and applying of       #
 249 # throttle limits across a CIDR range. (A CIDR range is a group of    #
 250 # IPs, for example, the CIDR range 192.168.1.0-192.168.1.255 may be   #
 251 # represented as 192.168.1.0/24). This means that abuse across an ISP #
 252 # is detected and curtailed much easier.                              #
 253 #                                                                     #
 254
 255 <cidr
 256         # ipv4clone: specifies how many bits of an IP address should be
 257         # looked at for clones. The default only looks for clones on a
 258         # single IP address of a user. You do not want to set this
 259         # extremely low. (Values are 0-32).
 260         ipv4clone="32"
 261
 262         # ipv6clone: specifies how many bits of an IP address should be
 263         # looked at for clones. The default only looks for clones on a
 264         # single IP address of a user. You do not want to set this
 265         # extremely low. (Values are 0-128).
 266         ipv6clone="128">
 267
 268 #-#-#-#-#-#-#-#-#-#-#-#-  CLASS CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-
 269 #                                                                     #
 270 #   Classes are a group of commands which are grouped together and    #
 271 #   given a unique name. They're used to define which commands        #
 272 #   are available to certain types of Operators.                      #
 273 #                                                                     #
 274 #                                                                     #
 275 #  Note: It is possible to make a class which covers all available    #
 276 #  commands. To do this, specify commands="*". This is not really     #
 277 #  recommended, as it negates the whole purpose of the class system,  #
 278 #  however it is provided for fast configuration (e.g. in test nets)  #
 279 #                                                                     #
 280
 281 <class
 282      name="Shutdown"
 283
 284      # commands: oper commands that users of this class can run.
 285      commands="DIE RESTART REHASH LOADMODULE UNLOADMODULE RELOAD"
 286
 287      # usermodes: Oper-only usermodes that opers with this class can use.
 288      usermodes="*"
 289
 290      # chanmodes: Oper-only channel modes that opers with this class can use.
 291      chanmodes="*">
 292
 293 <class name="ServerLink" commands="CONNECT SQUIT RCONNECT MKPASSWD MKSHA256 ALLTIME SAJOIN SAMODE SANICK SAPART SAQUIT" usermodes="*" chanmodes="*">
 294 <class name="BanControl" commands="KILL GLINE KLINE ZLINE QLINE ELINE TBAN TLINE USERIPCBAN CHECK CLOSE CLONES GLOBOPS JUMPSERVER SHUN LOCKSERV UNLOCKSERV NICKLOCK NICKUNLOCK" usermodes="*" chanmodes="*">
 295 <class name="OperChat" commands="WALLOPS GLOBOPS SETIDLE SPYLIST SPYNAMES TRACE TAXONOMY" usermodes="*" chanmodes="*">
 296 <class name="HostCloak" commands="SETHOST SETIDENT SETNAME CHGHOST CHGIDENT CHGNAME SETIDLE SWHOIS" usermodes="*" chanmodes="*">
 297
 298
 299 #-#-#-#-#-#-#-#-#-#-#-#-  OPERATOR COMPOSITION   -#-#-#-#-#-#-#-#-#-#-#
 300 #                                                                     #
 301 #   This is where you specify which types of operators you have on    #
 302 #   your server, as well as the commands they are allowed to use.     #
 303 #   This works alongside with the classes specified above.            #
 304 #                                                                     #
 305
 306 <type
 307     # name: Name of type. Used in actual olines below.
 308     # Cannot contain spaces. If you would like a space, use
 309     # the _ character instead and it will translate to a space on whois.
 310     name="NetAdmin"
 311
 312     # classes: classes (above blocks) that this type belongs to.
 313     classes="OperChat BanControl HostCloak Shutdown ServerLink"
 314
 315     # host: host oper gets on oper-up. This is optional.
 316     host="netadmin.yournet.net"
 317
 318     # modes: usermodes besides +o that are set on a oper of this type
 319     # when they oper up. Used for snomasks and other things.
 320     # Requires that m_opermodes.so be loaded.
 321     modes="+s +cCqQ"
 322     override="*">
 323
 324 <type name="GlobalOp" classes="OperChat BanControl HostCloak ServerLink" host="ircop.omega.org.za">
 325 <type name="Helper" classes="HostCloak" host="helper.omega.org.za">
 326
 327
 328 #-#-#-#-#-#-#-#-#-#-#-  OPERATOR CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#
 329 #                                                                     #
 330 #   Opers are defined here. This is a very important section.         #
 331 #   Remember to only make operators out of trust worthy people.       #
 332 #                                                                     #
 333
 334 # oline with plain-text password
 335 <oper
 336       # name: oper login that is used to oper up (/oper name password).
 337       # Remember: This is case sensitive
 338       name="admin"
 339
 340       # password: case-sensitive, unhashed...yea...self-explanatory.
 341       password="s3cret"
 342
 343       # host: What hostnames/IP's are allowed to oper up with this oline.
 344       # Multiple options can be separated by spaces and CIDR's are allowed.
 345       host="*@*"
 346
 347       # ** ADVANCED ** This option is disabled by default.
 348       # fingerprint: When using the m_oper_ssl_cert module, you may specify
 349       # a key fingerprint here. This can be obtained by using the
 350       # /fingerprint command while the module is loaded. This enhances
 351       # security by verifying that the person opering up has the matching
 352       # key/certificate combination. This enhances security a great deal.
 353       # If m_oper_ssl and/or m_ssl_gnutls/m_ssl_openssl aren't loaded,
 354       # this option will be ignored.
 355       #fingerprint="67:CB:9D:C0:13:24:8A:82:9B:B2:17:1E:D1:1B:EC:D4"
 356
 357       # type: What oper type this oline is. See the block above for list
 358       # of types. NOTE: This is case-sensitive as well.
 359       type="NetAdmin">
 360
 361 # oline with hashed password. It is highly recommended to use hashed passwords.
 362 #<oper
 363       # name: oper login that is used to oper up (/oper name password).
 364       # Remember: This is case sensitive
 365       #name="Brain"
 366
 367       # hash: what hash this password is hashed with. requires the module
 368       # for selected hash (m_md5.so, m_sha256.so or m_ripemd160) be
 369       # loaded and the oper password hashing module (m_password_hash.so)
 370       # loaded. Options here are: "md5", "sha256" and "ripemd160".
 371       #hash="sha256"
 372
 373       # password: a hash of your password (see above option) hashed
 374       # with /mkpasswd *hash* *password* . See m_password_hash in modules.conf
 375       # for more information about password hashing.
 376       #password="1ec1c26b50d5d3c58d9583181af8076655fe00756bf7285940ba3670f99fcba0"
 377
 378       # host: What hostnames/IP's are allowed to oper up with this oline.
 379       # Multiple options can be separated by spaces and CIDR's are allowed.
 380       #host="ident@dialup15.isp.com *@localhost *@server.com *@3ffe::0/16"
 381
 382       # type: What oper type this oline is. See the block above for list
 383       # of types. NOTE: This is case-sensitive as well.
 384       #type="NetAdmin">
 385
 386
 387 #-#-#-#-#-#-#-#-#-#-#-  SERVER LINK CONFIGURATION  -#-#-#-#-#-#-#-#-#-#
 388 #                                                                     #
 389 # Defines which servers can link to this one, and which servers this  #
 390 # server may create outbound links to.                                #
 391 #                                                                     #
 392 # If you would like more detailed options, but a slightly more        #
 393 # painful configuration, please see inspircd.conf.example.old         #
 394 #                                                                     #
 395 #    ____                _   _____ _     _       ____  _ _   _        #
 396 #   |  _ \ ___  __ _  __| | |_   _| |__ (_)___  | __ )(_) |_| |       #
 397 #   | |_) / _ \/ _` |/ _` |   | | | '_ \| / __| |  _ \| | __| |       #
 398 #   |  _ <  __/ (_| | (_| |   | | | | | | \__ \ | |_) | | |_|_|       #
 399 #   |_| \_\___|\__,_|\__,_|   |_| |_| |_|_|___/ |____/|_|\__(_)       #
 400 #                                                                     #
 401 #  If you want to link servers to InspIRCd you must load the          #
 402 #  m_spanningtree.so module! Please see the modules list below for    #
 403 #  information on how to load this module! If you do not load this    #
 404 #  module, server links will NOT work!                                #
 405 #                                                                     #
 406 #  Also, if you define any transports, you must load the modules for  #
 407 #  these transports BEFORE you load m_spanningtree, e.g. place them   #
 408 #  above it in the configuration file. Currently this means the three #
 409 #  modules m_ssl_gnutls, m_ziplinks and m_ssl_openssl, depending on   #
 410 #  which you choose to use.                                           #
 411 #                                                                     #
 412
 413 #<link name="hub.penguin.org"
 414
 415       # ipaddr: The IP address of the remote server.
 416       # Can also be a hostname, but hostname must resolve.
 417       #ipaddr="penguin.box.com"
 418
 419       # port: the port to connect to this server on
 420       #port="7000"
 421
 422       # allowmask: Range of IP addresses to allow for this link.
 423       # Can be a CIDR (see example).
 424       #allowmask="69.58.44.0/24"
 425
 426       # autoconnect: Time to wait to attempt to autoconnect
 427       # to remote server (in seconds).
 428       #autoconnect="300"
 429
 430       # failover: If defined, if this link fails,
 431       # what is the next link that is tried.
 432       #failover="hub.other.net"
 433
 434       # timeout: If defined, this option defines how long the server
 435       # will wait to consider the connect attempt failed and try the
 436       # failover (see above).
 437       #timeout="15"
 438
 439       # transport: If defined, this states extra modules that can be
 440       # used in the connection. Options are: "openssl" and "gnutls"
 441       # for encryption (they are compatible with each other) and
 442       # "zip" for compression. You must use the same (or a compa-
 443       # tible) transport on both sides of the link.
 444       #transport="gnutls"
 445
 446       # bind: Local IP address to bind to.
 447       #bind="1.2.3.4"
 448
 449       # statshidden: defines if IP is shown to opers when
 450       # /stats c is invoked.
 451       #statshidden="no"
 452
 453       # hidden: If this is set to yes, this server and it's "child"
 454       # servers will not be shown when users do a /map or /links
 455       #hidden="no"
 456
 457       # passwords: the passwords we send and recieve.
 458       # The remote server will have these passwords reversed.
 459       #sendpass="outgoing!password"
 460       #recvpass="incoming!password">
 461
 462 # A duplicate of the first link block without comments
 463 # if you like copying & pasting.
 464 #<link name="hub.penguin.org"
 465       #ipaddr="penguin.box.com"
 466       #port="7000"
 467       #allowmask="69.58.44.0/24"
 468       #autoconnect="300"
 469       #failover="hub.other.net"
 470       #timeout="15"
 471       #transport="gnutls"
 472       #bind="1.2.3.4"
 473       #statshidden="no"
 474       #hidden="no"
 475       #sendpass="outgoing!password"
 476       #recvpass="incoming!password">
 477
 478 # Link block for services. Options are the same as for the first
 479 # link block (depending on what your services package supports).
 480 #<link name="services.antarctic.com"
 481       #ipaddr="localhost"
 482       #port="7000"
 483       #allowmask="127.0.0.0/8"
 484       #sendpass="penguins"
 485       #recvpass="polarbears">
 486
 487
 488 #-#-#-#-#-#-#-#-#-#-#-#- ULINES CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#
 489 # This tag defines a ulined server. A U-Lined server has special      #
 490 # permissions, and should be used with caution. Services servers are  #
 491 # usually u-lined in this manner.                                     #
 492 #                                                                     #
 493 # The 'silent' value, if set to yes, indicates that this server should#
 494 # not generate quit and connect notices, which can cut down on noise  #
 495 # to opers on the network.                                            #
 496 #                                                                     #
 497 #<uline server="services.antarctic.com" silent="yes">
 498
 499 #-#-#-#-#-#-#-#-#-#-  MISCELLANEOUS CONFIGURATION  -#-#-#-#-#-#-#-#-#-#
 500 #                                                                     #
 501
 502 <files
 503        # motd: Path to your motd file. Path is relative to the conf directory.
 504        motd="inspircd.motd.example"
 505
 506        # rules: Path to your rules file. Path is relative to the conf directory.
 507        rules="inspircd.rules.example">
 508
 509 #-#-#-#-#-#-#-#-#-#-#-# MAXIMUM CHANNELS -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 510 #                                                                     #
 511
 512 <channels
 513           # users: Maximum number of channels a user can be in at once.
 514           users="20"
 515
 516           # opers: Maximum number of channels a oper can be in at once.
 517           opers="60">
 518
 519 #-#-#-#-#-#-#-#-#-#-#-#-#-#-# DNS SERVER -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 520 # If these values are not defined, InspIRCd uses the default DNS resolver
 521 # of your system.
 522
 523 #<dns
 524      # server: DNS server to use to attempt to resolve IP's to hostnames.
 525      #server="127.0.0.1"
 526
 527      # timeout: seconds to wait to try to resolve DNS/hostname.
 528      #timeout="5">
 529
 530 # An example of using an IPv6 nameserver
 531 #<dns server="::1" timeout="5">
 532
 533 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#  PID FILE  -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 534 #                                                                     #
 535 # Define the path to the PID file here. The PID file can be used to   #
 536 # rehash the ircd from the shell or to terminate the ircd from the    #
 537 # shell using shell scripts, perl scripts, etc... and to monitor the  #
 538 # ircd's state via cron jobs. If this is a relative path, it will be  #
 539 # relative to the configuration directory, and if it is not defined,  #
 540 # the default of 'inspircd.pid' is used.                              #
 541 #                                                                     #
 542
 543 #<pid file="/path/to/inspircd.pid">
 544
 545 #-#-#-#-#-#-#-#-#-#-#-#-#- BANLIST LIMITS #-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 546 #                                                                     #
 547 # Use these tags to customise the ban limits on a per channel basis.  #
 548 # The tags are read from top to bottom, and any tag found which       #
 549 # matches the channels name applies the banlimit to that channel.     #
 550 # It is advisable to put an entry with the channel as '*' at the      #
 551 # bottom of the list. If none are specified or no maxbans tag is      #
 552 # matched, the banlist size defaults to 64 entries.                   #
 553 #                                                                     #
 554
 555 <banlist chan="*" limit="69">
 556
 557 #-#-#-#-#-#-#-#-#-#-#-  DISABLED FEATURES  -#-#-#-#-#-#-#-#-#-#-#-#-#-#
 558 #                                                                     #
 559 # This tag is optional, and specifies one or more features which are  #
 560 # not available to non-operators.                                     #
 561 #                                                                     #
 562 # For example you may wish to disable NICK and prevent non-opers from #
 563 # changing their nicknames.                                           #
 564 # Note that any disabled commands take effect only after the user has #
 565 # 'registered' (e.g. after the initial USER/NICK/PASS on connection)  #
 566 # so for example disabling NICK will not cripple your network.        #
 567 #                                                                     #
 568 # `fakenonexistant' will make the ircd pretend that nonexistant       #
 569 # commands simply don't exist to non-opers ("no such command").       #
 570 #                                                                     #
 571 #<disabled commands="TOPIC MODE" usermodes="" chanmodes="" fakenonexistant="yes">
 572
 573
 574 #-#-#-#-#-#-#-#-#-#-#-#-#-  SERVER OPTIONS   -#-#-#-#-#-#-#-#-#-#-#-#-#
 575 #                                                                     #
 576 #   Settings to define which features are usable on your server.      #
 577 #                                                                     #
 578
 579 <options
 580          # prefixquit: What (if anything) a users' quit message
 581          # should be prefixed with.
 582          prefixquit="Quit: "
 583
 584          # suffixquit: What (if anything) a users' quit message
 585          # should be suffixed with.
 586          suffixquit=""
 587
 588          # prefixpart: What (if anything) a users' part message
 589          # should be prefixed with.
 590          prefixpart="\""
 591
 592          # suffixpart: What (if anything) a users' part message
 593          # should be suffixed with.
 594          suffixpart="\""
 595
 596          # noservices: With this set to no, when a user joins a empty channel,
 597          # the server will set +q on them. If set to yes, it will only set +o
 598          # on them until they register the channel.
 599          noservices="no"
 600
 601          # qprefix: Prefix (symbol) to use for +q users.
 602          qprefix="~"
 603
 604          # aprefix: Prefix (symbol) to use for +a users.
 605          aprefix="&"
 606
 607          # deprotectself: If this value is set (true, yes or 1), it will allow
 608          # +a and +q users to remove the +a and +q from themselves, otherwise,
 609          # the status will have to be removed by services.
 610          deprotectself="yes"
 611
 612          # deprotectothers: If this value is set to yes, true, or 1, then any
 613          # user with +q or +a may remove the +q or +a from other users.
 614          # The default setting is to not enable this feature, so that
 615          # only +q may remove +a, and nothing but services may remove +q.
 616          deprotectothers="no"
 617
 618          # syntaxhints: If enabled, if a user fails to send the correct parameters
 619          # for a command, the ircd will give back soome help text of what
 620          # the correct parameters are
 621          syntaxhints="yes"
 622
 623          # cyclehosts: If enabled, when a user gets a host set, it will cycle
 624          # them in all their channels. If not, it will simply change their host
 625          # without cycling them.
 626          cyclehosts="no"
 627
 628          # ircumsgprefix: Use undernet-style message prefixing for NOTICE and
 629          # PRIVMSG. If enabled, it will add users' prefix to the line, if not,
 630          # it will just message the user.
 631          ircumsgprefix="no"
 632
 633          # announcets: If set to yes, when the TS on a channel changes, all users
 634          # in channel will be sent a NOTICE about it.
 635          announcets="yes"
 636
 637          # hostintopic: If enabled, channels will show the host of the topicsetter
 638          # in the topic.
 639          hostintopic="no"
 640
 641          # pingwarning: If a server does not respond to a ping within x seconds,
 642          # it will send a notice to opers with snomask +l informing that the server
 643          # is about to ping timeout.
 644          pingwarning="15"
 645
 646          # serverpingfreq: How often pings are sent between servers (in seconds).
 647          serverpingfreq="60"
 648
 649          # allowhalfop: Allows the use of +h channelmode (halfops).
 650          allowhalfop="yes"
 651
 652          # defaultmodes: What modes are set on a empty channel when a user
 653          # joins it and it is unregistered. This is similar to Asuka's
 654          # autochanmodes.
 655          defaultmodes="nt"
 656
 657          # moronbanner: This is the text that is sent to a user when they are
 658          # banned from the server.
 659          moronbanner="You're banned! Email haha@abuse.com with the ERROR line below for help."
 660
 661          # exemptchanops: Defines what channel modes channel operators are
 662          # exempt from. Supported modes are +SfFgNc. Defaults to off.
 663          exemptchanops=""
 664
 665          # invitebypassmodes: This allows /invite to bypass other channel modes.
 666          # (Such as +k, +j, +l, etc)
 667          invitebypassmodes="yes">
 668
 669
 670 #-#-#-#-#-#-#-#-#-#-#-# PERFORMANCE CONFIGURATION #-#-#-#-#-#-#-#-#-#-#
 671 #                                                                     #
 672
 673 <performance
 674              # netbuffersize: Size of the buffer used to recieve data from clients.
 675              # The ircd may only read this amount of text in 1 go at any time.
 676              netbuffersize="10240"
 677
 678              # maxwho: Maximum number of results to show in a /who query.
 679              # It is not recommended to set this above 1024.
 680              maxwho="128"
 681
 682              # somaxconn: The maximum number of connections that may be waiting
 683              # in the accept queue. This is *NOT* the total maximum number of
 684              # connections per server. Some systems may only allow this to be up
 685              # to 5, while others (such as linux and *BSD) default to 128.
 686              somaxconn="128"
 687
 688              # softlimit: This optional feature allows a defined softlimit for
 689              # connections. If defined, it sets a soft max connections value.
 690              # must be lower than ./configure maxclients.
 691              softlimit="12800"
 692
 693              # quietbursts: When syncing or splitting from a network, a server
 694              # can generate a lof ot connect and quit messages to opers with
 695              # +C and +Q snomasks. Setting this to yes squelches those messages,
 696              # which makes it easier for opers, but degrades the functionality of
 697              # bots like BOPM during netsplits.
 698              quietbursts="yes"
 699
 700              # nouserdns: If enabled, no user DNS lookups will be performed on
 701              # connecting users. This can save a lot of resources on very busy servers.
 702              nouserdns="no">
 703
 704 #-#-#-#-#-#-#-#-#-#-#-# SECURITY CONFIGURATION  #-#-#-#-#-#-#-#-#-#-#-#
 705 #                                                                     #
 706
 707 <security
 708
 709           # announceinvites: If this option is set, then invites are announced
 710           # to the channel when a user invites another user. If you consider
 711           # this to be unnecessary noise, set this to 'none'.
 712           # To announce to all ops, set this to 'ops' and to announce to all users,
 713           # set the value to 'all'. The value 'dynamic' will make the messages
 714           # go to every user who has power of INVITE on the channel. This
 715           # is the recommended setting.
 716           announceinvites="dynamic"
 717
 718           # hidemodes: If enabled, then the listmodes given will be hidden
 719           # from users below halfop. This is not recommended to be set on +b
 720           # as it may break some functionality in popular clients such as mIRC.
 721           hidemodes="eI"
 722
 723           # disablehmac: If you are linking your InspIRCd to versions older
 724           # than 1.1.6 (NOT RECOMMENDED), then you can specify this option and
 725           # set it to yes. 1.1.6 and above support HMAC and challenge-response
 726           # for password authentication. These can greatly enhance security of your
 727           # server-to-server connections when you are not using SSL.
 728           # It is highly recommended to keep this set to no.
 729           disablehmac="no"
 730
 731           # hideulines: If this value is set to yes, U-lined server will
 732           # be hidden from non-opers in /links and /map.
 733           hideulines="no"
 734
 735           # flatlinks: If this value is set to yes, /map and /links will
 736           # be flattened when shown to non-opers.
 737           flatlinks="no"
 738
 739           # hidewhois: When defined, the given text will be used in place
 740           # of the server a user is on when whoised by a non-oper. Most
 741           # networks will want to set this to something like "*.netname.net"
 742           # to conceal the actual server a user is on.
 743           hidewhois=""
 744
 745           # hidebans: If this value is set to yes, when a user is banned ([gkz]lined)
 746           # only opers will see the ban message when the user is removed
 747           # from the server..
 748           hidebans="no"
 749
 750           # hidekills: If defined, replaces who set a /kill with a custom string.
 751           hidekills=""
 752
 753           # hidesplits: If enabled, non-opers will not be able to see which
 754           # servers split in a netsplit, they will only be able to see that one
 755           # occurred (If their client has netsplit detection).
 756           hidesplits="no"
 757
 758           # maxtargets: Maximum number of targets per command.
 759           # (Commands like /notice, /privmsg, /kick, etc)
 760           maxtargets="20"
 761
 762           # customversion: Displays a custom string when a user /version's
 763           # the ircd. This may be set for security reasons or vanity reasons.
 764           customversion=""
 765
 766           # operspywhois: If this is set, when a oper /whois 's a user,
 767           # it will show all channels the user is in including +s and +p
 768           # channels.
 769           operspywhois="yes"
 770
 771           # userstats: /stats commands that users can run (oeprs can run all).
 772           userstats="Pu">
 773
 774 #-#-#-#-#-#-#-#-#-#-#-#-# LIMITS CONFIGURATION  #-#-#-#-#-#-#-#-#-#-#-#
 775 #                                                                     #
 776 # This configuration tag defines the maximum sizes of various types   #
 777 # on IRC, such as the maximum length of a channel name, and the       #
 778 # maximum length of a channel. Note that with the exception of the    #
 779 # identmax value all values given here are the exact values you would #
 780 # expect to see on IRC. This contrasts with the older InspIRCd        #
 781 # releases where these values would be one character shorter than     #
 782 # defined to account for a null terminator on the end of the text.    #
 783 #                                                                     #
 784 # These values should match network-wide otherwise issues will occur. #
 785
 786 <limits
 787         # maxnick: Maximum length of a nickname.
 788         maxnick="31"
 789
 790         # maxchan: Maximum length of a channel name.
 791         maxchan="64"
 792
 793         # maxmodes: Maximum number of mode changes per line.
 794         maxmodes="20"
 795
 796         # maxident: Maximum length of a ident/username.
 797         maxident="11"
 798
 799         # maxquit: Maximum length of a quit message.
 800         maxquit="255"
 801
 802         # maxtopic: Maximum length of a channel topic.
 803         maxtopic="307"
 804
 805         # maxkick: Maximum length of a kick message.
 806         maxkick="255"
 807
 808         # maxgecos: Maximum length of a GECOS (realname).
 809         maxgecos="128"
 810
 811         # maxaway: Maximum length of an away messahe.
 812         maxaway="200">
 813
 814
 815 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 816 # Logging
 817 # -------
 818 #
 819 # Logging is covered with the <log> tag, which you may use to change
 820 # the behaviour of the logging of the IRCd.
 821 #
 822 # In InspIRCd as of 1.2, logging is pluggable and very extensible.
 823 # Different files can log the same thing, different 'types' of log can
 824 # go to different places, and modules can even extend the log tag
 825 # to do what they want.
 826 #
 827 # An example log tag would be:
 828 #       <log method="file" type="OPER" level="default" target="opers.log">
 829 # which  would log all information on /oper (failed and successful) to
 830 # a file called opers.log.
 831 #
 832 # There are many different types which may be used, and modules may
 833 # generate their own. A list of useful types:
 834 #       - USERS - information relating to user connection and disconnection
 835 #       - CHANNELS - information relating to joining and parting of channels.
 836 # XXX someone doc more on this
 837 #
 838 # You may also log *everything* by using a type of *, and subtract things out
 839 # of that by using -TYPE - for example "* -USERINPUT -USEROUTPUT".
 840 #
 841 # The following log tag is highly default and uncustomised. It is recommended you
 842 # sort out your own log tags. This is just here so you get some output.
 843
 844 <log method="file" type="* -USERINPUT -USEROUTPUT -m_spanningtree" level="default" target="ircd.log">
 845
 846 #-#-#-#-#-#-#-#-#-#-#-#-#-  WHOWAS OPTIONS   -#-#-#-#-#-#-#-#-#-#-#-#-#
 847 #                                                                     #
 848 # This tag lets you define the behaviour of the /whowas command of    #
 849 # your server.                                                        #
 850 #                                                                     #
 851
 852 <whowas
 853         # groupsize: Maximum entries per nick shown when performing
 854         # a /whowas nick.
 855         groupsize="10"
 856
 857         # maxgroups: Maximum number of nickgroups that can be added to
 858         # the list so that /whowas does not use a lot of resources on
 859         # large networks.
 860         maxgroups="100000"
 861
 862         # maxkeep: Maximum time a nick is kept in the whowas list
 863         # before being pruned. Time may be specified in seconds,
 864         # or in the following format: 1y2w3d4h5m6s. Minimum is
 865         # 1 hour.
 866         maxkeep="3d">
 867
 868 #-#-#-#-#-#-#-#-#-#-#-#-#-#-  BAN OPTIONS  -#-#-#-#-#-#-#-#-#-#-#-#-#-#
 869 #                                                                     #
 870 # The ban tags define nick masks, host masks and ip ranges which are  #
 871 # banned from your server. All details in these tags are local to     #
 872 # Your server.                                                        #
 873 #                                                                     #
 874
 875 <badip
 876        # ipmask: IP range to ban. Wildcards and CIDR can be used.
 877        ipmask="69.69.69.69"
 878
 879        # reason: Reason to display when user is disconnected.
 880        reason="No porn here thanks.">
 881
 882 <badnick
 883        # nick: Nick to disallow. Wildcards are supported.
 884        nick="ChanServ"
 885
 886        # reason: Reason to display on /nick.
 887        reason="Reserved For Services">
 888 <badnick nick="NickServ" reason="Reserved For Services">
 889 <badnick nick="OperServ" reason="Reserved For Services">
 890 <badnick nick="MemoServ" reason="Reserved For Services">
 891
 892 <badhost
 893        # host: ident@hostname to ban.
 894        # Wildcards and CIDR (if you specify an IP) can be used.
 895        host="*@hundredz.n.hundredz.o.1337.kiddies.com"
 896
 897        # reason: Reason to display when user is disconnected
 898        reason="Too many 1337 kiddiots">
 899 <badhost host="*@localhost" reason="No irc from localhost!">
 900 <badhost host="*@172.32.0.0/16" reason="This subnet is bad.">
 901
 902 # exception: Hosts that are exempt from [kgz]lines.
 903 <exception
 904        # host: ident@hostname to exempt.
 905        # Wildcards and CIDR (if you specify an IP) can be used.
 906        host="*@ircop.host.com"
 907
 908        # reason: Reason for exception. Only shown in /stats e
 909        reason="Opers hostname">
 910
 911 #-#-#-#-#-#-#-#-#-#-#- INSANE BAN OPTIONS  -#-#-#-#-#-#-#-#-#-#-#-#-#-#
 912 #                                                                     #
 913 # This optional tag allows you to specify how wide a gline, eline,    #
 914 # kline, zline or qline can be before it is forbidden from being      #
 915 # set. By setting hostmasks="yes", you can allow all G, K, E lines,   #
 916 # no matter how many users the ban would cover. This is not           #
 917 # recommended! By setting ipmasks="yes", you can allow all Z lines,   #
 918 # no matter how many users these cover too. Needless to say we        #
 919 # don't recommend you do this, or, set nickmasks="yes", which will    #
 920 # allow any qline.                                                    #
 921 #                                                                     #
 922
 923 <insane
 924         # hostmasks: Allow bans with insane hostmasks (over-reaching bans)
 925         hostmasks="no"
 926
 927         # ipmasks: Allow bans with insane ipmasks (over-reaching bans)
 928         ipmasks="no"
 929
 930         # nickmasks: Allow bans with insane nickmasks (over-reaching bans)
 931         nickmasks="no"
 932
 933         # trigger: What percentage of users on the network to trigger
 934         # specifying an insane ban as. The default is 95.5%, which means
 935         # if you have a 1000 user network, a ban will not be allowed if it
 936         # will be banning 955 or more users.
 937         trigger="95.5">
 938
 939 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# MODULES #-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 940 #    ____                _   _____ _     _       ____  _ _   _        #
 941 #   |  _ \ ___  __ _  __| | |_   _| |__ (_)___  | __ )(_) |_| |       #
 942 #   | |_) / _ \/ _` |/ _` |   | | | '_ \| / __| |  _ \| | __| |       #
 943 #   |  _ <  __/ (_| | (_| |   | | | | | | \__ \ | |_) | | |_|_|       #
 944 #   |_| \_\___|\__,_|\__,_|   |_| |_| |_|_|___/ |____/|_|\__(_)       #
 945 #                                                                     #
 946 # Well done, you've reached the end of the basic configuration, your  #
 947 # ircd should now start if you want to try it out! (./inspircd start) #
 948 #                                                                     #
 949 # We now suggest you read and edit modules.conf, as modules are what  #
 950 # provide almost all the features of InspIRCd. :)                     #
 951 #                                                                     #
 952 # The default does nothing -- we include it for simplicity for you.   #
 953 #-#-#-#-#-#-#-#-#-#-#-#-#-  MODULE OPTIONS   -#-#-#-#-#-#-#-#-#-#-#-#-#
 954 #                                                                     #
 955 #  These tags define which modules will be loaded on startup by your  #
 956 #  server. Add modules without any paths. When you make your ircd     #
 957 #  using the 'make' command, all compiled modules will be moved into  #
 958 #  the folder you specified when you ran ./configure. The module tag  #
 959 #  automatically looks for modules in this location.                  #
 960 #  If you attempt to load a module outside of this location, either   #
 961 #  in the config, or via /LOADMODULE, you will receive an error.      #
 962 #                                                                     #
 963 #  By default, ALL modules are commented out. You must uncomment them #
 964 #  or add lines to your config to load modules. Please refer to       #
 965 #  http://www.inspircd.org/wiki/Modules_List for a list of modules and#
 966 #  each modules link for any additional conf tags they require.       #
 967 #                                                                     #
 968 #  You may use wildcards in a <module> tag to load all modules which  #
 969 #  match a glob pattern (e.g. m_sa????.so would load m_sajoin,        #
 970 #  m_sapart, m_saquit and m_sanick)                                   #
 971 #                                                                     #
 972 #    ____                _   _____ _     _       ____  _ _   _        #
 973 #   |  _ \ ___  __ _  __| | |_   _| |__ (_)___  | __ )(_) |_| |       #
 974 #   | |_) / _ \/ _` |/ _` |   | | | '_ \| / __| |  _ \| | __| |       #
 975 #   |  _ <  __/ (_| | (_| |   | | | | | | \__ \ | |_) | | |_|_|       #
 976 #   |_| \_\___|\__,_|\__,_|   |_| |_| |_|_|___/ |____/|_|\__(_)       #
 977 #                                                                     #
 978 # To link servers to InspIRCd, you MUST load the m_spanningtree       #
 979 # module, as shown below. If you DO NOT do this, server links will    #
 980 # NOT work at all. ie. The ports will NOT bind, and /connect will not #
 981 # work properly. This is by design, to allow for the implementation   #
 982 # of other linking protocols in modules in the future.                #
 983
 984 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 985 # Spanning Tree module - allows linking of servers using the spanning
 986 # tree protocol (see the READ THIS BIT section above).
 987 # You will almost always want to load this.
 988 #
 989 <module name="m_spanningtree.so">
 990
 991
 992 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 993 # MD5 Module - Allows other modules to generate MD5 hashes, usually for
 994 # cryptographic uses and security.
 995 #
 996 # IMPORTANT:
 997 # Other modules such as m_cloaking.so and m_password_hash.so may rely on
 998 # this module being loaded to function.
 999 #
1000 <module name="m_md5.so">
1001 #
1002 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1003 # SHA256 Module - Allows other modules to generate SHA256 hashes,
1004 # usually for cryptographic uses and security.
1005 #
1006 # IMPORTANT:
1007 # Other modules such as m_password_hash.so may rely on this module being
1008 # loaded to function. Certain modules such as m_spanningtree.so will
1009 # function without this module but when it is loaded their features will
1010 # be enhanced (for example the addition of HMAC authentication).
1011 #
1012 <module name="m_sha256.so">
1013 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1014 # RIPEMD160 Module - Allows other modules to generate RIPEMD160 hashes,
1015 # usually for cryptographic uses and security.
1016 #
1017 # IMPORTANT:
1018 # Other modules may rely on this module being loaded to function.
1019 <module name="m_ripemd160.so">
1020
1021 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1022 # Abbreviation module: Provides the ability to abbreviate commands a-la
1023 # BBC BASIC keywords.
1024 <module name="m_abbreviation.so">
1025
1026 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1027 # Alias module: Allows you to define server-side command aliases
1028 #<module name="m_alias.so">
1029 #
1030 #-#-#-#-#-#-#-#-#-#-#-  ALIAS DEFINITIONS  -#-#-#-#-#-#-#-#-#-#-#-#-#-#
1031 #                                                                     #
1032 # If you have the m_alias.so module loaded, you may also define       #
1033 # aliases as shown below. They are commonly used to provide shortcut  #
1034 # commands to services, however they are not limited to just this use.#
1035 # An alias tag requires the following values to be defined in it:     #
1036 #                                                                     #
1037 # text        -      The text to detect as the actual command line,   #
1038 #                    Cant contain spaces, but case insensitive.       #
1039 #                    You may have multiple aliases with the same      #
1040 #                    command name (text="" value), however the first  #
1041 #                    found will be executed if its format value is    #
1042 #                    matched, or it has no format value. Aliases are  #
1043 #                    read from the top of the file to the bottom.     #
1044 #                                                                     #
1045 # format      -      If this is defined, the parameters of the alias  #
1046 #                    must match this glob pattern. For example if you #
1047 #                    want the first parameter to start with a # for   #
1048 #                    the alias to be executed, set format="#*" in the #
1049 #                    alias definition. Note that the :'s which are    #
1050 #                    part of IRC formatted lines will be preserved    #
1051 #                    for matching of this text. This value is         #
1052 #                    optional.                                        #
1053 #                                                                     #
1054 # replace     -      The text to replace 'text' with. Usually this    #
1055 #                    will be "PRIVMSG ServiceName :$2-" or similar.   #
1056 #                    You may use the variables $1 through $9 in the   #
1057 #                    replace string, which refer to the first through #
1058 #                    ninth word in the original string typed by the   #
1059 #                    user. You may also use $1- through $9- which     #
1060 #                    refer to the first word onwards, through to the  #
1061 #                    ninth word onwards, e.g. if the user types the   #
1062 #                    command "foo bar baz qux quz" then $3- will hold #
1063 #                    "baz qux quz" and $2 will contain "bar". You may #
1064 #                    also use the special variables: $nick, $ident,   #
1065 #                    $host and $vhost, and you may separate multiple  #
1066 #                    commands with \n. If you wish to use the ACTUAL  #
1067 #                    characters \ and n together in a line, you must  #
1068 #                    use the sequence "\\n".                          #
1069 #                                                                     #
1070 # requires    -      If you provide a value for 'requires' this means #
1071 #                    the given nickname MUST be online for the alias  #
1072 #                    to successfully trigger. If they are not, then   #
1073 #                    the user receives a 'no such nick' 401 numeric.  #
1074 #                                                                     #
1075 # uline       -      Defining this value with 'yes', 'true' or '1'    #
1076 #                    will ensure that the user given in 'requires'    #
1077 #                    must also be on a u-lined server, as well as     #
1078 #                    actually being on the network. If the user is    #
1079 #                    online, but not on a u-lined server, then an     #
1080 #                    oper-alert is sent out as this is possibly signs #
1081 #                    of a user trying to impersonate a service.       #
1082 #                                                                     #
1083 # operonly    -      Defining this value, with a value of 'yes', '1'  #
1084 #                    or true will make the alias oper only. If a non- #
1085 #                    oper attempts to use the alias, it will appear   #
1086 #                    to not exist.                                    #
1087 #                                                                     #
1088 #<alias text="NICKSERV" replace="PRIVMSG NickServ :$2-" requires="NickServ" uline="yes">
1089 #<alias text="CHANSERV" replace="PRIVMSG ChanServ :$2-" requires="ChanServ" uline="yes">
1090 #<alias text="OPERSERV" replace="PRIVMSG OperServ :$2-" requires="OperServ" uline="yes" operonly="yes">
1091 #<alias text="NS" replace="PRIVMSG NickServ :$2-" requires="NickServ" uline="yes">
1092 #<alias text="CS" replace="PRIVMSG ChanServ :$2-" requires="ChanServ" uline="yes">
1093 #<alias text="OS" replace="PRIVMSG OperServ :$2-" requires="OperServ" uline="yes" operonly="yes">
1094 #
1095 # An example of using the format value to create an alias with two
1096 # different behaviours depending on the format of the parameters.
1097 #
1098 #<alias text="ID" format="#*" replace="PRIVMSG ChanServ :IDENTIFY $2 $3"
1099 #  requires="ChanServ" uline="yes">
1100 #
1101 #<alias text="ID" replace="PRIVMSG NickServ :IDENTIFY $2"
1102 #  requires="NickServ" uline="yes">
1103 #
1104 # This alias fixes a glitch in xchat 2.6.x and above and the way it
1105 # assumes IDENTIFY must be prefixed by a colon (:) character. It should
1106 # be placed ABOVE the default NICKSERV alias (the first example) listed
1107 # above.
1108 #
1109 #<alias text="NICKSERV" format=":IDENTIFY *" replace="PRIVMSG NickServ :IDENTIFY $3-"
1110 #  requires="NickServ" uline="yes">
1111
1112 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1113 # Allowinvite module: Gives channel mode +A to allow all users to use
1114 # /invite, and extban A to deny invite from specific masks
1115 <module name="m_allowinvite.so">
1116
1117 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1118 # Alltime module: Shows time on all connected servers at once.
1119 # This module is oper-only and provides /alltime.
1120 # To use, ALLTIME must be in one of your oper class blocks.
1121 <module name="m_alltime.so">
1122
1123 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1124 # Antibear security module: Prevents 'bear.txt' based trojans from
1125 # connecting to your network by sending them a numeric they can't handle.
1126 <module name="m_antibear.so">
1127
1128 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1129 # Antibottler module: Labels bottler leech bots
1130 <module name="m_antibottler.so">
1131
1132 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1133 # Auditorium module: Adds channel mode +u which makes everyone else
1134 # except you in the channel invisible, used for large meetings etc.
1135 <module name="m_auditorium.so">
1136 #
1137 # Auditorium settings:
1138 #
1139 <auditorium showops="no" operoverride="no">
1140 #
1141 # showops:
1142 #   Setting this value to yes makes m_auditorium behave like unrealircd
1143 #   +u channel mode, e.g. ops see users joining, parting, etc, and users
1144 #   joining the channel see the ops. Without this flag, the mode acts
1145 #   like ircnet's +a (anonymous channels), showing only the user in the
1146 #   names list, and not even showing the ops in the list, or showing the
1147 #   ops that the user has joined.
1148 # operoverride:
1149 #   Setting this value to yes makes m_auditorium affect the userlist for
1150 #   regular users only. Opers will view all users in the channel normally.
1151
1152 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1153 # Ban except module: Adds support for channel ban exceptions (+e)
1154 <module name="m_banexception.so">
1155
1156 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1157 # Ban redirection module: Allows bans which redirect to a specified
1158 # channel. e.g. +b nick!ident@host#channelbanneduserissentto
1159 <module name="m_banredirect.so">
1160
1161 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1162 # Block amsg module: Attempt to block all usage of /amsg and /ame
1163 <module name="m_blockamsg.so">
1164 #
1165 #-#-#-#-#-#-#-#-#-#-#-  BLOCKAMSG CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#
1166 #                                                                     #
1167 # If you have the m_blockamsg.so module loaded, you can configure it  #
1168 # with the <blockamsg> tag:                                           #
1169 #                                                                     #
1170 # delay          -   How many seconds between two messages to force   #
1171 #                    them to be recognised as unrelated.              #
1172 # action         -   Any of 'notice', 'noticeopers', 'silent', 'kill' #
1173 #                    or 'killopers'. Define how to take action when   #
1174 #                    a user uses /amsg or /ame.                       #
1175 #
1176 <blockamsg delay="3" action="killopers">
1177
1178 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1179 # Block CAPS module: Blocking all-CAPS messages with cmode +B
1180 <module name="m_blockcaps.so">
1181 #                                                                     #
1182 #-#-#-#-#-#-#-#-#-#-#-  BLOCKCAPS CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#
1183 #                                                                     #
1184 # percent        - How many percent of text must be caps before text  #
1185 #                  will be blocked.                                   #
1186 #                                                                     #
1187 # minlen         - The minimum length a line must be for the block    #
1188 #                  percent to have any effect.                        #
1189 #                                                                     #
1190 # capsmap        - A list of chars to be considered CAPS, this was    #
1191 #                  you can add CAPS for your language. Also you can   #
1192 #                  add things like ! and space to further lock down   #
1193 #                  on caps usage.                                     #
1194 <blockcaps percent="50"
1195            minlen="5"
1196            capsmap="ABCDEFGHIJKLMNOPQRSTUVWXYZ! ">
1197
1198 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1199 # Block colour module: Blocking colour-coded messages with cmode +c
1200 <module name="m_blockcolor.so">
1201
1202 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1203 # Botmode module: Adds the user mode +B
1204 <module name="m_botmode.so">
1205
1206 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1207 # CallerID module: Adds usermode +g which activates hybrid-style
1208 # callerid (== block all private messages unless you /accept first)
1209 <module name="m_callerid.so">
1210 #
1211 #-#-#-#-#-#-#-#-#-#-#- CALLERID  CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1212 # maxaccepts     - Maximum number of entires a user can add to his    #
1213 #                  /accept list. Default is 16 entries.               #
1214 # operoverride   - Can opers (note: ALL opers) ignore callerid mode?  #
1215 #                  Default is no.                                     #
1216 # tracknick      - Preserve /accept entries when a user changes nick? #
1217 #                  If no (the default), the user is removed from      #
1218 #                  everyone's accept list if he changes nickname.     #
1219 # cooldown       - Amount of time (in seconds) that must pass since   #
1220 #                  the last notification sent to a user before he can #
1221 #                  be sent another. Default is 60 (1 minute).         #
1222 <callerid maxaccepts="16"
1223           operoverride="no"
1224           tracknick="no"
1225           cooldown="60">
1226
1227 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1228 # CAP module: Provides the CAP negotiation mechanism seen in
1229 # ratbox-derived ircds
1230 <module name="m_cap.so">
1231
1232 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1233 # CBAN module: Lets you disallow channels from being used at runtime.
1234 # This module is oper-only and provides /cban.
1235 # To use, CBAN must be in one of your oper class blocks.
1236 <module name="m_cban.so">
1237
1238 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1239 # Censor module: Adds the channel mode +G
1240 #<module name="m_censor.so">
1241 #
1242 #-#-#-#-#-#-#-#-#-#-#-  CENSOR  CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#-#
1243 #                                                                     #
1244 # Optional - If you specify to use the m_censor module, then you must #
1245 # specify some censor tags. See also:                                 #
1246 # http://www.inspircd.org/wiki/Censor_Module                          #
1247 #
1248 #<include file="censor.conf">
1249
1250 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1251 # CGI:IRC module: Adds support for automatic host changing in CGI:IRC
1252 # (http://cgiirc.sourceforge.net).
1253 #<module name="m_cgiirc.so">
1254 #
1255 #-#-#-#-#-#-#-#-#-#-#-# CGIIRC  CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#
1256 #
1257 # Optional - If you specify to use m_cgiirc, then you must specify one
1258 # or more cgihost tags which indicate authorised CGI:IRC servers which
1259 # will be connecting to your network, and an optional cgiirc tag.
1260 # For more information see: http://www.inspircd.org/wiki/CGI-IRC_Module
1261 #
1262 # Set to yes if you want to notice opers when CGI clients connect
1263 # <cgiirc opernotice="no">
1264 #
1265 # The type field indicates where the module should get the real
1266 # client's IP address from, for further information, please see the
1267 # CGI:IRC documentation.
1268 #
1269 # Old style:
1270 # <cgihost type="pass" mask="www.mysite.com">       # Get IP from PASS
1271 # <cgihost type="ident" mask="otherbox.mysite.com"> # Get IP from ident
1272 # <cgihost type="passfirst" mask="www.mysite.com">  # See the docs
1273 # New style:
1274 # <cgihost type="webirc" pass="foobar"
1275 #   mask="somebox.mysite.com">                      # Get IP from WEBIRC
1276 #
1277 # IMPORTANT NOTE:
1278 # ---------------
1279 #
1280 # When you connect CGI:IRC clients, there are two connect classes which
1281 # apply to these clients. When the client initially connects, the connect
1282 # class which matches the cgi:irc site's host is checked. Therefore you
1283 # must raise the maximum local/global clients for this ip as high as you
1284 # want to allow cgi clients. After the client has connected and is
1285 # determined to be a cgi:irc client, the class which matches the client's
1286 # real IP is then checked. You may set this class to a lower value, so that
1287 # the real IP of the client can still be restricted to, for example, 3
1288 # sessions maximum.
1289 #
1290
1291
1292 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1293 # Channel create module: Adds snomask +j, which will notify opers of
1294 # any new channels that are created.
1295 # This module is oper-only.
1296 <module name="m_chancreate.so">
1297
1298 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1299 # Channel filter module: Allows channel-op defined message
1300 # filtering using simple string matches (channel mode +g)
1301 <module name="m_chanfilter.so">
1302
1303 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1304 # Channel logging module: used to send snotice output to channels, to
1305 # allow staff to centrally monitor and discuss network activity.
1306 #
1307 # The "channel" field is where you want the messages to go, "snomasks"
1308 # is what snomasks you want to be sent to that channel. Multiple tags
1309 # are allowed.
1310 #<module name="m_chanlog.so">
1311 #<chanlog snomasks="AOcC" channel="#opers">
1312
1313 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1314 # Channelban: Implements extended ban j:, which stops anyone in already
1315 # in a channel matching a mask like +b j:#channel*mask from joining.
1316 <module name="m_channelban.so">
1317
1318 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1319 # Chanprotect module: gives +q and +a channel modes
1320 <module name="m_chanprotect.so">
1321
1322 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1323 # Check module: gives /check
1324 # Check is useful for looking up information on channels,
1325 # users, IP addresses and hosts.
1326 # This module is oper-only.
1327 # To use, CHECK must be in one of your oper class blocks.
1328 <module name="m_check.so">
1329
1330 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1331 # CHGHOST module: Adds the /CHGHOST command
1332 # This module is oper-only.
1333 # To use, CHGHOST must be in one of your oper class blocks.
1334 <module name="m_chghost.so">
1335 #
1336 #-#-#-#-#-#-#-#-# /CHGHOST - /SETHOST  CONFIGURATION #-#-#-#-#-#-#-#-#
1337 # Optional - If you want to use special chars for hostnames you can  #
1338 # specify your own custom list of chars with the <hostname> tag:     #
1339 #                                                                    #
1340 # charmap        - A list of chars accepted as valid by the /CHGHOST #
1341 #                  and /SETHOST commands. Also note that the list is #
1342 #                  case-sensitive.                                   #
1343 <hostname charmap="abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ.-_/0123456789">
1344
1345 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1346 # CHGIDENT module: Adds the /CHGIDENT command
1347 # This module is oper-only.
1348 # To use, CHGIDENT must be in one of your oper class blocks.
1349 <module name="m_chgident.so">
1350
1351 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1352 # CHGNAME module: Adds the /CHGNAME command
1353 # This module is oper-only.
1354 # To use, CHGNAME must be in one of your oper class blocks.
1355 <module name="m_chgname.so">
1356
1357 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1358 # Cloaking module: Adds usermode +x and cloaking support.
1359 # Relies on the module m_md5.so being loaded before m_cloaking.so in
1360 # the configuration file.
1361 # To use, you should enable m_conn_umodes and add +x as
1362 # an enabled mode. See the m_conn_umodes module for more information.
1363 <module name="m_cloaking.so">
1364 #
1365 #-#-#-#-#-#-#-#-#-#-#- CLOAKING  CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1366 #                                                                     #
1367 # Optional - If you specify the m_cloaking.so module as above, you    #
1368 # must define cloak keys, and optionally a cloak prefix as shown      #
1369 # below. When using cloaking, the cloak keys are MANDITORY and must   #
1370 # be included. However, if prefix is not included, it will default    #
1371 # to your networks name from the <server> tag. You can also include   #
1372 # the following optional values:                                      #
1373 #                                                                     #
1374 #   ipalways         - Always cloak the IP address, not the hostname, #
1375 #                      which doesn't reveal the user's ISP, but       #
1376 #                      results in hosts that are harder to read and   #
1377 #                      ban.                                           #
1378 #                                                                     #
1379 #   lowercase        - Display the cloaked hostnames in lowercase     #
1380 #                      characters instead of uppercase                #
1381 #                                                                     #
1382  <cloak key1="0x2AF39F40"
1383         key2="0x78E10B32"
1384         key3="0x4F2D2E82"
1385         key4="0x043A4C81"
1386         prefix="mynet"
1387         ipalways="false"
1388         lowercase="false">
1389 #                                                                     #
1390 # Please note that the key values will accept any number, and should  #
1391 # be large numbers. Using small numbers such as "7" or "1924" will    #
1392 # seriously weaken the security of your cloak. It is recommended you  #
1393 # use hexdecimal numbers prefixed by "0x", as shown in this example,  #
1394 # with each key eight hex digits long.                                #
1395
1396 #-#-#-#-#-#-#-#-#-#-#-#- CLOSE MODULE #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1397 # Close module: Allows an oper to close all unregistered connections.
1398 # This module is oper-only and provides /close.
1399 # To use, CLOSE must be in one of your oper class blocks.
1400 <module name="m_close.so">
1401
1402 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1403 # Clones module: Adds an oper command /CLONES for detecting cloned
1404 # users. Warning: This module may be resource intensive when its
1405 # command is issued, use with care.
1406 # This module is oper-only.
1407 # To use, CLONES must be in one of your oper class blocks.
1408 <module name="m_clones.so">
1409
1410 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1411 # Common channels module: Adds user mode +c, which, when set, requires
1412 # that users must share a common channel with you to PRIVMSG or NOTICE
1413 # you.
1414 <module name="m_commonchans.so">
1415
1416 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1417 # Conn-Join: Allows you to force users to join one or more channels
1418 # automatically upon connecting to the server.
1419 #<module name="m_conn_join.so">
1420 #
1421 #-#-#-#-#-#-#-#-#-#-#-#- CONNJOIN CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#
1422 #
1423 # If you have m_conn_join.so loaded, you can configure it using the
1424 # follow values:
1425 #
1426 #<autojoin channel="#one,#two,#three">
1427
1428 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1429 # Conn-Usermodes: Set modes on users when they connect
1430 # When this module is loaded <connect:allow> tags may have an optional
1431 # modes="" value, which contains modes to add or remove from users
1432 # when they connect to the server.
1433 <module name="m_conn_umodes.so">
1434
1435 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1436 # Conn-Wait-for-Pong: Don't let a user connect until they PONG
1437 #<module name="m_conn_waitpong.so">
1438 #
1439 #-#-#-#-#-#-#-#-#-#-#-   WAITPONG CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#
1440 #                                                                     #
1441 # If you have the m_conn_waitpong.so module loaded, configure it with #
1442 # the <waitpong> tag:                                                 #
1443 #                                                                     #
1444 # sendsnotice    -   Whether to send a snotice on connect, like other #
1445 #                    older ircds                                      #
1446 #                                                                     #
1447 # killonbadreply -   Whether to kill the user if they send the wrong  #
1448 #                    PONG reply.                                      #
1449 #                                                                     #
1450 #<waitpong sendsnotice="yes" killonbadreply="yes">
1451
1452
1453 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1454 # Channel cycle module. Server side /hop, with +ilk etc bypass.
1455 <module name="m_cycle.so">
1456
1457 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1458 # Connectban: Provides IP connection throttling. Any IP range that connects
1459 # too many times (configurable) in an hour is zlined for a (configurable)
1460 # duration, and their count resets to 0.
1461 #
1462 # ipv4cidr and ipv6cidr allow you to turn the comparison from individual
1463 # IP addresses (32 and 128 bits) into CIDR masks, to allow for throttling
1464 # over whole ISPs/blocks of IPs, which may be needed to prevent attacks.
1465 #
1466 #<connectban threshold="10" duration="10m" ipv4cidr="32" ipv6cidr="128">
1467 # This allows for 10 quits in an hour with a 10 minute ban if that is exceeded.
1468 #
1469 #<module name="m_connectban.so">
1470
1471 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1472 # Connection throttle module. Configuration:
1473 #<module name="m_connflood.so">
1474 #
1475 #-#-#-#-#-#-#-#-#-#-#- CONTHROTTLE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1476 #  seconds, maxconns -  Amount of connections per <seconds>.
1477 #
1478 #  timeout           -  Time to wait after the throttle was activated
1479 #                       before deactivating it. Be aware that the time
1480 #                       is seconds + timeout.
1481 #
1482 #  quitmsg           -  The message that users get if they attempt to
1483 #                       connect while the throttle is active.
1484 #
1485 #  bootwait          -  Amount of time to wait before enforcing the
1486 #                       throttling when the server just booted.
1487 #
1488 #<connflood seconds="30" maxconns="3" timeout="30"
1489 #   quitmsg="Throttled" bootwait="10">
1490
1491 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1492 # Custom title module: Adds the /TITLE command which allows for trusted
1493 #                      users to gain a custom whois line and a optional
1494 #                      vhost can be specified.
1495 #<module name="m_customtitle.so">
1496 #
1497 #-#-#-#-#-#-#-#-#-#-  CUSTOM TITLE CONFIGURATION   -#-#-#-#-#-#-#-#-#-#
1498 #  name              - The username used to identify
1499 #  password          - The password used to identify
1500 #  host              - Allowed hostmask [optional]
1501 #  title             - Title shown in whois
1502 #  vhost             - Displayed host [optional]
1503 #
1504 #<title name="foo" password="bar" title="Official Chat Helper">
1505 #<title name="bar" password="foo" host="ident@host.name" title="Official Chat Helper" vhost="helper.network.chat">
1506
1507 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1508 # DCCALLOW module: Adds the /DCCALLOW command
1509 <module name="m_dccallow.so">
1510 #
1511 #-#-#-#-#-#-#-#-#-#-#-  DCCALLOW CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#
1512 #  blockchat         - Whether to block DCC CHAT as well as DCC SEND
1513 #  length            - Default duration of entries in DCCALLOW list
1514 #  action            - Default action to take if no action is specified
1515 #                      can be 'block' or 'allow'
1516 #
1517 # File configuration:
1518 #  pattern           - The glob pattern to match against
1519 #  action            - Action to take if a user attempts to send a file
1520 #                      that matches this pattern, can be 'block' or 'allow'
1521 #
1522 #<dccallow blockchat="yes" length="5m" action="block">
1523 #<banfile pattern="*.exe" action="block">
1524 #<banfile pattern="*.txt" action="allow">
1525 #
1526 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1527
1528 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1529 # Deaf module: adds support for ircu style usermode +d - deaf to
1530 # channel messages and channel notices.
1531 <module name="m_deaf.so">
1532
1533 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1534 # Delay join module: Adds the channel mode +D which delays all JOIN
1535 # messages from users until they speak. If they quit or part before
1536 # speaking, their quit or part message will not be shown to the channel
1537 # which helps cut down noise on large channels in a more friendly way
1538 # than the auditorium mode. Only channel ops may set the +D mode.
1539 <module name="m_delayjoin.so">
1540
1541 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1542 # Deny Channels: Deny Channels from being used by users
1543 <module name="m_denychans.so">
1544 #
1545 #-#-#-#-#-#-#-#-#-#-#-   DENYCHAN DEFINITIONS  -#-#-#-#-#-#-#-#-#-#-#-#
1546 #                                                                     #
1547 # If you have the m_denychans.so module loaded, you need to specify   #
1548 # the channels to deny:                                               #
1549 #                                                                     #
1550 # name        -      The channel name to deny. (glob masks are ok)    #
1551 #                                                                     #
1552 # allowopers  -      If operators are allowed to override the deny.   #
1553 #                                                                     #
1554 # reason      -      Reason given for the deny.                       #
1555 #                                                                     #
1556 # redirect    -      Redirect the user to a different channel         #
1557 #                                                                     #
1558 #<badchan name="#gods*" allowopers="yes" reason="Tortoises!">         #
1559 #<badchan name="#heaven" redirect="#hell" reason="Nice try!">         #
1560 #                                                                     #
1561 # Redirects will not work if the target channel is set +L.            #
1562 #                                                                     #
1563 # Additionally, you may specify channels which are allowed, even if   #
1564 # a badchan tag specifies it would be denied:                         #
1565 #<goodchan name="#godsleeps">                                         #
1566 # Glob masks are accepted here also.
1567
1568 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1569 # Devoice Module: Let users devoice themselves.
1570 <module name="m_devoice.so">
1571
1572 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1573 # DNS Blacklist Module: Provides support for looking up IPs on one or #
1574 # more blacklists.                                                    #
1575 #<module name="m_dnsbl.so">                                           #
1576 #                                                                     #
1577 # For configuration options please see the wiki page for m_dnsbl at   #
1578 # http://inspircd.org/wiki/DNS_Blacklist_Module                       #
1579
1580 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1581 # Filter module: Provides message filtering, similar to SPAMFILTER.
1582 #<module name="m_filter.so">
1583 #                                                                     #
1584 # This module depends upon a regex provider such as m_regex_pcre or   #
1585 # m_regex_glob to function. You must specify which of these you want  #
1586 # m_filter to use via the tag below.                                  #
1587 #                                                                     #
1588 # Valid engines are:                                                  #
1589 #                                                                     #
1590 # glob  - Glob patterns, provided via m_regex_glob.so                 #
1591 # pcre  - PCRE regexps, provided via m_regex_pcre.so, needs libpcre   #
1592 # tre   - TRE regexps, provided via m_regex_tre.so, requires libtre   #
1593 # posix - POSIX regexps, provided via m_regex_posix.so, not availale  #
1594 #         on windows, no dependencies on other operating systems.     #
1595 #                                                                     #
1596 #<filteropts engine="glob">                                           #
1597 #                                                                     #
1598 # Your choice of regex engine must match on all servers network-wide.
1599 #
1600 #-#-#-#-#-#-#-#-#-#-#-  FILTER  CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#-#
1601 #                                                                     #
1602 # Optional - If you specify to use the m_filter module, then          #
1603 # specfiy below the path to the filter.conf file, or define some      #
1604 # <filter> tags.                                                      #
1605 #                                                                     #
1606 #<include file="filter.conf">
1607
1608 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1609 # Foobar module: does nothing - historical relic
1610 #<module name="m_foobar.so">
1611
1612 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1613 # Gecosban: Implements extended ban r:, which stops anyone matching
1614 # a mask like +b r:*realname?here* from joining a channel.
1615 <module name="m_gecosban.so">
1616
1617 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1618 # GeoIP module: Allows the server admin to ban users by country code.
1619 #<module name="m_geoip.so">
1620 #
1621 #-#-#-#-#-#-#-#-#-#-#-#  GEOIP CONFIGURATION  #-#-#-#-#-#-#-#-#-#-#-#-#
1622 #                                                                     #
1623 # <geoip banunknown="false">                                          #
1624 #                                                                     #
1625 # Set this value to true or yes to block unknown IP ranges which are  #
1626 # not in the database (usually LAN addresses, localhost, etc)         #
1627 #                                                                     #
1628 # <geoban country="TR" reason="This country not permitted">           #
1629 #                                                                     #
1630 # Use one or more of these tags to ban countries by country code.     #
1631 # The country code must be in capitals and should be an ISO country   #
1632 # code such as TR, GB, or US.                                         #
1633
1634 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1635 # Globops module: gives /GLOBOPS and SNOMASK +g
1636 # This module is oper-only.
1637 # To use, GLOBOPS must be in one of your oper class blocks.
1638 <module name="m_globops.so">
1639
1640 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1641 # Global load module: Allows loading and unloading of modules network-
1642 # wide (USE WITH EXTREME CAUTION!)
1643 # This module is oper-only and provides /gloadmodule, /gunloadmodule
1644 # and /greloadmodule.
1645 # To use, GLOADMODULE, GUNLOADMODULE and GRELOADMODULE
1646 # must be in one of your oper class blocks.
1647 #<module name="m_globalload.so">
1648
1649 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1650 # HELPOP module: Provides the /HELPOP command
1651 #<module name="m_helpop.so">
1652 #
1653 #-#-#-#-#-#-#-#-#-#-#-#-  HELPOP  CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#
1654 #                                                                     #
1655 # Optional - If you specify to use the m_helpop.so module, then       #
1656 # specify below the path to the helpop.conf file, or if you like to   #
1657 # make a mess, define your helpop tags in this conf.                  #
1658 #                                                                     #
1659 #<include file="helpop.conf">
1660
1661 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1662 # HIDECHANS module: Allows opers to hide their channels list from non-
1663 # opers by setting user mode +I on themselves.
1664 <module name="m_hidechans.so">
1665 #
1666 # HIDECHANS can optionally prevent opers from seeing channels on a +I
1667 # user, for more privacy if set to true.
1668 # This setting is not recommended for most mainstream networks.
1669 <hidechans affectsopers="false">
1670
1671 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1672 # HIDEOPER module: Allows opers to hide their oper status from non-
1673 # opers by setting user mode +H on themselves.
1674 # This module is oper-only.
1675 <module name="m_hideoper.so">
1676
1677 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1678 # Hostchange module: Allows a different style of cloaking
1679 #<module name="m_hostchange.so">
1680 #
1681 #-#-#-#-#-#-#-#-#-#-#-  HOSTCHANGE  CONFIGURATION  -#-#-#-#-#-#-#-#-#-#
1682 #                                                                     #
1683 # Optional - If you choose to use the m_hostchange.so module.         #
1684 # Config Help -  See http://www.inspircd.org/wiki/Host_Changer_Module #
1685 #                                                                     #
1686 #<host suffix="polarbears.org" separator="." prefix="">
1687 #<hostchange mask="*@fbi.gov" action="addnick">
1688 #<hostchange mask="*r00t@*" action="suffix">
1689 #<hostchange mask="a@b.com" action="set" value="blah.blah.blah">
1690 #<hostchange mask="localhost" ports="7000,7001,7005-7007" action="set" value="blahblah.foo">
1691
1692 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1693 # httpd module: Provides http server support for InspIRCd
1694 #<module name="m_httpd.so">
1695 #
1696 #-#-#-#-#-#-#-#-#-#-#-#-  HTTPD   CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#
1697 #
1698 # Optional - If you choose to use the m_httpd.so module,  then you must
1699 # specify the port number and other details of your http server:
1700 #
1701 #<http ip="192.168.1.10" host="brainwave" port="32006"
1702 #      index="/home/brain/inspircd/http/index.html">
1703 #
1704 # You may have as many of these tags as you wish, each with a different
1705 # IP, port, host or index file. Each one will act as an independent
1706 # HTTP server.
1707 #
1708
1709 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1710 # http ACL module: Provides access control lists for m_httpd dependent
1711 # modules. Use this module to restrict pages by IP address and by
1712 # password.
1713 #
1714 #<module name="m_httpd_acl.so">
1715 #
1716 #-#-#-#-#-#-#-#-#-#-#-#- HTTPD ACL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1717 #
1718 # Restrict access to the m_httpd_stats module to all but the local
1719 # network and when the correct password is specified:
1720 #
1721 # <httpdacl path="/stats*" types="password,whitelist"
1722 #    username="secretstuff" password="mypasshere" whitelist="127.0.0.*,10.*">
1723 #
1724 # Deny all connections to all but the main index page:
1725 #
1726 # <httpdacl path="/*" types="blacklist" blacklist="*">
1727 #
1728
1729 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1730 # http config module: Allows the server's configuration to be viewed
1731 # over HTTP. Requires m_httpd.so to be loaded for it to function.
1732 #<module name="m_httpd_config.so">
1733
1734 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1735 # http stats module: Provides basic stats pages over HTTP
1736 # Requires m_httpd.so to be loaded for it to function.
1737 #<module name="m_httpd_stats.so">
1738 #
1739 #-#-#-#-#-#-#-#-#-#-#-#- HTTPD STATS CONFIGURATION -#-#-#-#-#-#-#-#-#-#
1740 #
1741 #<httpstats stylesheet="http://remote.style/sheet.css">
1742 #
1743
1744 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1745 # Ident: Provides RFC 1413 ident lookup support
1746 # When this module is loaded <connect:allow> tags may have an optional
1747 # useident="yes|no" boolean value, determining whether or not to lookup
1748 # ident on users matching that connect tag.
1749 <module name="m_ident.so">
1750 #
1751 #-#-#-#-#-#-#-#-#-#-#-#-   IDENT CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#
1752 #                                                                     #
1753 # Optional - If you are using the m_ident.so module, then you can     #
1754 # specify the timeout for ident lookups here. If not defined, it will #
1755 # default to one second. This is a non-blocking timeout which holds   #
1756 # the user in a 'connecting' state until the lookup is complete.      #
1757 # The bind value indicates which IP to bind outbound requests to.     #
1758 #                                                                     #
1759 <ident timeout="5" bind="">
1760
1761 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1762 # Invite except module: Adds support for channel invite exceptions (+I)
1763 <module name="m_inviteexception.so">
1764
1765 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1766 # Invisible module - Adds support for usermode +Q (quiet) which lets an
1767 # oper go 'invisible' similar to unrealircd 3.1's +I mode. Note that
1768 # opers are still able to see invisible users, and if an oper with +Q
1769 # deopers, they will become visible.
1770 #
1771 # IMPORTANT NOTE: To allow this mode to be used by a type of oper, you
1772 # must first add the value canquiet="yes" to that oper's type tag.
1773 #
1774 # This module is oper-only.
1775 #
1776 <module name="m_invisible.so">
1777
1778 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1779 # Join flood module: Adds support for join flood protection (+j)
1780 <module name="m_joinflood.so">
1781
1782 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1783 # Jump Server module: Adds support for the RPL_REDIR numeric
1784 # This module is oper-only.
1785 # To use, JUMPSERVER must be in one of your oper class blocks.
1786 <module name="m_jumpserver.so">
1787
1788 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1789 # Anti-Auto-Rejoin: Adds support for prevention of auto-rejoin (+J)
1790 <module name="m_kicknorejoin.so">
1791
1792 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1793 # Knock module: adds the /KNOCK command and +K channel mode
1794 <module name="m_knock.so">
1795
1796 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1797 # LDAP authentication module: Adds the ability to authenticate users  #
1798 # via LDAP. This is an extra module which must be enabled explicitly  #
1799 # by symlinking it from modules/extra, and requires the OpenLDAP libs #
1800 #                                                                     #
1801 #<module name="m_ldapauth.so">                                        #
1802 #                                                                     #
1803 # Configuration:                                                      #
1804 #                                                                     #
1805 # <ldapauth baserdn="ou=People,dc=brainbox,dc=cc"                     #
1806 #           attribute="uid"                                           #
1807 #           server="ldap://brainwave.brainbox.cc"                     #
1808 #           allowpattern="Guest*"                                     #
1809 #           killreason="Access denied"                                #
1810 #           searchscope="subtree"                                     #
1811 #           binddn="cn=Manager,dc=brainbox,dc=cc"                     #
1812 #           bindauth="mysecretpass"                                   #
1813 #           verbose="yes">                                            #
1814 #                                                                     #
1815 # The baserdn indicates the base DN to search in for users. Usually   #
1816 # this is 'ou=People,dc=yourdomain,dc=yourtld'.                       #
1817 #                                                                     #
1818 # The attribute value indicates the attribute which is used to locate #
1819 # a user account by name. On POSIX systems this is usually 'uid'.     #
1820 #                                                                     #
1821 # The server parameter indicates the LDAP server to connect to. The   #
1822 # ldap:// style scheme before the hostname proper is MANDITORY.       #
1823 #                                                                     #
1824 # The allowpattern value allows you to specify a wildcard mask which  #
1825 # will always be allowed to connect regardless of if they have an     #
1826 # account, for example guest users.                                   #
1827 #                                                                     #
1828 # Killreason indicates the QUIT reason to give to users if they fail  #
1829 # to authenticate.                                                    #
1830 #                                                                     #
1831 # The searchscope value indicates the subtree to search under. On our #
1832 # test system this is 'subtree'. Your mileage may vary.               #
1833 #                                                                     #
1834 # Setting the verbose value causes an oper notice to be sent out for  #
1835 # every failed authentication to the server, with an error string.    #
1836 #                                                                     #
1837 # The binddn and bindauth indicate the DN to bind to for searching,   #
1838 # and the password for the distinguished name. Some LDAP servers will #
1839 # allow anonymous searching in which case these two values do not     #
1840 # need defining, otherwise they should be set similar to the examples #
1841 # above.                                                              #
1842
1843 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1844 # Lock server module: Adds /LOCKSERV and /UNLOCKSERV commands that is #
1845 # used to temporarily close/open for new connections to the server.   #
1846 # These commands require OPER status and that the LOCKSERV UNLOCKSERV #
1847 # are specified in a <class> tag that the oper is part of. This is so #
1848 # you can control who has access to this possible dangerous command.  #
1849 # If your server is locked and you got disconnected, do a REHASH from #
1850 # shell to open up again.
1851 #
1852 # This module is oper-only.
1853 #
1854 <module name="m_lockserv.so">
1855
1856 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1857 # Msg flood module: Adds message/notice flood protection (+f)
1858 <module name="m_messageflood.so">
1859
1860 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1861 # MsSQL module: Allows other SQL modules to access MS SQL Server
1862 # through a unified API. You must copy the source for this module
1863 # from the directory src/modules/extra, plus the file m_sqlv2.h
1864 #<module name="m_mssql.so">
1865 #
1866 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#-#
1867 #                                                                     #
1868 # m_mssql.so is more complex than described here, see wiki for more   #
1869 # info http://www.inspircd.org/wiki/SQLServer_Service_Provider_Module #
1870 #
1871 #<database name="db" username="user" password="pass" hostname="localhost" id="db1">
1872
1873 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1874 # MySQL module: Allows other SQL modules to access MySQL databases
1875 # through a unified API. You must copy the source for this module
1876 # from the directory src/modules/extra, plus the file m_sqlv2.h
1877 #<module name="m_mysql.so">
1878 #
1879 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#-#
1880 #                                                                     #
1881 # m_mysql.so is more complex than described here, see the wiki for    #
1882 # more: http://www.inspircd.org/wiki/SQL_Service_Provider_Module      #
1883 #
1884 #<database name="mydb" username="myuser" password="mypass" hostname="localhost" id="my_database2">
1885
1886 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1887 # NAMESX module: Provides support for the NAMESX extension which allows
1888 # clients to see all the prefixes set on a user without getting confused.
1889 # This is supported by mIRC, x-chat, klient, and maybe more.
1890 <module name="m_namesx.so">
1891
1892 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1893 # Nickchange flood protection module: Allows up to X nick changes in Y seconds.
1894 # Provides channel mode +F.
1895 <module name="m_nickflood.so">
1896
1897 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1898 # Nicklock module: Let opers change a user's nick and then stop that
1899 # user from changing their nick again.
1900 # This module is oper-only.
1901 # To use, NICKLOCK and NICKUNLOCK must be in one of your oper class blocks.
1902 <module name="m_nicklock.so">
1903
1904 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1905 # No ctcp module: Adds the channel mode +C to block CTCPs
1906 <module name="m_noctcp.so">
1907
1908 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1909 # No kicks module: Adds the +Q channel mode
1910 <module name="m_nokicks.so">
1911
1912 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1913 # No nicks module: Adds the +N channel mode, as well as the +b N:
1914 # extended bantype. +N stops all users from changing their nick,
1915 # the +b N: extban stops anyone from matching a +b N:nick!user@host
1916 # mask from changing their nick.
1917 <module name="m_nonicks.so">
1918
1919 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1920 # No Notice module: adds the channel mode +T
1921 <module name="m_nonotice.so">
1922
1923 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1924 # Oper channels mode: Adds the +O channel mode
1925 # This module is oper-only.
1926 <module name="m_operchans.so">
1927
1928 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1929 # Oper flood module: Removes flood limits from users upon opering up
1930 # This module is oper-only.
1931 <module name="m_operflood.so">
1932
1933 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1934 # Oper invex/extban module: Adds +beI type O, to ban, exempt, and invex
1935 # given oper type masks.
1936 # e.g, /mode #channel +iI O:* is equivilant to chmode +O, but you
1937 # may also, e.g. /mode #channel +iI O:AdminTypeOnly to only allow admins.
1938 # +be work in a similar fashion.
1939 # This module is oper-only.
1940 #
1941 <module name="m_operinvex.so">
1942
1943 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1944 # Oper Join module: Auto-joins opers to a channel upon oper-up
1945 # This module is oper-only. For the user equivalent, see m_conn_join.
1946 <module name="m_operjoin.so">
1947 #
1948 #-#-#-#-#-#-#-#-#-#-#   OPERJOIN CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#
1949 #                                                                     #
1950 # If you are using the m_operjoin.so module, specify options here:    #
1951 #                                                                     #
1952 # channel     -      The channel name to join, can also be a comma    #
1953 #                    seperated list eg. "#channel1,#channel2".        #
1954 #                                                                     #
1955 # override    -      Lets the oper join walking thru any modes that   #
1956 #                    might be set, even bans. Use "yes" or "no".      #
1957 #                                                                     #
1958 <operjoin channel="#opers" override="no">
1959 #
1960 # Alternatively you can use the autojoin="channellist" in a <type>    #
1961 # tag to set specific autojoins for a type of oper, for example:      #
1962 #
1963 #<type name="Helper" autojoin="#help" classes="...">
1964
1965 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1966 # Oper log module: Logs all oper commands to the ircd log at default
1967 # loglevel.
1968 # This module is oper-only.
1969 <module name="m_operlog.so">
1970
1971 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1972 # Oper MOTD module: Provides support for seperate message of the day
1973 # on oper-up
1974 # This module is oper-only.
1975 #<module name="m_opermotd.so">
1976 #
1977 #-#-#-#-#-#-#-#-#-#-#   OPERMOTD CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#
1978 #                                                                     #
1979 # If you are using the m_opermotd.so module, specify the motd here    #
1980 #                                                                     #
1981 #<opermotd file="oper.motd">
1982
1983 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1984 # Override module: Adds support for oper override
1985 # This module is oper-only.
1986 <module name="m_override.so">
1987 #
1988 #-#-#-#-#-#-#-#-#-#-#   OVERRIDE CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#
1989 #                                                                     #
1990 # m_override.so is too complex it describe here, see the wiki:        #
1991 # http://www.inspircd.org/wiki/Oper_Override_Module                   #
1992
1993 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1994 # Oper levels module: Gives each oper a level and prevents
1995 # actions being taken against higher level opers
1996 # Specify the level as the 'level' parameter of the <type> tag
1997 # # This module is oper-only.
1998 #<module name="m_operlevels.so">
1999
2000 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2001 # Oper modes module: Allows you to specify modes to add/remove on oper
2002 # Specify the modes as the 'modes' parameter of the <type> tag
2003 # and/or as the 'modes' parameter of the <oper> tag.
2004 # This module is oper-only. For the user equivalent, see m_conn_umodes
2005 <module name="m_opermodes.so">
2006
2007 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2008 # Oper password hash module: Allows hashed oper passwords
2009 # Relies on the module m_md5.so and/or m_sha256.so being loaded before
2010 # m_password_hash.so in the configuration file.
2011 # This module is oper-only.
2012 <module name="m_password_hash.so">
2013 #
2014 #-#-#-#-#-#-#-#-#-#-# OPER HASH CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#
2015 #
2016 # To use this module, you must define a hash type for each oper's
2017 # password you want to hash. For example:
2018 #
2019 #     <oper name="Brain"
2020 #           host="ident@dialup15.isp.com"
2021 #           hash="sha256"
2022 #           password="a41d730937a53b79f788c0ab13e9e1d5"
2023 #           type="NetAdmin">
2024 #
2025 # The types of hashing available vary depending on which hashing modules
2026 # you load, but usually if you load m_sha256.so and m_md5.so, both md5
2027 # and sha256 type hashing will be available (the most secure of which
2028 # is SHA256).
2029
2030 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2031 # Permanent Channels module: Channels with the permanent channels mode
2032 # will remain open even after everyone else has left the channel, and
2033 # therefore keep things like modes, ban lists and topic. Permanent
2034 # channels -may- need support from your Services package to function
2035 # properly with them. This adds channel mode +P.
2036 # This module is oper-only.
2037 <module name="m_permchannels.so">
2038 #
2039 # You may also create channels on startup by using the <permchannels> block.
2040 #<permchannels channel="#opers" modes="is" topic="Opers only.">
2041
2042 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2043 # PostgreSQL module: Allows other SQL modules to access PgSQL databases
2044 # through a unified API. You must copy the source for this module
2045 # from the directory src/modules/extra, plus the file m_sqlv2.h
2046 #<module name="m_pgsql.so">
2047 #
2048 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#-#
2049 #                                                                     #
2050 # m_pgsql.so is more complex than described here, see the wiki for    #
2051 # more: http://www.inspircd.org/wiki/SQL_Service_Provider_Module      #
2052 #
2053 #<database name="mydb" username="myuser" password="mypass" hostname="localhost" id="my_database" ssl="no">
2054
2055 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2056 # Muteban: Implements extended ban m:, which stops anyone matching
2057 # a mask like +b m:nick!user@host from speaking on channel.
2058 <module name="m_muteban.so">
2059 #
2060
2061 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2062 # Random Quote module: provides a random quote on connect.
2063 # NOTE: Some of these may mimic fatal errors and confuse users and
2064 # opers alike! - BEWARE!
2065 #<module name="m_randquote.so">
2066 #
2067 #-#-#-#-#-#-#-#-#-#-  RANDOMQUOTES CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
2068 #                                                                     #
2069 # Optional - If you specify to use the m_randquote.so module, then    #
2070 # specify below the path to the randquotes.conf file.                 #
2071 #                                                                     #
2072 #<randquote file="randquotes.conf">
2073
2074 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2075 # Redirect module: Adds channel redirection (mode +L)
2076 <module name="m_redirect.so">
2077
2078 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2079 # Regular Expression Provider for Glob or wildcard (?/*) matching.
2080 # You must have at least 1 provider loaded to use m_filter or m_rline
2081 # modules. This module has no additional requirements, as it uses the
2082 # matching already present in InspIRCd core.
2083 #<module name="m_regex_glob.so">
2084
2085 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2086 # Regular Expression Provider for PCRE (Perl-Compatible Regular
2087 # Expressions). You need libpcre installed to compile and load this
2088 # module. You must have at least 1 provider loaded to use m_filter or
2089 # m_rline.
2090 #<module name="m_regex_pcre.so">
2091
2092 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2093 # Regular Expression Provider for POSIX Regular Expressions.
2094 # You shouldn't need any additional libraries on a POSIX-compatible
2095 # system (ie: any Linux, BSD, but not Windows). You must have at least
2096 # 1 provider loaded to use m_filter or m_rline.
2097 # On POSIX-compliant systems, regex syntax can be found by using the
2098 # command: 'man 7 regex'.
2099 #<module name="m_regex_posix.so">
2100
2101 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2102 # Regular Expression Provider for TRE Regular Expressions.
2103 # This is the same regular expression engine used by UnrealIRCd, so
2104 # if you are most familiar with the syntax of /spamfilter from there,
2105 # this is the provider you want. You need libtre installed in order
2106 # to compile and load this module.
2107 #<module name="m_regex_tre.so">
2108
2109 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2110 # Registered users only channel creation
2111 # Allows only registered users and opers to create new channels.
2112 #<module name="m_regonlycreate.so">
2113
2114 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2115 # Remove module: Adds the /REMOVE command which is a peaceful
2116 # alternative to /KICK
2117 <module name="m_remove.so">
2118
2119 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2120 # Restrict banned users module:
2121 # Disallows banned users on a channel from messaging the channel,
2122 # changing nick, or changing the topic, if loaded.
2123 <module name="m_restrictbanned.so">
2124
2125 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2126 # Restricted channels module: Allows only opers to create channels
2127 #<module name="m_restrictchans.so">
2128
2129 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2130 # Restrict message module: Allows users to only message opers
2131 #<module name="m_restrictmsg.so">
2132
2133 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2134 # Ban users through regular expression patterns
2135 #<module name="m_rline.so">
2136 #
2137 #-#-#-#-#-#-#-#-#-#-#-#- RLINE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
2138 #
2139 # If you wish to re-check a user when they change nickname (can be
2140 # useful under some situations, but *can* also use CPU with more users
2141 # on a server) then set the following configuration value:
2142 # Also, this is where you set what Regular Expression engine is to be
2143 # used. If you ever change it while running, all of your R-Lines will be
2144 # wiped. This is the regex engine used by all R-Lines set, and
2145 # m_regex_<engine>.so must be loaded, or rline will be nonfunctional
2146 # until you load it or change the engine to one that is loaded.
2147 #
2148 #<rline matchonnickchange="yes" engine="pcre">
2149 #
2150 # Generally, you will NOT want to use 'glob' here, as this turns
2151 # rline into just another gline. The exceptions are that rline will
2152 # always use the full nick!user@host realname string, rather than only
2153 # user@host, but beware that only the ? and * wildcards are available,
2154 # and are the only way to specify where the space can occur if you do
2155 # use glob. For this reason, is recommended to use a real regex engine
2156 # so that at least \s or [[:space:]] is available.
2157
2158 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2159 # JSON-RPC module: Encode and decode JSON-RPC requests for modules
2160 #<module name="m_rpc_json.so">
2161
2162 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2163 # RPC test module: A test of the RPC API
2164 #<module name="m_rpctest.so">
2165
2166 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2167 # Provide /LIST throttling (to prevent flooding) and /LIST safety to
2168 # prevent excess flood when the list is large.
2169 #<module name="m_safelist.so">
2170 #
2171 #-#-#-#-#-#-#-#-#-#-# SAFELIST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
2172 #
2173 # When using Safelist, you may set the following values;
2174 #
2175 # The first value, 'throttle', sets the amount of time in seconds a user
2176 # must wait between LIST commands. For example, if this is set to 60
2177 # (the default) then the user may not /LIST more than once a minute.
2178 # If not defined, the default value is 60 seconds.
2179 #
2180 # The second value, 'maxlisters', indicates the maximum number of users
2181 # which may be retrieving a LIST at once. It is not recommended you raise
2182 # this value, as increasing it too high can make your network vulnerable
2183 # to floodbots which waste your bandwidth and CPU time with LIST requests.
2184 #
2185 #<safelist throttle="60" maxlisters="50">
2186
2187 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2188 # SAJOIN module: Adds the /SAJOIN command
2189 # This module is oper-only.
2190 # To use, SAJOIN must be in one of your oper class blocks.
2191 <module name="m_sajoin.so">
2192
2193 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2194 # SAMODE module: Adds the oper /SAMODE command
2195 # This module is oper-only.
2196 # To use, SAMODE must be in one of your oper class blocks.
2197 <module name="m_samode.so">
2198
2199 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2200 # SANICK module: Allows opers to change user's nicks
2201 # This module is oper-only.
2202 # To use, SANICK must be in one of your oper class blocks.
2203 <module name="m_sanick.so">
2204
2205 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2206 # SAPART module: Adds the oper /SAPART command
2207 # This module is oper-only.
2208 # To use, SAPART must be in one of your oper class blocks.
2209 <module name="m_sapart.so">
2210
2211 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2212 # SAQUIT module: Adds the oper /SAQUIT command (abusable!!!)
2213 # This module is oper-only.
2214 # To use, SAQUIT must be in one of your oper class blocks.
2215 <module name="m_saquit.so">
2216
2217 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2218 # SASL authentication module: Provides support for IRC Authentication
2219 # Layer (aka: atheme SASL) via AUTHENTICATE.
2220 <module name="m_sasl.so">
2221
2222 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2223 # Secure list module: Prevent /LIST in the first minute of connection,
2224 # crippling most spambots and trojan spreader bots.
2225 <module name="m_securelist.so">
2226 #
2227 #-#-#-#-#-#-#-#-#-# SECURELIST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
2228 #                                                                     #
2229 # Securelist can be harmful to some irc search engines such as        #
2230 # netsplit.de and searchirc.com. To prevent securelist blocking these #
2231 # sites from listing, define exception tags as shown below:           #
2232 <securehost exception="*@*.searchirc.org">
2233 <securehost exception="*@*.netsplit.de">
2234 <securehost exception="*@echo940.server4you.de">
2235 #                                                                     #
2236 # Define the following variable to change how long a user must wait   #
2237 # before issuing a LIST. If not defined, defaults to 60 seconds.      #
2238 #                                                                     #
2239 <securelist waittime="30">
2240
2241 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2242 # Servprotect module: Provides support for Austhex style +k /
2243 # UnrealIRCD +S services mode
2244 #<module name="m_servprotect.so">
2245
2246 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2247 # See nicks module: Allow for SNOMASK +N which shows nick changes.
2248 # This module is oper-only.
2249 <module name="m_seenicks.so">
2250
2251 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2252 # Set Idle module: Adds a command for opers to change their
2253 # idle time (mainly a toy)
2254 # This module is oper-only.
2255 # To use, SETIDLE must be in one of your oper class blocks.
2256 <module name="m_setidle.so">
2257
2258 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2259 # Services support module: Adds several usermodes such as +R and +M
2260 # this module implements the 'identified' state via user mode +r, which
2261 # is similar to the DALnet and dreamforge systems.
2262 #
2263 # N O T E!!
2264 #  >>  This CAN NOT be used at the same time as m_services_account <<
2265 # N O T E!!
2266 # *** This module DOES NOT support Atheme services, please use ***
2267 # *** m_services_account if you are planning on using Atheme.  ***
2268 #<module name="m_services.so">
2269
2270 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2271 # Services support module: Adds several usermodes such as +R and +M
2272 # this module implements the 'identified' state via account names (AC)
2273 # and is similar in operation to the way asuka and ircu handle services.
2274 #
2275 # Also of note is that this module implements two extbans:
2276 # +b R: (stop matching account names from joining)
2277 # +b M: (stop matching account names from speaking)
2278 #
2279 # N O T E!!
2280 #  >>  This CAN NOT be used at the same time as m_services <<
2281 # N O T E!!
2282 #<module name="m_services_account.so">
2283
2284 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2285 # Sethost module: Adds the /SETHOST command
2286 # This module is oper-only.
2287 # To use, SETHOST must be in one of your oper class blocks.
2288 # See m_chghost for how to customise valid chars for hostnames
2289 <module name="m_sethost.so">
2290
2291 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2292 # Setident module: Adds the /SETIDENT command
2293 # This module is oper-only.
2294 # To use, SETIDENT must be in one of your oper class blocks.
2295 <module name="m_setident.so">
2296
2297 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2298 # SETNAME module: Adds the /SETNAME command
2299 # This module is oper-only.
2300 # To use, SETNAME must be in one of your oper class blocks.
2301 <module name="m_setname.so">
2302
2303 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2304 # Serverban: Implements extended ban s:, which stops anyone connected
2305 # to a server matching a mask like +b s:server.mask.here from joining.
2306 <module name="m_serverban.so">
2307
2308 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2309 # Show Whois module: Adds the +W usermode which allows opers
2310 # to see when they are whois'ed (can be annoying).
2311 # This module is oper-only.
2312 <module name="m_showwhois.so">
2313
2314 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2315 # Shun module: Provides the /shun command, which stops a user executing
2316 # most commands.
2317 # This module is oper-only.
2318 # To use, SHUN must be in one of your oper class blocks.
2319 <module name="m_shun.so">
2320 #
2321 # You may also configure which commands you wish a user to be able to
2322 # perform. It should be noted that if a shunned user issues QUIT or PART
2323 # then their message will be removed, as if they did not issue one.
2324 #
2325 # You may also (optionally) let the user know that their command was blocked.
2326 #<shun enabledcommands="PING PONG QUIT PART JOIN" notifyuser="yes">
2327
2328 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2329 # Spy module: Provides the ability to see the complete names list of
2330 # channels an oper is not a member of
2331 # This module is oper-only.
2332 <module name="m_spy.so">
2333
2334 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2335 # SSL channel mode module: Adds support for SSL-only channels (+z).
2336 # does not do anything useful without a working SSL module (see below)
2337 #<module name="m_sslmodes.so">
2338
2339 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2340 # Dummy ssl module: If you have other servers on your network which
2341 # have SSL, but your server does not have ssl enabled, you should load
2342 # this module, which will handle SSL metadata (e.g. the "Is using ssl"
2343 # field in the WHOIS information).
2344 #<module name="m_ssl_dummy.so">
2345
2346 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2347 # GnuTLS ssl module: Adds support for client-server SSL using GnuTLS,
2348 # if enabled. You must copy the source for this module from the directory
2349 # src/modules/extra, or answer 'yes' in ./configure when asked if you
2350 # want to enable this, or it will not load.
2351 #<module name="m_ssl_gnutls.so">
2352 #
2353 #-#-#-#-#-#-#-#-#-#-#-  GNUTLS CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#
2354 #                                                                     #
2355 # m_ssl_gnutls.so is too complex it describe here, see the wiki:      #
2356 # http://www.inspircd.org/wiki/GnuTLS_SSL_Module                      #
2357 #                                                                     #
2358 # NOTE: If you want to use this module to encrypt and sign your       #
2359 # server to server traffic, you MUST load it before m_spanningtree in #
2360 # your configuration file!                                            #
2361
2362 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2363 # SSL Info module: Allows users to retrieve information about other
2364 # user's peer SSL certificates and keys. This can be used by client
2365 # scripts to validate users. For this to work, one of m_ssl_gnutls.so
2366 # or m_ssl_openssl.so must be loaded. You must symlink the source for
2367 # this module from the directory src/modules/extra.
2368 #<module name="m_sslinfo.so">
2369
2370 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2371 # OpenSSL ssl module: Adds support for client-server SSL using OpenSSL,
2372 # if enabled. You must copy the source for this module from the directory
2373 # src/modules/extra, or answer 'yes' in ./configure when asked if you
2374 # want to enable this, or it will not load.
2375 #<module name="m_ssl_openssl.so">
2376 #
2377 #-#-#-#-#-#-#-#-#-#-#- OPENSSL CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#
2378 #                                                                     #
2379 # m_ssl_openssl.so is too complex it describe here, see the wiki:     #
2380 # http://www.inspircd.org/wiki/OpenSSL_SSL_Module                     #
2381 #                                                                     #
2382 # NOTE: If you want to use this module to encrypt and sign your       #
2383 # server to server traffic, you MUST load it before m_spanningtree in #
2384 # your configuration file!                                            #
2385
2386 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2387 # SSL Cert Oper module: Allows opers to oper up using the key fingerprint
2388 # stored within their SSL certificate and key pair.
2389 # When using this module, one of m_ssl_gnutls.so or m_ssl_openssl.so must
2390 # be loaded. An extra value should be added to enabled opers, which
2391 # is in the following format: fingerprint="<hash>". For more information,
2392 # see the example in the oper blocks.
2393 # This module is oper-only.
2394 #<module name="m_ssl_oper_cert.so">
2395
2396 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2397 # Strip colour module: Adds the channel mode +S
2398 <module name="m_stripcolor.so">
2399
2400 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2401 # SILENCE module: Adds support for /SILENCE
2402 <module name="m_silence.so">
2403 #
2404 # Configuration tags:
2405 #
2406 <silence maxentries="32">
2407 #
2408 # Sets the maximum number of entries on a users silence list.
2409
2410 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2411 # SQLite3 module: Allows other SQL modules to access SQLite3          #
2412 # databases through a unified API. You must link the source for this  #
2413 # module from the directory src/modules/extra to src/modules, plus    #
2414 # the file m_sqlv2.h                                                  #
2415 #<module name="m_sqlite3.so">
2416 #
2417 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#-#
2418 #                                                                     #
2419 # m_sqlite.so is more complex than described here, see the wiki for   #
2420 # more: http://www.inspircd.org/wiki/SQLite3_Service_Provider_Module  #
2421 #
2422 #<database hostname="/full/path/to/database.db" id="anytext">
2423
2424 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2425 # SQLutils module: Provides some utilities to SQL client modules, such
2426 # as mapping queries to users and channels. You must copy the source
2427 # for this module from the directory src/modules/extra/m_sqlutils.cpp
2428 # and src/modules/extra/m_sqlutils.h into /src/modules
2429 # Needed for, and loaded before: SQLauth and SQLoper
2430 #<module name="m_sqlutils.so">
2431
2432 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2433 # SQL authentication module: Allows IRCd connections to be tied into
2434 # a database table (for example a forum). You must copy the source for
2435 # this module from the directory src/modules/extra
2436 # Depends on the SQLutils module being loaded first.
2437 #<module name="m_sqlauth.so">
2438 #
2439 #-#-#-#-#-#-#-#-#-#-#- SQLAUTH CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#
2440 #                                                                     #
2441 # m_sqlauth.so is too complex it describe here, see the wiki:         #
2442 # http://www.inspircd.org/wiki/SQL_Authentication_Module              #
2443
2444 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2445 # SQL logging module: Allows you to log network-wide data for your
2446 # network in a fully normalised set of SQL tables. You must copy the
2447 # source for this module from the directory src/modules/extra
2448 #<module name="m_sqllog.so">
2449 #
2450 #-#-#-#-#-#-#-#-#-#-#-  SQLLOG CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#
2451 #                                                                     #
2452 # dbid       - Database ID to use (see m_sql)                         #
2453 #                                                                     #
2454 # See also: http://www.inspircd.org/wiki/SQL_Logging_Module           #
2455 #                                                                     #
2456 #<sqllog dbid="1">
2457
2458 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2459 # SQL oper module: Allows you to store oper credentials in an SQL table
2460 # You must copy the source for this module from the directory src/modules/extra
2461 # Depends on the SQLutils module being loaded first.
2462 #<module name="m_sqloper.so">
2463 #
2464 #-#-#-#-#-#-#-#-#-#-#- SQLOPER CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#
2465 #                                                                     #
2466 # dbid       - Database ID to use (see m_sql)                         #
2467 # hash       - Hashing provider to use for password hashing           #
2468 #                                                                     #
2469 # See also: http://www.inspircd.org/wiki/SQL_Oper_Storage_Module      #
2470 #                                                                     #
2471 #<sqloper dbid="1" hash="md5">
2472
2473 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2474 # SVSHold module: Implements SVSHOLD. Like Q:Lines, but can only be   #
2475 # added/removed by Services.                                          #
2476 #<module name="m_svshold.so">
2477
2478 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2479 # SWHOIS module: Allows you to add arbitary lines to user WHOIS.
2480 # This module is oper-only.
2481 # To use, SWHOIS must be in one of your oper class blocks.
2482 <module name="m_swhois.so">
2483
2484 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2485 # Taxonomy module: Adds the /TAXONOMY command, used to view all
2486 #                  metadata attached to a user.
2487 # This module is oper-only.
2488 # To use, TAXONOMY must be in one of your oper class blocks.
2489 <module name="m_taxonomy.so">
2490
2491 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2492 # Test command module: Does nothing significant. Read: pointless.
2493 #<module name="m_testcommand.so">
2494
2495 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2496 # Timed bans module: Adds timed bans and the /TBAN command
2497 # This module is oper-only.
2498 # To use, TBAN must be in one of your oper class blocks.
2499 <module name="m_timedbans.so">
2500
2501 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2502 # Test line module: Adds the /TLINE command, used to test how many
2503 # users a /GLINE or /ZLINE etc would match.
2504 # This module is oper-only.
2505 # To use, TLINE must be in one of your oper class blocks.
2506 <module name="m_tline.so">
2507
2508 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2509 # UHNAMES support module: Adds support for the IRCX style UHNAMES
2510 # extension, which displays ident and hostname in the names list for
2511 # each user, saving clients from doing a WHO on the channel. Note that
2512 # this module is not widely supported yet. If a client does not support
2513 # UHNAMES it will not enable it, this will not break incompatible
2514 # clients.
2515 <module name="m_uhnames.so">
2516
2517 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2518 # Uninvite module: Adds the /UNINVITE command which lets users remove
2519 # pending invites from channels without waiting for the user to join.
2520 <module name="m_uninvite.so">
2521
2522 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2523 # Userip module: Adds the /USERIP command
2524 # This module is oper-only.
2525 # To use, USERIP must be in one of your oper class blocks.
2526 <module name="m_userip.so">
2527
2528 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2529 # Vhost module: Adds the VHOST command which allows for adding virtual
2530 # hosts which are accessible using a username and password in the config.
2531 #<module name="m_vhost.so">
2532 #
2533 #-#-#-#-#-#-#-#-#-#-#- VHOST CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#-#
2534 #                                                                     #
2535 # user       - Username for the vhost.                                #
2536 #                                                                     #
2537 # pass       - Password for the vhost.                                #
2538 #                                                                     #
2539 # host       - Vhost to set.                                          #
2540 #
2541 #<vhost user="some_username" pass="some_password" host="some.host">
2542
2543 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2544 # Watch module: Adds the WATCH command, which is used by clients to
2545 # maintain notify lists.
2546 <module name="m_watch.so">
2547 #
2548 # Configuration tags:
2549 #
2550 <watch maxentries="32">
2551 #
2552 # Sets the maximum number of entries on a user's watch list.
2553
2554 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2555 # XLine database: Stores all *Lines (G/Z/K/R/any added by other modules)
2556 # in a file "xline.db" which can be re-loaded on restart. This is useful
2557 # for two reasons: it keeps bans so users may not evade them, and on
2558 # bigger networks, server connections will take less time as there will
2559 # be a lot less bans to apply - as most of them will already be there.
2560 <module name="m_xline_db.so">
2561
2562 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2563 # ZipLinks module: Adds support for zlib deflate on server to server
2564 # connections. Both ends of the connection must load this module.
2565 #
2566 #<module name="m_ziplink.so">
2567 #
2568 # To use this module, you must enable it as a transport type in your
2569 # <link> tags or <bind> tags using the transport name 'zip'.
2570 # See the documentation of <link> and <bind>, respectively.
2571 #
2572
2573
2574 #########################################################################
2575 #                                                                       #
2576 #                     - InspIRCd Development Team -                     #
2577 #                        http://www.inspircd.org                        #
2578 #                                                                       #
2579 #########################################################################