Mercurial > prosody-modules

comparison mod_muc_ban_ip/README.markdown @ 1803:4d73a1a6ba68

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