From f72b68dc7cd45a5495857110233fec5c67e9eab9 Mon Sep 17 00:00:00 2001 From: Travis Ralston Date: Thu, 31 Oct 2019 08:34:58 -0600 Subject: [PATCH] Add a description for what Mjolnir's antispam module does --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index ff3517b2..a3b7eb8a 100644 --- a/README.md +++ b/README.md @@ -65,6 +65,11 @@ node lib/index.js ## Synapse Antispam Module +Using the bot to manage your rooms is great, however if you want to use your ban lists +(or someone else's) on your server to affect all of your users then an antispam module +is needed. Primarily meant to block invites from undesired homeservers/users, Mjolnir's +antispam module is a way to interpret ban lists and apply them to your entire homeserver. + First, install the module to your Synapse python environment: ``` pip install -e git+https://github.com/matrix-org/mjolnir.git#egg=mjolnir&subdirectory=synapse_antispam