X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=docs%2Fmodules.conf.example;h=e987f48781523ee6b5ed689407231eec85f62868;hb=3af9c3f8950f864bcf9cdd56127cd4014827dece;hp=532073a18adc08df193812242e1bb6aecab8d3b8;hpb=d1f2a430501aec8bc893647dc1049b8499e1caf6;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/docs/modules.conf.example b/docs/modules.conf.example index 532073a18..e987f4878 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. @@ -217,18 +200,17 @@ # # Auditorium settings: # -# +# +# +# opvisible (auditorium-vis in exemptchanops): +# Show channel ops to all users +# opcansee (auditorium-see in exemptchanops): +# Allow ops to see all joins/parts/kicks in the channel +# opercansee: +# Allow opers (channels/auspex) to see see all joins/parts/kicks in the channel # -# showops: -# Setting this value to yes makes m_auditorium behave like unrealircd -# +u channel mode, e.g. ops see users joining, parting, etc, and users -# joining the channel see the ops. Without this flag, the mode acts -# like ircnet's +a (anonymous channels), showing only the user in the -# names list, and not even showing the ops in the list, or showing the -# ops that the user has joined. -# operoverride: -# Setting this value to yes makes m_auditorium affect the userlist for -# regular users only. Opers will view all users in the channel normally. +# Exemptchanops can be used to adjust the level at which users become visible or +# the level at which they can see the full membe list of the channel. #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Autoop module: Adds basic channel access controls via the +w listmode. @@ -283,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 # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# @@ -332,7 +314,7 @@ # specify some censor tags. See also: # # http://wiki.inspircd.org/Modules/censor # # -# +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # CGI:IRC module: Adds support for automatic host changing in CGI:IRC @@ -411,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. # @@ -625,12 +607,30 @@ # quitmsg - The message that users get if they attempt to # connect while the throttle is active. # -# bootwait - Amount of time to wait before enforcing the -# throttling when the server just booted. +# bootwait - Amount of time in seconds to wait before enforcing +# the throttling when the server just booted. # # +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Custom prefixes : allows for channel prefixes to be added. +# 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 +# letter The letter used for this mode. Required. +# prefix The prefix used for nicks with this mode. Not required. +# rank A numeric rank for this prefix, defining what permissions it gives +# VOICE_VALUE is 10000, HALFOP_VALUE is 20000, OP_VALUE is 30000 +# ranktoset The numeric rank required to set/unset this mode. Defaults to rank. +# depriv Can you remove the mode from yourself? Defaults to yes. +# +# +# +# + #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Custom title module: Adds the /TITLE command which allows for trusted # users to gain a custom whois line and a optional @@ -735,15 +735,6 @@ # modes are blockcaps, noctcp, blockcolor, nickflood, flood, censor, # # filter, regmoderated, nonick, nonotice, and stripcolor. # # # -# # -#-#-#-#-#-#-#-#-#-#- EXEMPTCHANOPS CONFIGURATION -#-#-#-#-#-#-#-#-#-# -# defaults - default exemptions. These can be added to or overridden # -# by the channel mode +X. Each item is of the form # -# [minstatus]:[mode] where you must have [minstatus] in # -# order to be able to bypass [mode]. # -# Use "*:blockcolor" to override a default exemption # -# - #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Filter module: Provides message filtering, similar to SPAMFILTER. @@ -774,7 +765,7 @@ # specfiy below the path to the filter.conf file, or define some # # tags. # # # -# +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Gecosban: Implements extended ban r:, which stops anyone matching @@ -782,7 +773,7 @@ # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# GeoIP module: Allows the server admin to ban users by country code. +# GeoIP module: Allows the server admin to match users by country code. # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_geoip.cpp # and run make install, then uncomment this module to enable it. # This module requires GeoIP to be installed on your system, @@ -790,18 +781,17 @@ # or check the InspIRCd wiki page for this module. # # -#-#-#-#-#-#-#-#-#-#-#-# GEOIP CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-# -# # -# # -# # -# Set this value to true or yes to block unknown IP ranges which are # -# not in the database (usually LAN addresses, localhost, etc) # -# # -# # -# # -# Use one or more of these tags to ban countries by country code. # -# The country code must be in capitals and should be an ISO country # -# code such as TR, GB, or US. # +# The actual allow/ban actions are done by connect classes, not by the +# GeoIP module. An example connect class to ban people from russia or +# turkey: +# +# +# +# The country code must be in capitals and should be an ISO country +# code such as TR, GB, or US. Unknown IPs (localhost, LAN IPs, etc) +# will be assigned the country code "UNK". Since connect classes are +# matched from top down, your deny classes must be above your allow +# classes for them to match. #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Globops module: gives /GLOBOPS and SNOMASK +g @@ -822,10 +812,6 @@ # Halfop module: Provides the +h (halfops) channel status mode. # -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Status prefix: Adds the channel status mode +V -# - #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # HELPOP module: Provides the /HELPOP command # @@ -836,12 +822,12 @@ # specify below the path to the helpop.conf file, or if you like to # # make a mess, define your helpop tags in this conf. # # # -# +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # HIDECHANS module: Allows opers to hide their channels list from non- # opers by setting user mode +I on themselves. -# +# # # HIDECHANS can optionally prevent opers from seeing channels on a +I # user, for more privacy if set to true. @@ -852,7 +838,7 @@ # HIDEOPER module: Allows opers to hide their oper status from non- # opers by setting user mode +H on themselves. # This module is oper-only. -# +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Hostchange module: Allows a different style of cloaking @@ -930,16 +916,8 @@ #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Invite except module: Adds support for channel invite exceptions (+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. -# -# +# Does a +I bypass channel +k in addition to +i? +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Join flood module: Adds support for join flood protection (+j) @@ -949,6 +927,8 @@ # Jump Server module: Adds support for the RPL_REDIR numeric # This module is oper-only. # To use, JUMPSERVER must be in one of your oper class blocks. +# If your server is redirecting new clients and you get disconnected, +# do a REHASH from shell to open up again. # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# @@ -980,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'. # # # @@ -1007,6 +989,10 @@ # 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. # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # LDAP oper configuration module: Adds the ability to authenticate # @@ -1034,7 +1020,7 @@ # These commands require OPER status and that the LOCKSERV UNLOCKSERV # # are specified in a tag that the oper is part of. This is so # # you can control who has access to this possible dangerous command. # -# If your server is locked and you got disconnected, do a REHASH from # +# If your server is locked and you get disconnected, do a REHASH from # # shell to open up again. # # This module is oper-only. @@ -1051,6 +1037,12 @@ # Msg flood module: Adds message/notice flood protection (+f) # +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# MLOCK module: Adds support for server-side enforcement of services +# side MLOCKs. Basically, this module suppresses any mode change that +# would likely be immediately bounced by services. +# + #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # MsSQL module: Allows other SQL modules to access MS SQL Server # through a unified API. You must copy the source for this module @@ -1065,7 +1057,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 @@ -1081,7 +1073,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 @@ -1269,13 +1261,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: @@ -1283,13 +1274,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 @@ -1304,11 +1297,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 @@ -1324,7 +1318,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 @@ -1574,8 +1568,8 @@ # showfromopers="yes"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Shun module: Provides the /shun command, which stops a user executing -# most commands. +# Shun module: Provides the /SHUN command, which stops a user from +# executing all except configured commands. # This module is oper-only. # To use, SHUN must be in one of your oper class blocks. # @@ -1589,12 +1583,6 @@ # You may also let SHUN affect opers (defaults to no). # -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Spy module: Provides the ability to see the complete names list of -# channels an oper is not a member of -# This module is oper-only. -# - #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # SSL channel mode module: Adds support for SSL-only channels (+z). # does not do anything useful without a working SSL module (see below) @@ -1648,7 +1636,7 @@ # your configuration file! # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Strip colour module: Adds the channel mode +S +# Strip color module: Adds the channel mode +S # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# @@ -1676,18 +1664,7 @@ # m_sqlite.so is more complex than described here, see the wiki for # # more: http://wiki.inspircd.org/Modules/sqlite3 # # -# - -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# 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 @@ -1704,23 +1681,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 @@ -1797,9 +1757,10 @@ # user - Username for the vhost. # # # # pass - Password for the vhost. # -# # -# hash - The hash for the specific user (optional) -# m_password_hash.so and a hashing module must be loaded for this to work +# # +# hash - The hash for the specific user (optional) # +# m_password_hash.so and a hashing module must be loaded # +# for this to work. # # # # host - Vhost to set. # # @@ -1825,20 +1786,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 +1794,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. # # # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#