X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=docs%2Fmodules.conf.example;h=b688882d084e8ecf3677a560de6a5b68f4328879;hb=2f8303334f2c5a62bcce47d39e8cf41208a9a296;hp=7975283ee6454429efc38b9686a8e60ad818c92d;hpb=d14b48f31beee0283cfefff2ff88dd645a9c80c6;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/docs/modules.conf.example b/docs/modules.conf.example index 7975283ee..b688882d0 100644 --- a/docs/modules.conf.example +++ b/docs/modules.conf.example @@ -13,10 +13,6 @@ # http://wiki.inspircd.org/Modules for a list of modules and # # each modules link for any additional conf tags they require. # # # -# You may use wildcards in a tag to load all modules which # -# match a glob pattern (e.g. m_sa????.so would load m_sajoin, # -# m_sapart, m_saquit and m_sanick) # -# # # ____ _ _____ _ _ ____ _ _ _ # # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | # # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | # @@ -24,13 +20,9 @@ # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) # # # # To link servers to InspIRCd, you MUST load the m_spanningtree # -# module. Since several features (like SSL server links) rely on # -# other modules being loaded before m_spanningtree, the module itself # -# is at the bottom of this file. DO NOT forget to load it. If you DO # -# NOT do this, server links will NOT work at all. ie. The ports will # -# NOT bind, and /connect will not work properly. This is by design, # -# to allow for the implementation of other linking protocols in # -# modules in the future. # +# module. If you don't do this, server links will NOT work at all. # +# This is by design, to allow for the implementation of other linking # +# protocols in modules in the future. # # # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# @@ -201,15 +193,6 @@ # To use, ALLTIME must be in one of your oper class blocks. # -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Antibear security module: Prevents 'bear.txt' based trojans from -# connecting to your network by sending them a numeric they can't handle. -# - -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Antibottler module: Labels bottler leech bots -# - #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Auditorium module: Adds channel mode +u which makes everyone else # except you in the channel invisible, used for large meetings etc. @@ -282,7 +265,7 @@ # capsmap="ABCDEFGHIJKLMNOPQRSTUVWXYZ! "> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Block colour module: Blocking colour-coded messages with cmode +c +# Block color module: Blocking color-coded messages with cmode +c # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# @@ -410,7 +393,7 @@ #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Channel Names module: Allows disabling channels which have certain -# characters in the channel name such as bold, colourcodes, etc which +# characters in the channel name such as bold, colorcodes, etc which # can be quite annoying and allow users to on occasion have a channel # that looks like the name of another channel on the network. # @@ -632,7 +615,8 @@ #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Custom prefixes : allows for channel prefixes to be added. -# This can replace m_chanprotect and m_halfop, except for interation with services +# This can replace m_chanprotect and m_halfop, except for services that +# recognise those modules by name # # # name The name of the mode, must be unique from other modes @@ -935,16 +919,6 @@ # Does a +I bypass channel +k in addition to +i? # -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Invisible module - Adds support for usermode +Q (quiet) which lets an -# oper go 'invisible' similar to unrealircd 3.1's +I mode. Note that -# opers are still able to see invisible users, and if an oper with +Q -# deopers, they will become visible. -# -# This module is oper-only and seen by many to be quite abusive. -# -# - #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Join flood module: Adds support for join flood protection (+j) # @@ -986,6 +960,8 @@ # bindauth="mysecretpass" # # verbose="yes"> # # # +# # +# # # The baserdn indicates the base DN to search in for users. Usually # # this is 'ou=People,dc=yourdomain,dc=yourtld'. # # # @@ -1013,6 +989,14 @@ # allow anonymous searching in which case these two values do not # # need defining, otherwise they should be set similar to the examples # # above. # +# # +# ldapwhitelist indicates that clients connecting from an IP in the # +# provided CIDR do not need to authenticate against LDAP. It can be # +# repeated to whitelist multiple CIDRs. # + +# ldapwhitelist indicates that clients connecting from the associated # +# CIDR do to authenticate against LDAP. It can be used multiple # +# times. # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # LDAP oper configuration module: Adds the ability to authenticate # @@ -1071,7 +1055,7 @@ # m_mssql.so is more complex than described here, see wiki for more # # info http://wiki.inspircd.org/Modules/mssql # # -# +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # MySQL module: Allows other SQL modules to access MySQL databases @@ -1087,7 +1071,7 @@ # m_mysql.so is more complex than described here, see the wiki for # # more: http://wiki.inspircd.org/Modules/mysql # # -# +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Named Modes module: This module allows for the display and set/unset @@ -1275,13 +1259,12 @@ cmd="PRIVMSG $nickrequired :IDENTIFY $pass"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Oper password hash module: Allows hashed oper passwords -# Relies on the module m_md5.so and/or m_sha256.so being loaded before -# m_password_hash.so in the configuration file. -# This module is oper-only. +# Password hash module: Allows hashed passwords to be used. +# To be useful, a hashing module like m_sha256.so also needs to be loaded. +# # # -#-#-#-#-#-#-#-#-#-#-# OPER HASH CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-# +#-#-#-#-#-#-#-#-#-# PASSWORD HASH CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-# # # To use this module, you must define a hash type for each oper's # password you want to hash. For example: @@ -1289,13 +1272,15 @@ # # -# The types of hashing available vary depending on which hashing modules -# you load, but usually if you load m_sha256.so and m_md5.so, both md5 -# and sha256 type hashing will be available (the most secure of which -# is SHA256). +# Starting from 2.0, you can use a more secure salted hash that prevents simply +# looking up the hash's value in a rainbow table built for the hash. +# hash="hmac-sha256" password="lkS1Nbtp$CyLd/WPQXizsbxFUTqFRoMvaC+zhOULEeZaQkUJj+Gg" +# +# Generate hashes using the /MKPASSWD command on the server. Don't run it on a +# server you don't trust with your password. #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Permanent Channels module: Channels with the permanent channels mode @@ -1310,11 +1295,12 @@ # whenever +P is set, unset, or the topic/modes on a +P channel is changed. # If you want to do this, set the filename below, and uncomment the include. # -# -# +# +# # # You may also create channels on startup by using the block. -# +# Don't forget to set them +P in the modes, or they won't stay permanent. +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # PostgreSQL module: Allows other SQL modules to access PgSQL databases @@ -1330,7 +1316,7 @@ # m_pgsql.so is more complex than described here, see the wiki for # # more: http://wiki.inspircd.org/Modules/pgsql # # -# +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Muteban: Implements extended ban m:, which stops anyone matching @@ -1648,7 +1634,7 @@ # your configuration file! # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Strip colour module: Adds the channel mode +S +# Strip color module: Adds the channel mode +S # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# @@ -1678,17 +1664,6 @@ # # -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# SQLutils module: Provides some utilities to SQL client modules, such -# as mapping queries to users and channels. You must copy the source -# for this module from the directory src/modules/extra/m_sqlutils.cpp -# and src/modules/extra/m_sqlutils.h into /src/modules -# Needed for, and loaded before: SQLauth and SQLoper -# This modules is in extras. Re-run configure with: ./configure --enable-extras=m_sqlutils.cpp -# and run make install, then uncomment this module to enable it. -# -# - #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # SQL authentication module: Allows IRCd connections to be tied into # a database table (for example a forum). You must copy the source for @@ -1704,23 +1679,6 @@ # m_sqlauth.so is too complex it describe here, see the wiki: # # http://wiki.inspircd.org/Modules/sqlauth # -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# SQL logging module: Allows you to log network-wide data for your -# network in a fully normalised set of SQL tables. You must copy the -# source for this module from the directory src/modules/extra -# This modules is in extras. Re-run configure with: ./configure --enable-extras=m_sqllog.cpp -# and run make install, then uncomment this module to enable it. -# -# -# -#-#-#-#-#-#-#-#-#-#-#- SQLLOG CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-# -# # -# dbid - Database ID to use (see m_sql) # -# # -# See also: http://wiki.inspircd.org/Modules/sqllog # -# # -# - #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # SQL oper module: Allows you to store oper credentials in an SQL table # You must copy the source for this module from the directory src/modules/extra @@ -1825,20 +1783,6 @@ # be a lot less bans to apply - as most of them will already be there. # -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# ZipLinks module: Adds support for zlib deflate on server to server -# connections. Both ends of the connection must load this module. -# This modules is in extras. Re-run configure with: ./configure --enable-extras=m_ziplink.cpp -# and run make install, then uncomment this module to enable it. -# -# -# -# To use this module, you must enable it as a ssl type in your -# tags or tags using the ssl name 'ziplinks'. -# See the documentation of and , respectively. -# - - #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # ____ _ _____ _ _ ____ _ _ _ # # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | # @@ -1847,13 +1791,9 @@ # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) # # # # To link servers to InspIRCd, you MUST load the m_spanningtree # -# module. Since several features (like SSL server links) rely on # -# other modules being loaded before m_spanningtree, the module itself # -# is at the bottom of this file. DO NOT forget to load it. If you DO # -# NOT do this, server links will NOT work at all. ie. The ports will # -# NOT bind, and /connect will not work properly. This is by design, # -# to allow for the implementation of other linking protocols in # -# modules in the future. # +# module. If you don't do this, server links will NOT work at all. # +# This is by design, to allow for the implementation of other linking # +# protocols in modules in the future. # # # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#