# specify some censor tags. See also: #
# http://wiki.inspircd.org/Modules/censor #
#
-#<include file="conf/censor.conf">
+#<include file="conf/examples/censor.conf.example">
#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
# CGI:IRC module: Adds support for automatic host changing in CGI:IRC
# in a channel matching a mask like +b j:#channel*mask from joining.
#<module name="m_channelban.so">
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# Chanprotect module: gives +q and +a channel modes
-#<module name="m_chanprotect.so">
-
-<chanprotect
- # noservices: With this set to yes, when a user joins a empty channel,
- # the server will set +q on them. If set to no, it will only set +o
- # on them until they register the channel.
- noservices="no"
-
- # qprefix: Prefix (symbol) to use for +q users.
- qprefix="~"
-
- # aprefix: Prefix (symbol) to use for +a users.
- aprefix="&"
-
- # deprotectself: If this value is set (true, yes or 1), it will allow
- # +a and +q users to remove the +a and +q from themselves, otherwise,
- # the status will have to be removed by services.
- deprotectself="yes"
-
- # deprotectothers: If this value is set to yes, true, or 1, then any
- # user with +q or +a may remove the +q or +a from other users.
- deprotectothers="yes">
-
-
#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
# Check module: gives /check
# Check is useful for looking up information on channels,
#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
# Cloaking module: Adds usermode +x and cloaking support.
-# Relies on the module m_md5.so being loaded before m_cloaking.so in
-# the configuration file.
+# Relies on the module m_md5.so being loaded.
# To use, you should enable m_conn_umodes and add +x as
# an enabled mode. See the m_conn_umodes module for more information.
#<module name="m_cloaking.so">
#
#-#-#-#-#-#-#-#-#-#-#- CLOAKING CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
# #
-# If you specify the m_cloaking.so module as above, you must define #
-# cloak keys, and optionally a cloak prefix as shown below. The cloak #
-# keys must be shared across the network for correct cloaking. #
+# To use m_cloaking, you must define a cloak key, and optionally a #
+# cloak prefix as shown below. The cloak key must be shared across #
+# the network for correct cloaking. #
# #
-# There are four methods of cloaking: #
+# There are two methods of cloaking: #
# #
# half Cloak only the "unique" portion of a host; show #
# the last 2 parts of the domain, /16 subnet of IPv4 #
# full Cloak the users completely, using three slices for #
# common CIDR bans (IPv4: /16, /24; IPv6: /48, /64) #
# #
-# These methods use a single key that can be any length of text. #
+# The methods use a single key that can be any length of text. #
# An optional prefix may be specified to mark cloaked hosts. #
-# #
-# The following methods are maintained for backwards compatibility; #
-# they are slightly less secure, and always hide unresolved IPs #
-# #
-# compat-host InspIRCd 1.2-compatible host-based cloaking #
-# compat-ip InspIRCd 1.2-compatible ip-always cloaking #
-# #
-# You must specify key1, key2, key3, key4 for the compat cloaking #
-# modes; the values must be less than 0x80000000 and should be picked #
-# at random. Prefix is mandatory, will default to network name if not #
-# specified, and will always have a "-" appended. #
#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
#
#<cloak mode="half"
# Connection throttle module. Configuration:
#<module name="m_connflood.so">
#
-#-#-#-#-#-#-#-#-#-#-#- CONTHROTTLE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
+#-#-#-#-#-#-#-#-#-#-#- CONNTHROTTLE CONFIGURATION -#-#-#-#-#-#-#-#-#-#
# seconds, maxconns - Amount of connections per <seconds>.
#
# timeout - Time to wait after the throttle was activated
# quitmsg="Throttled" bootwait="10">
#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# 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
+# Custom prefixes: allows for channel prefixes to be added.
#<module name="m_customprefix.so">
#
# name The name of the mode, must be unique from other modes
# ranktoset The numeric rank required to set/unset this mode. Defaults to rank.
# depriv Can you remove the mode from yourself? Defaults to yes.
#<customprefix name="founder" letter="q" prefix="~" rank="50000" ranktoset="50000">
-#<customprefix name="admin" letter="a" prefix="&" rank="40000" ranktoset="50000">
+#<customprefix name="admin" letter="a" prefix="&" rank="40000" ranktoset="50000">
#<customprefix name="halfop" letter="h" prefix="%" rank="20000" ranktoset="30000">
#<customprefix name="halfvoice" letter="V" prefix="-" rank="1" ranktoset="20000">
# specfiy below the path to the filter.conf file, or define some #
# <filter> tags. #
# #
-#<include file="conf/filter.conf">
+#<include file="conf/examples/filter.conf.example">
#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
# Gecosban: Implements extended ban r:, which stops anyone matching
# must be in one of your oper class blocks.
#<module name="m_globalload.so">
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# Halfop module: Provides the +h (halfops) channel status mode.
-#<module name="m_halfop.so">
-
#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
# HELPOP module: Provides the /HELPOP command
#<module name="m_helpop.so">
# specify below the path to the helpop.conf file, or if you like to #
# make a mess, define your helpop tags in this conf. #
# #
-#<include file="conf/inspircd.helpop-full.example">
+#<include file="conf/examples/inspircd.helpop-full.example">
#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
# HIDECHANS module: Allows opers to hide their channels list from non-
# LDAP authentication module: Adds the ability to authenticate users #
# via LDAP. This is an extra module which must be enabled explicitly #
# by symlinking it from modules/extra, and requires the OpenLDAP libs #
-# This modules is in extras. Re-run configure with: ./configure --enable-extras=m_ldapauth.cpp
-# and run make install, then uncomment this module to enable it. #
+# This modules is in extras. To enable it, Re-run configure with: #
+# ./configure --enable-extras=m_ldapauth.cpp #
+# and run make install, then uncomment this module. #
# #
#<module name="m_ldapauth.so"> #
# #
# searchscope="subtree" #
# binddn="cn=Manager,dc=brainbox,dc=cc" #
# bindauth="mysecretpass" #
-# verbose="yes"> #
+# verbose="yes" #
+# host="$uid.$ou.inspircd.org"> #
# #
# <ldapwhitelist cidr="10.42.0.0/16"> #
# #
# in which case the list will act as an OR list, that is, the #
# authentication will succeed if any of the requirements in the list #
# is satisfied. #
+# #
+# host allows you to change the displayed host of users connecting #
+# from ldap. The string supplied takes formatters which are replaced #
+# from the DN. For instance, if your DN looks like: #
+# uid=w00t,ou=people,dc=inspircd,dc=org, then the formatters uid, ou #
+# and dc will be available to you. If a key is given multiple times #
+# in the DN, the last appearance will take precedence. #
#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
# LDAP oper configuration module: Adds the ability to authenticate #
# server="ldap://brainwave.brainbox.cc"
# searchscope="subtree"
# binddn="cn=Manager,dc=brainbox,dc=cc"
-# bindauth="mysecretpass">
+# bindauth="mysecretpass"
+# attribute="uid">
# #
# Available configuration items are identical to the same items in #
-# m_ldapauth above. #
+# m_ldapauth above (except for the verbose setting, that is only #
+# supported in m_ldapauth). #
+# Please always specify a password in your <oper> tags even if the #
+# opers are to be authenticated via LDAP, so in case this module is #
+# not loaded the oper accounts are still protected by a password. #
#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
# Lock server module: Adds /LOCKSERV and /UNLOCKSERV commands that is #
#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
# MsSQL module: Allows other SQL modules to access MS SQL Server
-# through a unified API. You must copy the source for this module
-# from the directory src/modules/extra, plus the file m_sqlv2.h
+# through a unified API.
# This modules is in extras. Re-run configure with: ./configure --enable-extras=m_mssql.cpp
# and run make install, then uncomment this module to enable it.
#
#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
# MySQL module: Allows other SQL modules to access MySQL databases
-# through a unified API. You must copy the source for this module
-# from the directory src/modules/extra, plus the file m_sqlv2.h
+# through a unified API.
# This modules is in extras. Re-run configure with: ./configure --enable-extras=m_mysql.cpp
# and run make install, then uncomment this module to enable it.
#
#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
# Oper log module: Logs all oper commands to the ircd log at default
-# loglevel.
+# loglevel, and optionally to the 'r' SNOMASK.
# This module is oper-only.
#<module name="m_operlog.so">
+#
+# If the following option is on then all oper commands will be sent to
+# the snomask 'r'. The default is off.
+#<operlog tosnomask="off">
#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
# Oper prefixing module: Gives IRC operators a prefix status character
# #
# If you are using the m_opermotd.so module, specify the motd here #
# #
-# onoper - Should the message be sent on /OPER or only when #
-# /OPERMOTD is used. Use "yes" or "no". #
+# onoper - Should the message be sent on /OPER or only when #
+# /OPERMOTD is used. Use "yes" or "no". #
+# #
+# processcolors - Allow color codes to be processed in the opermotd. #
+# Read the comment above <connect:allowmotdcolors> in #
+# inspircd.conf.example for details. #
# #
-#<opermotd file="oper.motd" onoper="yes">
+#<opermotd file="conf/examples/opermotd.txt.example" onoper="yes" processcolors="false">
#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
# Override module: Adds support for oper override
#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
# PostgreSQL module: Allows other SQL modules to access PgSQL databases
-# through a unified API. You must copy the source for this module
-# from the directory src/modules/extra, plus the file m_sqlv2.h
+# through a unified API.
# This modules is in extras. Re-run configure with: ./configure --enable-extras=m_pgsql.cpp
# and run make install, then uncomment this module to enable it.
#
#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
# SQLite3 module: Allows other SQL modules to access SQLite3 #
-# databases through a unified API. You must link the source for this #
-# module from the directory src/modules/extra to src/modules, plus #
-# the file m_sqlv2.h #
-# This modules is in extras. Re-run configure with: ./configure --enable-extras=m_aqlite.cpp
+# databases through a unified API.
+# This modules is in extras. Re-run configure with: ./configure --enable-extras=m_sqlite.cpp
# and run make install, then uncomment this module to enable it. #
#
#<module name="m_sqlite3.so">
#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
# SQL authentication module: Allows IRCd connections to be tied into
-# a database table (for example a forum). You must copy the source for
-# this module from the directory src/modules/extra
-# Depends on the SQLutils module being loaded first.
+# a database table (for example a forum).
# This modules is in extras. Re-run configure with: ./configure --enable-extras=m_sqlauth.cpp
# and run make install, then uncomment this module to enable it.
#
#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
# 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
-# Depends on the SQLutils module being loaded first.
# This modules is in extras. Re-run configure with: ./configure --enable-extras=m_sqloper.cpp
# and run make install, then uncomment this module to enable it.
#
projects / user / henk / code / inspircd.git / blobdiff