diff mod_muc_require_tos/README.markdown @ 4690:82dabfffaddf

mod_muc_require_tos: Add this new module
author Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
date Thu, 16 Sep 2021 20:41:14 +0200
parents
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_muc_require_tos/README.markdown	Thu Sep 16 20:41:14 2021 +0200
@@ -0,0 +1,31 @@
+---
+labels:
+- 'Stage-Alpha'
+summary: Require visitors to accept something before being allowed in a room
+...
+
+# Introduction
+
+This module sends a message to visitors of a room, prompting them to accept or reject it.
+
+They get kicked if they reject it, and become members if they accept it.
+
+# Setup
+
+```lua
+Component "rooms.example.org" "muc"
+	modules_enabled = {
+		"muc_require_tos";
+	}
+	tos_welcome_message = "Please read and accept the TOS of this service: https://lurk.org/TOS.txt"
+	tos_yes_message = "Thanks, and welcome here!"
+	tos_no_message = "Too bad."
+```
+
+Compatibility
+=============
+
+  ----- -----
+  trunk Works
+  ----- -----
+