view mod_muc_require_tos/README.markdown @ 4832:bfd4af4caddc

mod_password_policy: Support for additional policies provided by other modules E.g. check a password contains an uppercase character: module:provides("password-policy", { name = "contains_uppercase"; check_password = function (password, policy) return (policy ~= true) or (not not password:match("%u")); end; }) Config: password_policy = { contains_uppercase = true; }
author Matthew Wild <mwild1@gmail.com>
date Wed, 22 Dec 2021 14:48:46 +0000
parents 82dabfffaddf
children
line wrap: on
line source

---
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
  ----- -----