Mercurial > prosody-modules

comparison mod_muc_ban_ip/README.wiki @ 1782:29f3d6b7ad16

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Import wiki pages
author Kim Alvefur <zash@zash.se>
date Mon, 24 Aug 2015 16:43:56 +0200
parents
children
comparison
equal deleted inserted replaced
1781:12ac88940fe3 1782:29f3d6b7ad16
1 #summary Ban users from chatrooms by their IP address
2 #labels Stage-Alpha
3
4 = Introduction =
5
6 One frequent complaint about XMPP chatrooms (MUCs) compared to IRC is the inability for a room admin to ban a user based on their IP address. This is because an XMPP user is not identified on the network by their IP address, only their JID.
7
8 This means that it is possible to create a new account (usually quite easily), and rejoin the room that you were banned from.
9
10 This module allows the *user's* server to enforce bans by IP address, which is very desirable for server admins who want to prevent their server being used for spamming and abusive behaviour.
11
12 = Details =
13
14 An important point to note is that this module enforces the IP ban on the banned user's server, not on the MUC server. This means that:
15
16 * The user's server MUST have this module loaded, however -
17 * The module works even when the MUC is on a different server to the user
18 * The MUC server does not need this module (it only needs to support the [http://xmpp.org/extensions/xep-0045.html#ban standard ban protocol])
19 * The module works for effectively banning [http://prosody.im/doc/anonymous_logins anonymous users]
20
21 Also note that IP bans are not saved permanently, and are reset upon a server restart.
22
23 = Configuration =
24
25 There is no extra configuration for this module except for loading it. Remember... do not load it on the MUC host, simply add it to your global `modules_enabled` list, or under a specific host like:
26
27 {{{
28 VirtualHost "anon.example.com"
29 authentication = "anonymous"
30 modules_enabled = { "muc_ban_ip" }
31 }}}
32
33 = Compatibility =
34 || 0.9 || Works ||
35 || 0.8 || Doesn't work ||