diff 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
parents 163d55777ad5
children 476afcbfb3e9
line wrap: on
line diff
--- a/mod_throttle_unsolicited/README.markdown	Sat Oct 01 20:34:43 2016 +0200
+++ b/mod_throttle_unsolicited/README.markdown	Tue Oct 04 16:18:06 2016 +0200
@@ -2,14 +2,15 @@
 depends:
 - 'mod\_track\_muc\_joins'
 summary: Limit rate of outgoing unsolicited messages
-...
+---
 
 Introduction
 ============
 
-This module limits the rate of outgoing unsolicited messages. A message
-counts as "unsolicited" if the receiving user hasn't added the sending
-user to their roster.
+This module limits the rate of outgoing unsolicited messages from local
+clients. Optionally, unsolicited messages coming in from remote servers
+may be limited per s2s conneciton. A message counts as "unsolicited" if
+the receiving user hasn't added the sending user to their roster.
 
 The module depends on [mod\_track\_muc\_joins] in order to allow sent
 messages to joined MUC rooms.
@@ -17,6 +18,14 @@
 Configuration
 =============
 
+To set a limit on messages from local sessions:
+
 ``` {.lua}
 unsolicited_messages_per_minute = 10
 ```
+
+To enable limits on unsolicited messages from s2s connections:
+
+``` {.lua}
+unsolicited_s2s_messages_per_minute = 100
+```