annotate mod_c2s_conn_throttle.wiki @ 389:b4f1aeb37ae7

Describe the actual feature
author Kim Alvefur <zash@zash.se>
date Mon, 15 Jul 2013 01:56:57 +0200
parents 5597754f81ea
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
325
f4bacc3c5ac6 add wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
1 #summary c2s connections throttling module
f4bacc3c5ac6 add wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
2 #labels Stage-Stable
f4bacc3c5ac6 add wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
3
f4bacc3c5ac6 add wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
4 = Introduction =
f4bacc3c5ac6 add wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
5
326
8fe2ec8a9f77 slight correction to the wiki.
Marco Cirillo <maranda@lightwitch.org>
parents: 325
diff changeset
6 This module allows to throttle those client connections which exceed a n*seconds limit.
325
f4bacc3c5ac6 add wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
7
f4bacc3c5ac6 add wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
8 = Usage =
f4bacc3c5ac6 add wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
9
f4bacc3c5ac6 add wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
10 Copy the module folder into your prosody modules directory.
f4bacc3c5ac6 add wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
11 Place the module between your enabled modules either into the global or a vhost section.
f4bacc3c5ac6 add wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
12
f4bacc3c5ac6 add wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
13 Optional configuration directives:
f4bacc3c5ac6 add wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
14 <code language="lua">
327
5597754f81ea correct grammar mistake.
Marco Cirillo <maranda@lightwitch.org>
parents: 326
diff changeset
15 cthrottler_logins_count = 3 -- number of login attempts allowed, default is 3
325
f4bacc3c5ac6 add wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
16 cthrottler_time = 60 -- .. in number of seconds, default is 60
f4bacc3c5ac6 add wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
17 </code>
f4bacc3c5ac6 add wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
18
f4bacc3c5ac6 add wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
19 = Info =
f4bacc3c5ac6 add wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
20
f4bacc3c5ac6 add wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
21 * 0.8, works
f4bacc3c5ac6 add wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
22 * 0.9, works