X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=conf%2Fmodules.conf.example;h=7db93fac9da715451489d6eefdcf0b20f68a4cb9;hb=e462e71f1086761c8758a92e75dee80bb1ccd273;hp=db255cca33a80849ff00f60a62839b6b9e4ff6b9;hpb=84ae7f133e243fb5ec9131b9d25903a70bbfb582;p=user%2Fhenk%2Fcode%2Finspircd.git

diff --git a/conf/modules.conf.example b/conf/modules.conf.example
index db255cca3..7db93fac9 100644
--- a/conf/modules.conf.example
+++ b/conf/modules.conf.example
@@ -156,6 +156,11 @@
 #<alias text="NICKSERV" format=":IDENTIFY *" replace="PRIVMSG NickServ :IDENTIFY $3-"
 #  requires="NickServ" uline="yes">
 
+#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
+# Allowinvite module: Gives channel mode +A to allow all users to use
+# /invite, and extban A to deny invite from specific masks
+#<module name="m_allowinvite.so">
+
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Alltime module: Shows time on all connected servers at once
 #<module name="m_alltime.so">
@@ -262,7 +267,7 @@
 #<callerid maxaccepts="16"
 #          operoverride="no"
 #          tracknick="no"
-#          cooldown="60"
+#          cooldown="60">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # CAP module: Provides the CAP negotiation mechanism seen in
@@ -337,6 +342,21 @@
 # filtering using simple string matches (channel mode +g)
 #<module name="m_chanfilter.so">
 
+#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
+# Channel logging module: used to send snotice output to channels, to
+# allow staff to centrally monitor and discuss network activity.
+#
+# The "channel" field is where you want the messages to go, "snomasks"
+# is what snomasks you want to be sent to that channel. Multiple tags
+# are allowed.
+#<module name="m_chanlog.so">
+#<chanlog snomasks="AOcC" channel="#opers">
+
+#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
+# Channelban: Implements extended ban j:, which stops anyone in already
+# 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">
@@ -358,7 +378,7 @@
 # charmap        - A list of chars accepted as valid by the /CHGHOST #
 #                  and /SETHOST commands. Also note that the list is # 
 #                  case-sensitive.                                   #
-#<hostname charmap="abcdefghijklmnopqrstuvwxyz.-_/0123456789">
+#<hostname charmap="abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ.-_/0123456789">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # CHGIDENT module: Adds the /CHGIDENT command
@@ -463,14 +483,15 @@
 #<module name="m_cycle.so">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# Connectban: Provides per-IP connection throttling. Any IP that disconnects
+# Connectban: Provides IP connection throttling. Any IP range that connects
 # too many times (configurable) in an hour is zlined for a (configurable)
 # duration, and their count resets to 0.
 #
-# NOTE: This module may change name/behaviour later in 1.2. Please make sure
-# you read release announcements!
+# ipv4cidr and ipv6cidr allow you to turn the comparison from individual
+# IP addresses (32 and 128 bits) into CIDR masks, to allow for throttling
+# over whole ISPs/blocks of IPs, which may be needed to prevent attacks.
 #
-#<connectban threshold="10" duration="10m">
+#<connectban threshold="10" duration="10m" ipv4cidr="32" ipv6cidr="128">
 # This allows for 10 quits in an hour with a 10 minute ban if that is exceeded.
 #
 #<module name="m_connectban.so">
@@ -605,6 +626,11 @@
 # Foobar module: does nothing - historical relic
 #<module name="m_foobar.so">
 
+#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
+# Gecosban: Implements extended ban r:, which stops anyone matching
+# a mask like +b r:*realname?here* from joining a channel.
+#<module name="m_gecosban.so">
+
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # GeoIP module: Allows the server admin to ban users by country code.
 #<module name="m_geoip.so">
@@ -623,7 +649,7 @@
 # code such as TR, GB, or US.                                         #
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# Globops module: gives /GLOBOPS and usermode +g
+# Globops module: gives /GLOBOPS and SNOMASK +g
 #<module name="m_globops.so">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
@@ -722,6 +748,9 @@
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Ident: Provides RFC 1413 ident lookup support
+# When this module is loaded <connect:allow> tags may have an optional
+# useident="yes|no" boolean value, determining whether or not to lookup
+# ident on users matching that connect tag.
 #<module name="m_ident.so">
 #
 #-#-#-#-#-#-#-#-#-#-#-#-   IDENT CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#
@@ -858,12 +887,6 @@
 # This is supported by mIRC, x-chat, klient, and maybe more.
 #<module name="m_namesx.so">
 
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# Nickban: Implements extended ban n:, which stops anyone matching
-# a mask like +b n:nick!user@host from changing their nick on channel.
-#<module name="m_nickban.so">
-#
-
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Nickchange flood protection module: Allows up to X nick changes in Y seconds.
 # Provides channel mode +F.
@@ -878,16 +901,15 @@
 # No ctcp module: Adds the channel mode +C to block CTCPs
 #<module name="m_noctcp.so">
 
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# Noinvite module: Gives channel mode +V
-#<module name="m_noinvite.so">
-
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # No kicks module: Adds the +Q channel mode
 #<module name="m_nokicks.so">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# No nicks module: Adds the +N channel mode
+# No nicks module: Adds the +N channel mode, as well as the +b N:
+# extended bantype. +N stops all users from changing their nick,
+# the +b N: extban stops anyone from matching a +b N:nick!user@host
+# mask from changing their nick.
 #<module name="m_nonicks.so">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
@@ -902,6 +924,16 @@
 # Oper flood module: Removes flood limits from users upon opering up
 #<module name="m_operflood.so">
 
+#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
+# Oper invex/extban module: Adds +beI type O, to ban, exempt, and invex
+# given oper type masks.
+# e.g, /mode #channel +iI O:* is equivilant to chmode +O, but you
+# may also, e.g. /mode #channel +iI O:AdminTypeOnly to only allow admins.
+#
+# +be work in a similar fashion.
+#
+#<module name="m_operinvex.so">
+
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Oper Join module: Auto-joins opers to a channel upon oper-up
 #<module name="m_operjoin.so">
@@ -989,6 +1021,9 @@
 # channels -may- need support from your Services package to function
 # properly with them. This adds channel mode +P.
 #<module name="m_permchannels.so">
+#
+# You may also create channels on startup by using the <permchannels> block.
+#<permchannels channel="#opers" modes="is" topic="Opers only.">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # PostgreSQL module: Allows other SQL modules to access PgSQL databases
@@ -1004,13 +1039,9 @@
 #<database name="mydb" username="myuser" password="mypass" hostname="localhost" id="my_database" ssl="no">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# Proxy scan module: Scans locally connecting clients for proxies.
-#<module name="m_proxyscan.so">
-
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# Quietban: Implements extended ban q:, which stops anyone matching
-# a mask like +b q:nick!user@host from speaking on channel.
-#<module name="m_quietban.so">
+# Muteban: Implements extended ban m:, which stops anyone matching
+# a mask like +b m:nick!user@host from speaking on channel.
+#<module name="m_muteban.so">
 #
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
@@ -1165,6 +1196,10 @@
 # Services support module: Adds several usermodes such as +R and +M
 # this module implements the 'identified' state via account names (AC)
 # and is similar in operation to the way asuka and ircu handle services.
+#
+# Also of note is that this module implements two extbans:
+# +b R: (stop matching account names from joining)
+# +b M: (stop matching account names from speaking)
 #                                                                       
 # N O T E!!
 #  >>  This CAN NOT be used at the same time as m_services <<
@@ -1184,6 +1219,11 @@
 # SETNAME module: Adds the /SETNAME command
 #<module name="m_setname.so">
 
+#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
+# Serverban: Implements extended ban s:, which stops anyone connected
+# to a server matching a mask like +b s:server.mask.here from joining.
+#<module name="m_serverban.so">
+
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Show Whois module: Adds the +W usermode which allows opers
 # to see when they are whois'ed (can be annoying).
@@ -1191,8 +1231,15 @@
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Shun module: Provides the /shun command, which stops a user executing 
-# all commands except PING and PONG.
+# most commands.
 #<module name="m_shun.so">
+#
+# You may also configure which commands you wish a user to be able to
+# perform. It should be noted that if a shunned user issues QUIT or PART
+# then their message will be removed, as if they did not issue one.
+#
+# You may also (optionally) let the user know that their command was blocked.
+#<shun enabledcommands="PING PONG QUIT PART JOIN" notifyuser="yes">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Spy module: Provides the ability to see the complete names list of 
@@ -1416,15 +1463,6 @@
 # be a lot less bans to apply - as most of them will already be there.
 #<module name="m_xline_db.so">
 
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# XMLSocket module: Adds support for connections using the shockwave
-# flash XMLSocket. Note that this does not work if the client you are
-# using has retarded ideas of the IRC protocol. Your client must still
-# send RFC-correct lines to the server, this module only changes the
-# line ending from newlines to null terminators.
-#
-#<module name="m_xmlsocket.so">
-
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # ZipLinks module: Adds support for zlib deflate on server to server
 # connections. Both ends of the connection must load this module.