annotate mod_blocking.wiki @ 282:caffa894b070

Add table of config options with descriptions
author MWild1@gmail.com
date Sat, 26 May 2012 21:13:49 +0000
parents 6abd50682378
children deb4182a7b61
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
134
6abd50682378 Created wiki page through web user interface.
MWild1
parents:
diff changeset
1 #summary XEP-0191: Simple Communications Blocking support
6abd50682378 Created wiki page through web user interface.
MWild1
parents:
diff changeset
2 #labels Stage-Alpha
6abd50682378 Created wiki page through web user interface.
MWild1
parents:
diff changeset
3
6abd50682378 Created wiki page through web user interface.
MWild1
parents:
diff changeset
4 = Introduction =
6abd50682378 Created wiki page through web user interface.
MWild1
parents:
diff changeset
5
6abd50682378 Created wiki page through web user interface.
MWild1
parents:
diff changeset
6 Privacy lists are a widely implemented protocol for instructing your server on blocking communications with selected users and services.
6abd50682378 Created wiki page through web user interface.
MWild1
parents:
diff changeset
7
6abd50682378 Created wiki page through web user interface.
MWild1
parents:
diff changeset
8 However experience has shown that the power and flexibility of the rule-based system that privacy lists allow is very often much more complex than the user needs, and that in most cases a simple block on all communications to or from a list of specified JIDs would suffice.
6abd50682378 Created wiki page through web user interface.
MWild1
parents:
diff changeset
9
6abd50682378 Created wiki page through web user interface.
MWild1
parents:
diff changeset
10 Such a protocol would also allow much simpler user interface design than the current attempts at full privacy list interfaces.
6abd50682378 Created wiki page through web user interface.
MWild1
parents:
diff changeset
11
6abd50682378 Created wiki page through web user interface.
MWild1
parents:
diff changeset
12 = Details =
6abd50682378 Created wiki page through web user interface.
MWild1
parents:
diff changeset
13
6abd50682378 Created wiki page through web user interface.
MWild1
parents:
diff changeset
14 Simple Communications Blocking was developed to solve the above issues, and allows the client to manage a simple list of blocked JIDs. This plugin implements support for that protocol in Prosody, however the actual blocking is still managed by mod_privacy, so it is *required* for that plugin to be loaded (this may change in future).
6abd50682378 Created wiki page through web user interface.
MWild1
parents:
diff changeset
15
6abd50682378 Created wiki page through web user interface.
MWild1
parents:
diff changeset
16 = Configuration =
6abd50682378 Created wiki page through web user interface.
MWild1
parents:
diff changeset
17 Simply ensure that mod_privacy and mod_blocking are loaded in your modules_enabled list:
6abd50682378 Created wiki page through web user interface.
MWild1
parents:
diff changeset
18
6abd50682378 Created wiki page through web user interface.
MWild1
parents:
diff changeset
19 {{{
6abd50682378 Created wiki page through web user interface.
MWild1
parents:
diff changeset
20 modules_enabled = {
6abd50682378 Created wiki page through web user interface.
MWild1
parents:
diff changeset
21 -- ...
6abd50682378 Created wiki page through web user interface.
MWild1
parents:
diff changeset
22 "privacy",
6abd50682378 Created wiki page through web user interface.
MWild1
parents:
diff changeset
23 "blocking",
6abd50682378 Created wiki page through web user interface.
MWild1
parents:
diff changeset
24 -- ...
6abd50682378 Created wiki page through web user interface.
MWild1
parents:
diff changeset
25 }}}
6abd50682378 Created wiki page through web user interface.
MWild1
parents:
diff changeset
26
6abd50682378 Created wiki page through web user interface.
MWild1
parents:
diff changeset
27 = Compatibility =
6abd50682378 Created wiki page through web user interface.
MWild1
parents:
diff changeset
28 ||0.8||Works||
6abd50682378 Created wiki page through web user interface.
MWild1
parents:
diff changeset
29 ||0.7||Works||
6abd50682378 Created wiki page through web user interface.
MWild1
parents:
diff changeset
30 ||0.6||Doesn't work||