Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/t2bot/synapse-simple-antispam
A simple spam checker module for Synapse to block invites from unwanted homeservers
https://github.com/t2bot/synapse-simple-antispam
Last synced: 5 days ago
JSON representation
A simple spam checker module for Synapse to block invites from unwanted homeservers
- Host: GitHub
- URL: https://github.com/t2bot/synapse-simple-antispam
- Owner: t2bot
- License: apache-2.0
- Created: 2019-08-10T20:31:51.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2022-07-14T17:24:37.000Z (over 2 years ago)
- Last Synced: 2024-08-02T12:46:58.287Z (3 months ago)
- Language: Python
- Size: 17.6 KB
- Stars: 34
- Watchers: 3
- Forks: 12
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-starred - t2bot/synapse-simple-antispam - A simple spam checker module for Synapse to block invites from unwanted homeservers (others)
README
# synapse-simple-antispam
A simple spam checker module for Synapse to block invites from unwanted homeservers
## Installation
In your Synapse python environment:
```bash
pip install git+https://github.com/t2bot/synapse-simple-antispam#egg=synapse-simple-antispam
```
Then add to your `homeserver.yaml`:
```yaml
modules:
# Module to block invites from listed homeservers
- module: "synapse_simple_antispam.AntiSpamInvites"
config:
# A list of homeservers to block invites from.
blocked_homeservers:
- badcorp.example.org
- evil.example.com
# Module to block messages from listed homeservers
- module: "synapse_simple_antispam.AntiSpamHomeserverMessages"
config:
# If true, the blocked messages will be soft failed by synapse.
# Soft failing can help prevent messages from going down sync streams.
soft_fail: false
# A list of homeservers to block messages from.
blocked_homeservers:
- badcorp.example.org
- evil.example.com
# Module to block messages with the given text
- module: "synapse_simple_antispam.AntiSpamText"
config:
# If true, the blocked messages will be soft failed by synapse.
# Soft failing can help prevent messages from going down sync streams.
soft_fail: false
blocked_messages:
- "This is spam. Spammy spam spam."
# Module to block messages with the given text regexes
- module: "synapse_simple_antispam.AntiSpamRegex"
config:
# If true, the blocked messages will be soft failed by synapse.
# Soft failing can help prevent messages from going down sync streams.
soft_fail: false
blocked_messages:
- "spam" # "spam" anywhere in the message
- "sp[am]+" # "spammmm", "spaaaammmmm", etc
```
Synapse will need to be restarted to apply the changes. To modify the list of homeservers,
update the config and restart Synapse.