From 4e81454a4a6a4b67d1a5c76576a46b8e02d9044e Mon Sep 17 00:00:00 2001
From: Peter Powell <petpow@saberuk.com>
Date: Sun, 29 Oct 2017 05:58:16 +0000
Subject: Add the m_ircv3_sts module which implements the IRCv3 STS spec.

---
 docs/conf/modules.conf.example | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)

(limited to 'docs/conf/modules.conf.example')

diff --git a/docs/conf/modules.conf.example b/docs/conf/modules.conf.example
index cf79dafce..b573de903 100644
--- a/docs/conf/modules.conf.example
+++ b/docs/conf/modules.conf.example
@@ -1013,6 +1013,27 @@
 # another user into a channel. This respects <options:announceinvites>.
 #<module name="ircv3_invitenotify">
 
+#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
+# IRCv3 Strict Transport Security module: Provides the sts IRCv3.2
+# extension which allows clients connecting insecurely to upgrade their
+# connections to TLS.
+#<module name="ircv3_sts">
+#
+# If using the ircv3_sts module you MUST define a STS policy to send
+# to clients using the <sts> tag. This tag takes the following
+# attributes:
+#
+# host     - A glob match for the SNI hostname to apply this policy to.
+# duration - The amount of time that the policy lasts for. Defaults to
+#            approximately two months by default.
+# port     - The port on which TLS connections to the server are being
+#            accepted. You MUST have a CA-verified certificate on this
+#            port. Self signed certificates are not acceptable.
+# preload  - Whether client developers can include your certificate in
+#            preload lists.
+#
+# <sts host="*.example.com" duration="60d" port="6697" preload="yes">
+
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Join flood module: Adds support for join flood protection +j X:Y.
 # Closes the channel for N seconds if X users join in Y seconds.
-- 
cgit v1.2.3