Software / code / prosody-modules
Comparison
mod_throttle_unsolicited/README.markdown @ 2324:1424aa8877f0
mod_throttle_unsolicited: Add support for throttling unsolicited messages on incoming s2s connections
| author | Kim Alvefur <zash@zash.se> |
|---|---|
| date | Tue, 04 Oct 2016 16:18:06 +0200 |
| parent | 2082:163d55777ad5 |
| child | 4104:476afcbfb3e9 |
comparison
equal
deleted
inserted
replaced
| 2323:35ae59a8196d | 2324:1424aa8877f0 |
|---|---|
| 1 --- | 1 --- |
| 2 depends: | 2 depends: |
| 3 - 'mod\_track\_muc\_joins' | 3 - 'mod\_track\_muc\_joins' |
| 4 summary: Limit rate of outgoing unsolicited messages | 4 summary: Limit rate of outgoing unsolicited messages |
| 5 ... | 5 --- |
| 6 | 6 |
| 7 Introduction | 7 Introduction |
| 8 ============ | 8 ============ |
| 9 | 9 |
| 10 This module limits the rate of outgoing unsolicited messages. A message | 10 This module limits the rate of outgoing unsolicited messages from local |
| 11 counts as "unsolicited" if the receiving user hasn't added the sending | 11 clients. Optionally, unsolicited messages coming in from remote servers |
| 12 user to their roster. | 12 may be limited per s2s conneciton. A message counts as "unsolicited" if |
| 13 the receiving user hasn't added the sending user to their roster. | |
| 13 | 14 |
| 14 The module depends on [mod\_track\_muc\_joins] in order to allow sent | 15 The module depends on [mod\_track\_muc\_joins] in order to allow sent |
| 15 messages to joined MUC rooms. | 16 messages to joined MUC rooms. |
| 16 | 17 |
| 17 Configuration | 18 Configuration |
| 18 ============= | 19 ============= |
| 19 | 20 |
| 21 To set a limit on messages from local sessions: | |
| 22 | |
| 20 ``` {.lua} | 23 ``` {.lua} |
| 21 unsolicited_messages_per_minute = 10 | 24 unsolicited_messages_per_minute = 10 |
| 22 ``` | 25 ``` |
| 26 | |
| 27 To enable limits on unsolicited messages from s2s connections: | |
| 28 | |
| 29 ``` {.lua} | |
| 30 unsolicited_s2s_messages_per_minute = 100 | |
| 31 ``` |