mod_blocking/README.markdown
author Kim Alvefur <zash@zash.se>
Mon, 12 Feb 2024 15:44:38 +0100
changeset 5841 7d11a3133d17
parent 5840 51c08960cba3
permissions -rw-r--r--
mod_blocking: Drop mention of mod_privacy
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
1807
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1786
diff changeset
     1
---
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1786
diff changeset
     2
labels:
5840
51c08960cba3 mod_blocking: Deprecate
Kim Alvefur <zash@zash.se>
parents: 2236
diff changeset
     3
- Stage-Deprecated
51c08960cba3 mod_blocking: Deprecate
Kim Alvefur <zash@zash.se>
parents: 2236
diff changeset
     4
rockspec:
51c08960cba3 mod_blocking: Deprecate
Kim Alvefur <zash@zash.se>
parents: 2236
diff changeset
     5
  dependencies:
51c08960cba3 mod_blocking: Deprecate
Kim Alvefur <zash@zash.se>
parents: 2236
diff changeset
     6
  - mod_privacy_lists
51c08960cba3 mod_blocking: Deprecate
Kim Alvefur <zash@zash.se>
parents: 2236
diff changeset
     7
summary: "XEP-0191: Simple Communications Blocking support"
51c08960cba3 mod_blocking: Deprecate
Kim Alvefur <zash@zash.se>
parents: 2236
diff changeset
     8
---
51c08960cba3 mod_blocking: Deprecate
Kim Alvefur <zash@zash.se>
parents: 2236
diff changeset
     9
51c08960cba3 mod_blocking: Deprecate
Kim Alvefur <zash@zash.se>
parents: 2236
diff changeset
    10
::: {.alert .alert-warning}
51c08960cba3 mod_blocking: Deprecate
Kim Alvefur <zash@zash.se>
parents: 2236
diff changeset
    11
This module is deprecated as it depends on the deprecated
51c08960cba3 mod_blocking: Deprecate
Kim Alvefur <zash@zash.se>
parents: 2236
diff changeset
    12
[mod_privacy_lists], use the core module
51c08960cba3 mod_blocking: Deprecate
Kim Alvefur <zash@zash.se>
parents: 2236
diff changeset
    13
[mod_blocklist][doc:modules:mod_blocklist] instead.
51c08960cba3 mod_blocking: Deprecate
Kim Alvefur <zash@zash.se>
parents: 2236
diff changeset
    14
:::
1786
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    15
1807
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1786
diff changeset
    16
Introduction
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1786
diff changeset
    17
============
1786
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    18
1807
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1786
diff changeset
    19
Privacy lists are a widely implemented protocol for instructing your
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1786
diff changeset
    20
server on blocking communications with selected users and services.
1786
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    21
1807
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1786
diff changeset
    22
However experience has shown that the power and flexibility of the
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1786
diff changeset
    23
rule-based system that privacy lists allow is very often much more
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1786
diff changeset
    24
complex than the user needs, and that in most cases a simple block on
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1786
diff changeset
    25
all communications to or from a list of specified JIDs would suffice.
1786
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    26
1807
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1786
diff changeset
    27
Such a protocol would also allow much simpler user interface design than
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1786
diff changeset
    28
the current attempts at full privacy list interfaces.
1786
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    29
1807
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1786
diff changeset
    30
Details
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1786
diff changeset
    31
=======
1786
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    32
1807
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1786
diff changeset
    33
Simple Communications Blocking was developed to solve the above issues,
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1786
diff changeset
    34
and allows the client to manage a simple list of blocked JIDs. This
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1786
diff changeset
    35
plugin implements support for that protocol in Prosody, however the
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1786
diff changeset
    36
actual blocking is still managed by mod\_privacy, so it is **required**
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1786
diff changeset
    37
for that plugin to be loaded (this may change in future).
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1786
diff changeset
    38
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1786
diff changeset
    39
An XEP-0191 implementation without dependency on mod\_privacy is
2236
836b36d8bfd2 mod_blocking/README: Use magic autolinking
Kim Alvefur <zash@zash.se>
parents: 1807
diff changeset
    40
available in Prosody 0.10 as [mod\_blocklist][doc:modules:mod_blocklist].
1807
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1786
diff changeset
    41
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1786
diff changeset
    42
Configuration
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1786
diff changeset
    43
=============
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1786
diff changeset
    44
5841
7d11a3133d17 mod_blocking: Drop mention of mod_privacy
Kim Alvefur <zash@zash.se>
parents: 5840
diff changeset
    45
Simply ensure that [mod_privacy_lists] and mod_blocking are loaded in
7d11a3133d17 mod_blocking: Drop mention of mod_privacy
Kim Alvefur <zash@zash.se>
parents: 5840
diff changeset
    46
your modules_enabled list:
1786
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    47
1807
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1786
diff changeset
    48
        modules_enabled = {
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1786
diff changeset
    49
                        -- ...
5841
7d11a3133d17 mod_blocking: Drop mention of mod_privacy
Kim Alvefur <zash@zash.se>
parents: 5840
diff changeset
    50
                        "privacy_lists",
1807
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1786
diff changeset
    51
                        "blocking",
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1786
diff changeset
    52
                        -- ...
1786
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    53
1807
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1786
diff changeset
    54
Compatibility
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1786
diff changeset
    55
=============
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1786
diff changeset
    56
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1786
diff changeset
    57
  ------ ---------------------------------------------
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1786
diff changeset
    58
  0.10   Works but will conflict with mod\_blocklist
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1786
diff changeset
    59
  0.9    Works
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1786
diff changeset
    60
  0.8    Works
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1786
diff changeset
    61
  0.7    Works
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1786
diff changeset
    62
  0.6    Doesn't work
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1786
diff changeset
    63
  ------ ---------------------------------------------