aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorGravatar Sadie Powell2024-11-01 14:35:23 +0000
committerGravatar Sadie Powell2024-11-01 15:53:04 +0000
commit8a3aba4044ee10df332631c4c66ed60299566e58 (patch)
treeafb185a313dff83d61c26e3b95f47b62d3ab5694 /docs
parentDefault <options:extbanformat> to name. (diff)
parentUse fmtlib instead of iostream in ConvToStr where available. (diff)
Merge branch 'insp4' into master.
Diffstat (limited to 'docs')
-rw-r--r--docs/LICENSE.txt17
-rw-r--r--docs/conf/inspircd.example.conf36
-rw-r--r--docs/conf/modules.example.conf14
-rw-r--r--docs/conf/motd.example.txt2
-rw-r--r--docs/conf/opermotd.example.txt2
-rw-r--r--docs/conf/providers/dronebl.example.conf78
-rw-r--r--docs/conf/providers/efnet-rbl.example.conf22
-rw-r--r--docs/conf/providers/torexit.example.conf4
-rw-r--r--docs/conf/services/atheme.example.conf32
-rw-r--r--docs/conf/services/generic.example.conf40
10 files changed, 174 insertions, 73 deletions
diff --git a/docs/LICENSE.txt b/docs/LICENSE.txt
index e8de3f876..9efa6fbc9 100644
--- a/docs/LICENSE.txt
+++ b/docs/LICENSE.txt
@@ -1,16 +1,8 @@
- NOTE: InspIRCd is licensed under GPL version 2 only.
-
- "Upgrading" to a later version of the GENERAL PUBLIC
- LICENSE is not permitted. For further information on
- this, please contact us at irc.chatspike.net on #inspircd.
-
-----------------------------------------------------------------------
-
GNU GENERAL PUBLIC LICENSE
Version 2, June 1991
Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
- 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ <https://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
@@ -312,8 +304,7 @@ the "copyright" line and a pointer to where the full notice is found.
GNU General Public License for more details.
You should have received a copy of the GNU General Public License along
- with this program; if not, write to the Free Software Foundation, Inc.,
- 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ with this program; if not, see <https://www.gnu.org/licenses/>.
Also add information on how to contact you by electronic and paper mail.
@@ -337,8 +328,8 @@ necessary. Here is a sample; alter the names:
Yoyodyne, Inc., hereby disclaims all copyright interest in the program
`Gnomovision' (which makes passes at compilers) written by James Hacker.
- <signature of Ty Coon>, 1 April 1989
- Ty Coon, President of Vice
+ <signature of Moe Ghoul>, 1 April 1989
+ Moe Ghoul, President of Vice
This General Public License does not permit incorporating your program into
proprietary programs. If your program is a subroutine library, you may
diff --git a/docs/conf/inspircd.example.conf b/docs/conf/inspircd.example.conf
index aa10b99a5..1ed8a84e4 100644
--- a/docs/conf/inspircd.example.conf
+++ b/docs/conf/inspircd.example.conf
@@ -651,23 +651,27 @@
# banned from the server.
xlinemessage="You're banned! Email irc@&networkDomain; with the ERROR line below for help."
- # xlinequit: The quit message to show to opers and affected users when
- # a user is [KGZ]-lined. The variables you can use in this are:
- #
- # %created% - The date/time at which the X-line was created.
- # %duration% - The duration of the X-line.
- # %expiry% - The date/time at which the X-line expires.
- # %fulltype% - The type of X-line which was matched, suffixed with
- # "-lined" if its name is one or two characters.
- # %reason% - The reason the X-line was added.
- # %remaining% - The duration remaining on the X-line.
- # %setter% - The name of the X-line setter.
- # %type% - The type of X-line which was matched.
- xlinequit="%fulltype%: %reason%"
+ # xlinequit: The quit message to show to opers and affected users when
+ # a user is [KGZ]-lined. The variables you can use in this are:
+ #
+ # %created% - The date/time at which the X-line was created.
+ # %duration% - The duration of the X-line.
+ # %expiry% - The date/time at which the X-line expires.
+ # %fulltype% - The type of X-line which was matched, suffixed with
+ # "-lined" if its name is one or two characters.
+ # %reason% - The reason the X-line was added.
+ # %remaining% - The duration remaining on the X-line.
+ # %setter% - The name of the X-line setter.
+ # %type% - The type of X-line which was matched.
+ xlinequit="%fulltype%: %reason%"
- # modesinlist: If enabled then the current channel modes will be shown
- # in the /LIST response. Defaults to yes.
- modesinlist="no"
+ # modesinlist: Whether to show the current channel modes in the /LIST
+ # output. Can be set to any one of:
+ # - yes Show the current channel modes to all users.
+ # - opers Show the current channel modes to server operators with the
+ # channels/auspex privilege. This is the default.
+ # - no Do not show the current channel modes in /LIST.
+ modesinlist="opers"
# extbanformat: The method to use for normalising extbans. Can be set
# to one of:
diff --git a/docs/conf/modules.example.conf b/docs/conf/modules.example.conf
index f1035eb69..fc0928bac 100644
--- a/docs/conf/modules.example.conf
+++ b/docs/conf/modules.example.conf
@@ -118,10 +118,10 @@
# An example of using the format value to create an alias with two
# different behaviours depending on the format of the parameters.
#
-#<alias text="ID" format="#*" replace="SQUERY ChanServ :IDENTIFY $2 $3"
+#<alias text="ID" format="#*" replace="PRIVMSG ChanServ :IDENTIFY $2 $3"
# requires="ChanServ" service="yes">
#
-#<alias text="ID" replace="SQUERY NickServ :IDENTIFY $2"
+#<alias text="ID" replace="PRIVMSG NickServ :IDENTIFY $2"
# requires="NickServ" service="yes">
#
# You may also add aliases to trigger based on something said in a
@@ -130,7 +130,7 @@
# command must be preceded by the fantasy prefix when used.
#
#<alias text="CS" usercommand="no" channelcommand="yes"
-# replace="SQUERY ChanServ :$1 $chan $2-" requires="ChanServ" service="yes">
+# replace="PRIVMSG ChanServ :$1 $chan $2-" requires="ChanServ" service="yes">
#
# This would be used as "!cs <command> <options>", with the channel
# being automatically inserted after the command in the message to
@@ -927,6 +927,9 @@
# stdregex - stdlib regexps, provided via regex_stdlib, see comment #
# at the <module> tag for info on availability. #
# #
+# If enableflags is set, you can specify flags that modify matching #
+# of the regular expression. #
+# #
# If notifyuser is set to no, the user will not be notified when #
# their message is blocked. #
# #
@@ -935,7 +938,10 @@
# warning will be sent to opers instead. This stops spambots which #
# send their spam message to themselves first to check if it is being #
# filtered by the server. #
-#<filteropts engine="stdregex" notifyuser="yes" warnonselfmsg="no">
+#<filteropts engine="stdregex"
+# enableflags="yes"
+# notifyuser="yes"
+# warnonselfmsg="no">
# #
# Your choice of regex engine must match on all servers network-wide. #
# #
diff --git a/docs/conf/motd.example.txt b/docs/conf/motd.example.txt
index d6fe37e2c..1f6857157 100644
--- a/docs/conf/motd.example.txt
+++ b/docs/conf/motd.example.txt
@@ -24,7 +24,7 @@
+---- To change this see \bmotd.example.txt\x ----+
| |
| * \bWeb:\x https://www.inspircd.org |
- | * \bIRC:\x irc.chatspike.net #inspircd |
+ | * \bIRC:\x ircs://irc.teranova.net/inspircd |
| * \bDocs:\x https://docs.inspircd.org |
| * \bIssues:\x https://git.io/JIuYi |
| * \bDiscussions:\x https://git.io/JIuYv |
diff --git a/docs/conf/opermotd.example.txt b/docs/conf/opermotd.example.txt
index 9fd5a4dda..b9360dc11 100644
--- a/docs/conf/opermotd.example.txt
+++ b/docs/conf/opermotd.example.txt
@@ -24,7 +24,7 @@
+-- To change this see \bopermotd.example.txt\x --+
| |
| * \bWeb:\x https://www.inspircd.org |
- | * \bIRC:\x irc.chatspike.net #inspircd |
+ | * \bIRC:\x ircs://irc.teranova.net/inspircd |
| * \bDocs:\x https://docs.inspircd.org |
| * \bIssues:\x https://git.io/JIuYi |
| * \bDiscussions:\x https://git.io/JIuYv |
diff --git a/docs/conf/providers/dronebl.example.conf b/docs/conf/providers/dronebl.example.conf
index 12c25fcda..5f3b289b1 100644
--- a/docs/conf/providers/dronebl.example.conf
+++ b/docs/conf/providers/dronebl.example.conf
@@ -8,4 +8,80 @@
records="3,5,6,7,8,9,10,11,13,14,15,16,17,19"
action="zline"
duration="7d"
- reason="You are listed in DroneBL. Please visit https://dronebl.org/lookup.do?ip=%ip%&amp;network=%network.url% for more information.">
+ reason="You are listed in DroneBL: %reason%. Please visit https://dronebl.org/lookup.do?ip=%ip%&amp;network=%network.url% for more information.">
+
+<dnsblreply name="DroneBL"
+ reply="1"
+ description="Testing">
+
+<dnsblreply name="DroneBL"
+ reply="2"
+ description="Sample data used for heuristical analysis">
+
+<dnsblreply name="DroneBL"
+ reply="3"
+ description="IRC spam drone (litmus/sdbot/fyle)">
+
+<dnsblreply name="DroneBL"
+ reply="5"
+ description="Bottler">
+
+<dnsblreply name="DroneBL"
+ reply="6"
+ description="Unknown worm or spambot">
+
+<dnsblreply name="DroneBL"
+ reply="7"
+ description="DDoS drone">
+
+<dnsblreply name="DroneBL"
+ reply="8"
+ description="Open SOCKS proxy">
+
+<dnsblreply name="DroneBL"
+ reply="9"
+ description="Open HTTP proxy">
+
+<dnsblreply name="DroneBL"
+ reply="10"
+ description="Proxychain">
+
+<dnsblreply name="DroneBL"
+ reply="11"
+ description="Webpage proxy">
+
+<dnsblreply name="DroneBL"
+ reply="12"
+ description="Open DNS resolver">
+
+<dnsblreply name="DroneBL"
+ reply="13"
+ description="Automated dictionary attack">
+
+<dnsblreply name="DroneBL"
+ reply="14"
+ description="Open WINGATE proxy">
+
+<dnsblreply name="DroneBL"
+ reply="15"
+ description="Compromised router / gateway">
+
+<dnsblreply name="DroneBL"
+ reply="16"
+ description="Autorooting worm">
+
+<dnsblreply name="DroneBL"
+ reply="17"
+ description="Automatically determined botnet IP">
+
+<dnsblreply name="DroneBL"
+ reply="18"
+ description="Possibly compromised DNS/MX type hostname detected on IRC">
+
+<dnsblreply name="DroneBL"
+ reply="19"
+ description="Abused VPN service">
+
+<dnsblreply name="DroneBL"
+ reply="255"
+ description="Uncategorized threat">
diff --git a/docs/conf/providers/efnet-rbl.example.conf b/docs/conf/providers/efnet-rbl.example.conf
index 78dce53cb..0130951dc 100644
--- a/docs/conf/providers/efnet-rbl.example.conf
+++ b/docs/conf/providers/efnet-rbl.example.conf
@@ -8,4 +8,24 @@
records="1,2,3,4,5"
action="zline"
duration="7d"
- reason="You are listed in the EFnet RBL. Please visit https://rbl.efnetrbl.org/?i=%ip% for more information.">
+ reason="You are listed in the EFnet RBL: %reason%. Please visit https://rbl.efnetrbl.org/?i=%ip% for more information.">
+
+<dnsblreply name="EFnet RBL"
+ reply="1"
+ description="Open proxy">
+
+<dnsblreply name="EFnet RBL"
+ reply="2"
+ description="Spamtrap score of 666">
+
+<dnsblreply name="EFnet RBL"
+ reply="3"
+ description="Spamtrap score of 50+">
+
+<dnsblreply name="EFnet RBL"
+ reply="4"
+ description="Tor exit node">
+
+<dnsblreply name="EFnet RBL"
+ reply="5"
+ description="Drones or flooding">
diff --git a/docs/conf/providers/torexit.example.conf b/docs/conf/providers/torexit.example.conf
index abc35c696..1be1a5b40 100644
--- a/docs/conf/providers/torexit.example.conf
+++ b/docs/conf/providers/torexit.example.conf
@@ -10,3 +10,7 @@
action="zline"
duration="7d"
reason="Tor exit nodes are not allowed on this network. See https://metrics.torproject.org/rs.html#search/%ip% for more information.">
+
+<dnsblreply name="torexit.dan.me.uk"
+ reply="100"
+ description="Tor exit node">
diff --git a/docs/conf/services/atheme.example.conf b/docs/conf/services/atheme.example.conf
index 507ec7c8b..1f5883239 100644
--- a/docs/conf/services/atheme.example.conf
+++ b/docs/conf/services/atheme.example.conf
@@ -6,27 +6,27 @@
<include file="&dir.example;/services/generic.example.conf">
# Long hand aliases for services pseudoclients.
-<alias text="ALIS" replace="SQUERY $requirement :$2-" requires="ALIS" service="yes">
-<alias text="CHANFIX" replace="SQUERY $requirement :$2-" requires="ChanFix" service="yes">
-<alias text="GAMESERV" replace="SQUERY $requirement :$2-" requires="GameServ" service="yes">
-<alias text="GROUPSERV" replace="SQUERY $requirement :$2-" requires="GroupServ" service="yes">
-<alias text="HELPSERV" replace="SQUERY $requirement :$2-" requires="HelpServ" service="yes">
-<alias text="INFOSERV" replace="SQUERY $requirement :$2-" requires="InfoServ" service="yes">
-<alias text="PROXYSCAN" replace="SQUERY $requirement :$2-" requires="Proxyscan" service="yes" operonly="yes">
-<alias text="RPGSERV" replace="SQUERY $requirement :$2-" requires="RPGServ" service="yes">
+<alias text="ALIS" replace="PRIVMSG $requirement :$2-" requires="ALIS" service="yes">
+<alias text="CHANFIX" replace="PRIVMSG $requirement :$2-" requires="ChanFix" service="yes">
+<alias text="GAMESERV" replace="PRIVMSG $requirement :$2-" requires="GameServ" service="yes">
+<alias text="GROUPSERV" replace="PRIVMSG $requirement :$2-" requires="GroupServ" service="yes">
+<alias text="HELPSERV" replace="PRIVMSG $requirement :$2-" requires="HelpServ" service="yes">
+<alias text="INFOSERV" replace="PRIVMSG $requirement :$2-" requires="InfoServ" service="yes">
+<alias text="PROXYSCAN" replace="PRIVMSG $requirement :$2-" requires="Proxyscan" service="yes" operonly="yes">
+<alias text="RPGSERV" replace="PRIVMSG $requirement :$2-" requires="RPGServ" service="yes">
# Short hand aliases for services pseudoclients.
-<alias text="CF" replace="SQUERY $requirement :$2-" requires="ChanFix" service="yes">
-<alias text="GS" replace="SQUERY $requirement :$2-" requires="GroupServ" service="yes">
-<alias text="IS" replace="SQUERY $requirement :$2-" requires="InfoServ" service="yes">
-<alias text="LS" replace="SQUERY $requirement :$2-" requires="ALIS" service="yes">
-<alias text="PS" replace="SQUERY $requirement :$2-" requires="Proxyscan" service="yes" operonly="yes">
-<alias text="RS" replace="SQUERY $requirement :$2-" requires="RPGServ" service="yes">
+<alias text="CF" replace="PRIVMSG $requirement :$2-" requires="ChanFix" service="yes">
+<alias text="GS" replace="PRIVMSG $requirement :$2-" requires="GroupServ" service="yes">
+<alias text="IS" replace="PRIVMSG $requirement :$2-" requires="InfoServ" service="yes">
+<alias text="LS" replace="PRIVMSG $requirement :$2-" requires="ALIS" service="yes">
+<alias text="PS" replace="PRIVMSG $requirement :$2-" requires="Proxyscan" service="yes" operonly="yes">
+<alias text="RS" replace="PRIVMSG $requirement :$2-" requires="RPGServ" service="yes">
# These short hand aliases conflict with other pseudoclients. You can enable
# them but you will need to comment out the uncommented ones above first,
-#<alias text="GS" replace="SQUERY $requirement :$2-" requires="GameServ" service="yes">
-#<alias text="HS" replace="SQUERY $requirement :$2-" requires="HelpServ" service="yes">
+#<alias text="GS" replace="PRIVMSG $requirement :$2-" requires="GameServ" service="yes">
+#<alias text="HS" replace="PRIVMSG $requirement :$2-" requires="HelpServ" service="yes">
# Prevent clients from using the nicknames of services pseudoclients.
<badnick nick="ALIS" reason="Reserved for a network service">
diff --git a/docs/conf/services/generic.example.conf b/docs/conf/services/generic.example.conf
index 7adf5d5be..649dd4b49 100644
--- a/docs/conf/services/generic.example.conf
+++ b/docs/conf/services/generic.example.conf
@@ -4,34 +4,34 @@
<module name="alias">
# Long hand aliases for services pseudoclients.
-<alias text="BOTSERV" replace="SQUERY $requirement :$2-" requires="BotServ" service="yes">
-<alias text="CHANSERV" replace="SQUERY $requirement :$2-" requires="ChanServ" service="yes">
-<alias text="GLOBAL" replace="SQUERY $requirement :$2-" requires="Global" service="yes" operonly="yes">
-<alias text="HOSTSERV" replace="SQUERY $requirement :$2-" requires="HostServ" service="yes">
-<alias text="MEMOSERV" replace="SQUERY $requirement :$2-" requires="MemoServ" service="yes">
-<alias text="NICKSERV" replace="SQUERY $requirement :$2-" requires="NickServ" service="yes">
-<alias text="OPERSERV" replace="SQUERY $requirement :$2-" requires="OperServ" service="yes" operonly="yes">
-<alias text="STATSERV" replace="SQUERY $requirement :$2-" requires="StatServ" service="yes">
+<alias text="BOTSERV" replace="PRIVMSG $requirement :$2-" requires="BotServ" service="yes">
+<alias text="CHANSERV" replace="PRIVMSG $requirement :$2-" requires="ChanServ" service="yes">
+<alias text="GLOBAL" replace="PRIVMSG $requirement :$2-" requires="Global" service="yes" operonly="yes">
+<alias text="HOSTSERV" replace="PRIVMSG $requirement :$2-" requires="HostServ" service="yes">
+<alias text="MEMOSERV" replace="PRIVMSG $requirement :$2-" requires="MemoServ" service="yes">
+<alias text="NICKSERV" replace="PRIVMSG $requirement :$2-" requires="NickServ" service="yes">
+<alias text="OPERSERV" replace="PRIVMSG $requirement :$2-" requires="OperServ" service="yes" operonly="yes">
+<alias text="STATSERV" replace="PRIVMSG $requirement :$2-" requires="StatServ" service="yes">
# Short hand aliases for services pseudoclients.
-<alias text="BS" replace="SQUERY $requirement :$2-" requires="BotServ" service="yes">
-<alias text="CS" replace="SQUERY $requirement :$2-" requires="ChanServ" service="yes">
-<alias text="GL" replace="SQUERY $requirement :$2-" requires="Global" service="yes" operonly="yes">
-<alias text="HS" replace="SQUERY $requirement :$2-" requires="HostServ" service="yes">
-<alias text="MS" replace="SQUERY $requirement :$2-" requires="MemoServ" service="yes">
-<alias text="NS" replace="SQUERY $requirement :$2-" requires="NickServ" service="yes">
-<alias text="OS" replace="SQUERY $requirement :$2-" requires="OperServ" service="yes" operonly="yes">
-<alias text="SS" replace="SQUERY $requirement :$2-" requires="StatServ" service="yes">
+<alias text="BS" replace="PRIVMSG $requirement :$2-" requires="BotServ" service="yes">
+<alias text="CS" replace="PRIVMSG $requirement :$2-" requires="ChanServ" service="yes">
+<alias text="GL" replace="PRIVMSG $requirement :$2-" requires="Global" service="yes" operonly="yes">
+<alias text="HS" replace="PRIVMSG $requirement :$2-" requires="HostServ" service="yes">
+<alias text="MS" replace="PRIVMSG $requirement :$2-" requires="MemoServ" service="yes">
+<alias text="NS" replace="PRIVMSG $requirement :$2-" requires="NickServ" service="yes">
+<alias text="OS" replace="PRIVMSG $requirement :$2-" requires="OperServ" service="yes" operonly="yes">
+<alias text="SS" replace="PRIVMSG $requirement :$2-" requires="StatServ" service="yes">
# /ID [account] <password>
# Identifies to a services account.
-<alias text="ID" format="*" replace="SQUERY $requirement :IDENTIFY $2-" requires="NickServ" service="yes">
-<alias text="IDENTIFY" format="*" replace="SQUERY $requirement :IDENTIFY $2-" requires="NickServ" service="yes">
-<alias text="LOGIN" format="*" replace="SQUERY $requirement :IDENTIFY $2-" requires="NickServ" service="yes">
+<alias text="ID" format="*" replace="PRIVMSG $requirement :IDENTIFY $2-" requires="NickServ" service="yes">
+<alias text="IDENTIFY" format="*" replace="PRIVMSG $requirement :IDENTIFY $2-" requires="NickServ" service="yes">
+<alias text="LOGIN" format="*" replace="PRIVMSG $requirement :IDENTIFY $2-" requires="NickServ" service="yes">
# /LOGOUT
# Logs out of a services account.
-<alias text="LOGOUT" format="*" replace="SQUERY $requirement :LOGOUT" requires="NickServ" service="yes">
+<alias text="LOGOUT" format="*" replace="PRIVMSG $requirement :LOGOUT" requires="NickServ" service="yes">
# Prevent clients from using the nicknames of services pseudoclients.
<badnick nick="BotServ" reason="Reserved for a network service">