mod_muc_require_tos/README.markdown
changeset 4694 82dabfffaddf
equal deleted inserted replaced
4693:ecfffbbcbf42 4694:82dabfffaddf
       
     1 ---
       
     2 labels:
       
     3 - 'Stage-Alpha'
       
     4 summary: Require visitors to accept something before being allowed in a room
       
     5 ...
       
     6 
       
     7 # Introduction
       
     8 
       
     9 This module sends a message to visitors of a room, prompting them to accept or reject it.
       
    10 
       
    11 They get kicked if they reject it, and become members if they accept it.
       
    12 
       
    13 # Setup
       
    14 
       
    15 ```lua
       
    16 Component "rooms.example.org" "muc"
       
    17 	modules_enabled = {
       
    18 		"muc_require_tos";
       
    19 	}
       
    20 	tos_welcome_message = "Please read and accept the TOS of this service: https://lurk.org/TOS.txt"
       
    21 	tos_yes_message = "Thanks, and welcome here!"
       
    22 	tos_no_message = "Too bad."
       
    23 ```
       
    24 
       
    25 Compatibility
       
    26 =============
       
    27 
       
    28   ----- -----
       
    29   trunk Works
       
    30   ----- -----
       
    31