Software / code / prosody-modules
Diff
mod_firewall/README.markdown @ 4583:bb8459c220c9
mod_firewall: Documentation updates to reduce confusion and use inclusive language
| author | Matthew Wild <mwild1@gmail.com> |
|---|---|
| date | Sat, 05 Jun 2021 16:23:21 +0100 |
| parent | 4236:c316ad1087d4 |
| child | 4965:d7684aa81d8f |
line wrap: on
line diff
--- a/mod_firewall/README.markdown Sat Jun 05 16:22:22 2021 +0100 +++ b/mod_firewall/README.markdown Sat Jun 05 16:23:21 2021 +0100 @@ -126,8 +126,9 @@ ### Lists -It is possible to create or load lists of strings for use in scripts. For example, you might load a JID blacklist, -a list of malware URLs or simple words that you want to filter messages on. +It is possible to create or load lists of strings for use in scripts. For +example, you might load a list of blocked JIDs, malware URLs or simple words +that you want to filter messages on. List type Example ----------- ----------------------- @@ -183,13 +184,13 @@ Example: - %LIST blacklist: file:/etc/prosody/blacklist.txt + %LIST blocked_jids: file:/etc/prosody/blocked_jids.txt - # Rule to block presence subscription requests from blacklisted JIDs + # Rule to block presence subscription requests from blocked JIDs KIND: presence TYPE: subscribe - CHECK LIST: blacklist contains $<@from> - BOUNCE=policy-violation (Your JID is blacklisted) + CHECK LIST: blocked_jids contains $<@from> + BOUNCE=policy-violation (Your JID is blocked) #### SCAN @@ -279,8 +280,8 @@ FROM: <<admin%d*>>@example.com **Note:** It is important to know that 'example.com' is a valid JID on -its own, and does **not** match 'user@example.com'. To perform domain -whitelists or blacklists, use [Zones](#zones). +its own, and does **not** match 'user@example.com'. To efficiently match +domains we recommend defining them as [Zones](#zones). Condition Matches ---------------- ---------------------------------------------------------------
