diff mod_blocking/README.wiki @ 1782:29f3d6b7ad16

Import wiki pages
author Kim Alvefur <zash@zash.se>
date Mon, 24 Aug 2015 16:43:56 +0200
parents
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_blocking/README.wiki	Mon Aug 24 16:43:56 2015 +0200
@@ -0,0 +1,34 @@
+#summary XEP-0191: Simple Communications Blocking support
+#labels Stage-Alpha
+
+= Introduction =
+
+Privacy lists are a widely implemented protocol for instructing your server on blocking communications with selected users and services.
+
+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.
+
+Such a protocol would also allow much simpler user interface design than the current attempts at full privacy list interfaces.
+
+= Details =
+
+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).
+
+An XEP-0191 implementation without dependency on mod_privacy is available in Prosody 0.10 as [https://prosody.im/doc/modules/mod_blocklist mod_blocklist].
+
+= Configuration =
+Simply ensure that mod_privacy (or mod_privacy_lists in 0.10+) and mod_blocking are loaded in your modules_enabled list:
+
+{{{
+    modules_enabled = {
+                    -- ...
+                    "privacy", -- or privacy_lists in Prosody 0.10+
+                    "blocking",
+                    -- ...
+}}}
+
+= Compatibility =
+||0.10||Works but will conflict with mod_blocklist||
+||0.9||Works||
+||0.8||Works||
+||0.7||Works||
+||0.6||Doesn't work||
\ No newline at end of file