Diff

mod_c2s_conn_throttle/README.markdown @ 1803:4d73a1a6ba68

Convert all wiki pages to Markdown
author Kim Alvefur <zash@zash.se>
date Fri, 28 Aug 2015 18:03:58 +0200
parent 1782:29f3d6b7ad16
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_c2s_conn_throttle/README.markdown	Fri Aug 28 18:03:58 2015 +0200
@@ -0,0 +1,32 @@
+---
+labels:
+- 'Stage-Stable'
+summary: c2s connections throttling module
+...
+
+Introduction
+============
+
+This module allows to throttle those client connections which exceed a
+n\*seconds limit.
+
+Usage
+=====
+
+Copy the module folder into your prosody modules directory. Place the
+module between your enabled modules either into the global or a vhost
+section.
+
+Optional configuration directives:
+
+``` {.lua}
+
+cthrottler_logins_count = 3 -- number of login attempts allowed, default is 3
+cthrottler_time = 60 -- .. in number of seconds, default is 60
+```
+
+Info
+====
+
+-   0.8, works
+-   0.9, works