Mercurial > prosody-modules

comparison mod_muc_limits/README.markdown @ 5653:62c6e17a5e9d

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Merge
author Stephen Paul Weber <singpolyma@singpolyma.net>
date Mon, 18 Sep 2023 08:24:19 -0500
parents ee335399d90e
children
comparison
equal deleted inserted replaced
5652:eade7ff9f52c 5653:62c6e17a5e9d
28 Configuration 28 Configuration
29 ============= 29 =============
30 30
31 Add the module to the MUC host (not the global modules\_enabled): 31 Add the module to the MUC host (not the global modules\_enabled):
32 32
33 Component "conference.example.com" "muc" 33 ```lua
34 modules_enabled = { "muc_limits" } 34 Component "conference.example.com" "muc"
35 modules_enabled = { "muc_limits" }
36 ```
35 37
36 You can define (globally or per-MUC component) the following options: 38 You can define (globally or per-MUC component) the following options:
37 39
38 Name Default value Description 40 Name Default value Description
39 ------------------------ --------------- ---------------------------------------------- 41 --------------------------- --------------- ----------------------------------------------------------
40 muc\_event\_rate 0.5 The maximum number of events per second. 42 muc_event_rate 0.5 The maximum number of events per second.
41 muc\_burst\_factor 6 Allow temporary bursts of this multiple. 43 muc_burst_factor 6 Allow temporary bursts of this multiple.
42 muc\_max\_nick\_length 23 The maximum allowed length of user nicknames 44 muc_max_nick_length 23 The maximum allowed length of user nicknames
45 muc_max_char_count 5664 The maximum allowed number of bytes in a message
46 muc_max_line_count 23 The maximum allowed number of lines in a message
47 muc_limit_base_cost 1 Base cost of sending a stanza
48 muc_line_count_multiplier 0.1 Additional cost of each newline in the body of a message
43 49
44 For more understanding of how these values are used, see the algorithm 50 For more understanding of how these values are used, see the algorithm
45 section below. 51 section below.
46 52
47 Algorithm 53 Algorithm
64 the user the MUC is overactive, and asking them to try again. 70 the user the MUC is overactive, and asking them to try again.
65 71
66 Compatibility 72 Compatibility
67 ============= 73 =============
68 74
69 ------- ------------------ 75 ------- -------
70 trunk Works 76 trunk Works
71 0.11 Works 77 0.11 Works
72 0.10 Works 78 ------- -------
73 0.9 Works
74 0.8 Doesn't work[^1]
75 ------- ------------------
76
77 [^1]: This module can be made to work in 0.8 (and *maybe* previous
78 versions) of Prosody by copying the new
79 [util.throttle](http://hg.prosody.im/trunk/raw-file/fc8a22936b3c/util/throttle.lua)
80 into your Prosody source directory (into the util/ subdirectory).