prosody-modules
dbbbd5caf292
mod_report_tracker/README.markdown

Find changesets by keywords by author, files, the commit message, revision number or hash, or revset expression.

Software / code / prosody-modules

Annotate

mod_report_tracker/README.markdown @ 6333:dbbbd5caf292

mod_cloud_notify_encrypted: Fix variable name (thanks bronko)
author Matthew Wild <mwild1@gmail.com>
date Thu, 10 Jul 2025 10:15:35 +0100
parent 6063:b04518fa0987
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6063
b04518fa0987 mod_report_tracker: Keep track of spam/abuse reports about local JIDs
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
1 ---
b04518fa0987 mod_report_tracker: Keep track of spam/abuse reports about local JIDs
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
2 labels:
b04518fa0987 mod_report_tracker: Keep track of spam/abuse reports about local JIDs
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
3 - 'Stage-Alpha'
b04518fa0987 mod_report_tracker: Keep track of spam/abuse reports about local JIDs
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
4 summary: 'Track abuse/spam reports from remote servers'
b04518fa0987 mod_report_tracker: Keep track of spam/abuse reports about local JIDs
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
5 ---
b04518fa0987 mod_report_tracker: Keep track of spam/abuse reports about local JIDs
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
6
b04518fa0987 mod_report_tracker: Keep track of spam/abuse reports about local JIDs
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
7 This module tracks reports received from remote servers about local user
b04518fa0987 mod_report_tracker: Keep track of spam/abuse reports about local JIDs
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
8 accounts. The count of reports and the servers they came from is stored for
b04518fa0987 mod_report_tracker: Keep track of spam/abuse reports about local JIDs
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
9 inspection by the admin or for use by other modules which might take action
b04518fa0987 mod_report_tracker: Keep track of spam/abuse reports about local JIDs
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
10 against the reported accounts.
b04518fa0987 mod_report_tracker: Keep track of spam/abuse reports about local JIDs
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
11
b04518fa0987 mod_report_tracker: Keep track of spam/abuse reports about local JIDs
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
12 ## Configuration
b04518fa0987 mod_report_tracker: Keep track of spam/abuse reports about local JIDs
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
13
b04518fa0987 mod_report_tracker: Keep track of spam/abuse reports about local JIDs
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
14 ### Trusted reporters
b04518fa0987 mod_report_tracker: Keep track of spam/abuse reports about local JIDs
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
15
b04518fa0987 mod_report_tracker: Keep track of spam/abuse reports about local JIDs
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
16 You can configure which servers the module will trust reports from:
b04518fa0987 mod_report_tracker: Keep track of spam/abuse reports about local JIDs
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
17
b04518fa0987 mod_report_tracker: Keep track of spam/abuse reports about local JIDs
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
18 ```
b04518fa0987 mod_report_tracker: Keep track of spam/abuse reports about local JIDs
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
19 trusted_reporters = { "example.com", "example.net" }
b04518fa0987 mod_report_tracker: Keep track of spam/abuse reports about local JIDs
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
20 ```
b04518fa0987 mod_report_tracker: Keep track of spam/abuse reports about local JIDs
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
21
b04518fa0987 mod_report_tracker: Keep track of spam/abuse reports about local JIDs
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
22 Reports from non-domain JIDs are currently always ignored (even if listed).
b04518fa0987 mod_report_tracker: Keep track of spam/abuse reports about local JIDs
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
23
b04518fa0987 mod_report_tracker: Keep track of spam/abuse reports about local JIDs
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
24 Reports from domain JIDs which are not listed here are logged so the admin
b04518fa0987 mod_report_tracker: Keep track of spam/abuse reports about local JIDs
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
25 can decide whether to add them to the configured list.
b04518fa0987 mod_report_tracker: Keep track of spam/abuse reports about local JIDs
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
26
b04518fa0987 mod_report_tracker: Keep track of spam/abuse reports about local JIDs
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
27 ## Compatibility
b04518fa0987 mod_report_tracker: Keep track of spam/abuse reports about local JIDs
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
28
b04518fa0987 mod_report_tracker: Keep track of spam/abuse reports about local JIDs
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
29 Should work with 0.12, but has not been tested.
b04518fa0987 mod_report_tracker: Keep track of spam/abuse reports about local JIDs
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
30
b04518fa0987 mod_report_tracker: Keep track of spam/abuse reports about local JIDs
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
31 Tested with trunk (2024-11-22).
b04518fa0987 mod_report_tracker: Keep track of spam/abuse reports about local JIDs
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
32