]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - docs/modules.conf.example
2.0 beta 4 release
[user/henk/code/inspircd.git] / docs / modules.conf.example
index 82e722f59872119491998f10a349a6e787a092f9..3e405dcd3c1e2b77b64afa69c6ec1d4a97073c1b 100644 (file)
 #
 # Auditorium settings:
 #
-#<auditorium showops="no" operoverride="no">
+#<auditorium opvisible="no" opcansee="no" opercansee="yes">
 #
-# 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.
+# 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
+#
+# 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.
 #<connflood seconds="30" maxconns="3" timeout="30"
 #   quitmsg="Throttled" bootwait="10">
 
+#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
+# Custom prefixes : allows for channel prefixes to be added. 
+# This replaces m_chanprotect and m_halfop
+#<module name="m_customprefix.so">
+#
+# 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.
+#<customprefix name="founder" letter="q" prefix="~" rank="50000" 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">
+
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Custom title module: Adds the /TITLE command which allows for trusted
 #                      users to gain a custom whois line and a optional
 # modes are blockcaps, noctcp, blockcolor, nickflood, flood, censor,  #
 # filter, regmoderated, nonick, nonotice, and stripcolor.             #
 #<module name="m_exemptchanops.so">                                   #
-#                                                                     #
-#-#-#-#-#-#-#-#-#-#-  EXEMPTCHANOPS CONFIGURATION  -#-#-#-#-#-#-#-#-#-#
-#  alwaysexempt      - Modes channel operators are always exempt from,
-#                      regardless of channel setting.
-#  neverexempt       - Modes channel operators are never exempt from,
-#                      regardless of channel setting.
-#<exemptchanops alwaysexempt="nickflood censor flood filter" neverexempt="regmoderated">
-
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Filter module: Provides message filtering, similar to SPAMFILTER.
 #<module name="m_gecosban.so">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# 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,
 # or check the InspIRCd wiki page for this module.
 #<module name="m_geoip.so">
 #
-#-#-#-#-#-#-#-#-#-#-#-#  GEOIP CONFIGURATION  #-#-#-#-#-#-#-#-#-#-#-#-#
-#                                                                     #
-# <geoip banunknown="false">                                          #
-#                                                                     #
-# Set this value to true or yes to block unknown IP ranges which are  #
-# not in the database (usually LAN addresses, localhost, etc)         #
-#                                                                     #
-# <geoban country="TR" reason="This country not permitted">           #
-#                                                                     #
-# 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:
+#
+# <connect deny="*" geoip="TR,RU">
+#
+# 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
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Invite except module: Adds support for channel invite exceptions (+I)
 #<module name="m_inviteexception.so">
+# Does a +I bypass channel +k in addition to +i?
+#<inviteexception bypasskey="yes">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Invisible module - Adds support for usermode +Q (quiet) which lets an
 # This module is oper-only. For the user equivalent, see m_conn_umodes
 #<module name="m_opermodes.so">
 
+#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
+# Password forwarding module: Forwards a password users can send on connect
+# to the specified client below. The client is usually nickserv and this
+# module is usually used to authenticate users with nickserv using their
+# connect password.
+#<module name="m_passforward.so">
+
+<passforward
+               # nick: nick to forward connect passwords to.
+               nick="NickServ"
+
+               # forwardmsg: Message to send to users using a connect password.
+               # $nick will be the users' nick, $nickrequired will be the nick
+               # of where the password is going (the nick above).
+               forwardmsg="NOTICE $nick :*** Forwarding PASS to $nickrequired"
+
+               # cmd: Command for the nick to run when it recieves a connect
+               # password. 
+               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
 # use glob. For this reason, is recommended to use a real regex engine
 # so that at least \s or [[:space:]] is available.
 
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# JSON-RPC module: Encode and decode JSON-RPC requests for modules
-#<module name="m_rpc_json.so">
-
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# RPC test module: A test of the RPC API
-#<module name="m_rpctest.so">
-
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # SAJOIN module: Adds the /SAJOIN command
 # This module is oper-only.
 # server to server traffic, you MUST load it before m_spanningtree in #
 # your configuration file!                                            #
 
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# Status prefix: Adds the channel mode +V
-#<module name="m_statusprefix.so">
-
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Strip colour module: Adds the channel mode +S
 #<module name="m_stripcolor.so">