Diff

mod_blocking/README.markdown @ 1803:4d73a1a6ba68

Convert all wiki pages to Markdown
author Kim Alvefur <zash@zash.se>
date Fri, 28 Aug 2015 18:03:58 +0200
parent 1782:29f3d6b7ad16
child 2232:836b36d8bfd2
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_blocking/README.markdown	Fri Aug 28 18:03:58 2015 +0200
@@ -0,0 +1,55 @@
+---
+labels:
+- 'Stage-Alpha'
+summary: 'XEP-0191: Simple Communications Blocking support'
+...
+
+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
+[mod\_blocklist](https://prosody.im/doc/modules/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
+  ------ ---------------------------------------------