Diff

mod_report_tracker/README.markdown @ 6063:b04518fa0987

mod_report_tracker: Keep track of spam/abuse reports about local JIDs
author Matthew Wild <mwild1@gmail.com>
date Mon, 25 Nov 2024 13:12:20 +0000
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_report_tracker/README.markdown	Mon Nov 25 13:12:20 2024 +0000
@@ -0,0 +1,32 @@
+---
+labels:
+- 'Stage-Alpha'
+summary: 'Track abuse/spam reports from remote servers'
+---
+
+This module tracks reports received from remote servers about local user
+accounts. The count of reports and the servers they came from is stored for
+inspection by the admin or for use by other modules which might take action
+against the reported accounts.
+
+## Configuration
+
+### Trusted reporters
+
+You can configure which servers the module will trust reports from:
+
+```
+trusted_reporters = { "example.com", "example.net" }
+```
+
+Reports from non-domain JIDs are currently always ignored (even if listed).
+
+Reports from domain JIDs which are not listed here are logged so the admin
+can decide whether to add them to the configured list.
+
+## Compatibility
+
+Should work with 0.12, but has not been tested.
+
+Tested with trunk (2024-11-22).
+