annotate mod_muc_ban_ip.wiki @ 373:c929df198f10

Mark pages of modules no longer in the repo as Deprecated
author Kim Alvefur <zash@zash.se>
date Fri, 28 Jun 2013 19:55:59 +0200
parents 0e0883870058
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
349
f11f8c63384b Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
1 #summary Ban users from chatrooms by their IP address
f11f8c63384b Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
2 #labels Stage-Alpha
f11f8c63384b Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
3
f11f8c63384b Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
4 = Introduction =
f11f8c63384b Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
5
f11f8c63384b Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
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.
f11f8c63384b Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
7
350
0e0883870058 Edited wiki page mod_muc_ban_ip through web user interface.
MWild1@gmail.com
parents: 349
diff changeset
8 This means that it is possible to create a new account (usually quite easily), and rejoin the room that you were banned from.
349
f11f8c63384b Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
9
350
0e0883870058 Edited wiki page mod_muc_ban_ip through web user interface.
MWild1@gmail.com
parents: 349
diff changeset
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.
349
f11f8c63384b Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
11
f11f8c63384b Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
12 = Details =
f11f8c63384b Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
13
f11f8c63384b Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
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:
f11f8c63384b Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
15
f11f8c63384b Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
16 * The user's server MUST have this module loaded, however -
f11f8c63384b Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
17 * The module works even when the MUC is on a different server to the user
350
0e0883870058 Edited wiki page mod_muc_ban_ip through web user interface.
MWild1@gmail.com
parents: 349
diff changeset
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])
0e0883870058 Edited wiki page mod_muc_ban_ip through web user interface.
MWild1@gmail.com
parents: 349
diff changeset
19 * The module works for effectively banning [http://prosody.im/doc/anonymous_logins anonymous users]
349
f11f8c63384b Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
20
f11f8c63384b Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
21 Also note that IP bans are not saved permanently, and are reset upon a server restart.
f11f8c63384b Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
22
f11f8c63384b Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
23 = Configuration =
f11f8c63384b Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
24
f11f8c63384b Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
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:
f11f8c63384b Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
26
f11f8c63384b Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
27 {{{
f11f8c63384b Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
28 VirtualHost "anon.example.com"
f11f8c63384b Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
29 authentication = "anonymous"
f11f8c63384b Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
30 modules_enabled = { "muc_ban_ip" }
f11f8c63384b Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
31 }}}
f11f8c63384b Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
32
f11f8c63384b Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
33 = Compatibility =
f11f8c63384b Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
34 || 0.9 || Works ||
f11f8c63384b Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
35 || 0.8 || Doesn't work ||