annotate mod_c2s_conn_throttle.wiki @ 325:f4bacc3c5ac6

add wiki.
author Marco Cirillo <maranda@lightwitch.org>
date Tue, 12 Mar 2013 18:08:28 +0000
parents
children 8fe2ec8a9f77
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
f4bacc3c5ac6 add wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
6 This module allows to throttle those client connections which exceed a [n]*[second] limit.
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">
f4bacc3c5ac6 add wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
15 cthrottler_logins_count = 3 -- number of logins attempt allowed, default is 3
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