prosody-modules
d194d1012fd3
mod_muc_require_tos/README.markdown

Find changesets by keywords by author, files, the commit message, revision number or hash, or revset expression.

Software / code / prosody-modules

File

mod_muc_require_tos/README.markdown @ 5931:d194d1012fd3

Updating dox for mod_rest. Ideas expressed / clarified: 1) Making clear that mod_rest isn't to be installed under VirtualHosts AND as a component. 2) Understanding some of the implications of this choice: A) Changes to user authentication B) How it affects subdomains 3) More consistent use of domain names for clarity. 4) Using different heading sizes to show scope of section. Essentially, I added all the tidbits I had to clarify in getting this to work in my own example.
author Ben Smith <bens@effortlessis.com>
date Mon, 13 May 2024 13:25:13 -0700
parent 4690:82dabfffaddf
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
  ----- -----