25b69fb7f1* Revert "bump tensorflow and nsfwjs (#628)" This reverts commit |
||
|---|---|---|
| .github | ||
| .well-known | ||
| config | ||
| docs | ||
| src | ||
| synapse_antispam | ||
| test | ||
| .dockerignore | ||
| .gitignore | ||
| .prettierignore | ||
| .prettierrc.js | ||
| CONTRIBUTING.md | ||
| Dockerfile | ||
| LICENSE | ||
| mjolnir-entrypoint.sh | ||
| mx-tester.yml | ||
| package.json | ||
| README.md | ||
| releasing.md | ||
| test_tree.jpg | ||
| tsconfig.json | ||
| tslint.json | ||
| yarn.lock | ||
mjolnir
A moderation tool for Matrix. Visit #mjolnir:matrix.org for more information.
Features
As an all-in-one moderation tool, it can protect your server from malicious invites, spam messages, and whatever else you don't want. In addition to server-level protection, Mjolnir is great for communities wanting to protect their rooms without having to use their personal accounts for moderation.
The bot by default includes support for bans, redactions, anti-spam, server ACLs, room directory changes, room alias transfers, account deactivation, room shutdown, and more.
A Synapse module is also available to apply the same rulesets the bot uses across an entire homeserver.
Setting up
See the setup documentation for first-time setup documentation.
See the configuration sample with documentation for detailed information about Mjolnir's configuration.
See the synapse module documentation for information on how to setup Mjolnir's accompanying Synapse Module.
Quickstart guide
After your bot is up and running, you'll want to run a couple commands to get everything set up:
!mjolnir list create COC code-of-conduct-ban-list- This will create a new ban list with the shortcodeCOCand an alias of#code-of-conduct-ban-list:example.org. You will be invited to the room it creates automatically where you can change settings such as the visibility of the room.!mjolnir default COC- This sets the default ban list to the list we just created to help with the ban commands later on.- Review the Moderator's Guide.
- Review
!mjolnir helpto see what else the bot can do.
Enabling readable abuse reports
Since version 1.2, Mjölnir offers the ability to replace the Matrix endpoint used to report abuse and display it into a room, instead of requiring you to request this data from an admin API.
This requires two configuration steps:
- In your Mjölnir configuration file, typically
/etc/mjolnir/config/production.yaml, copy and paste thewebsection fromdefault.yaml, if you don't have it yet (it appears with version 1.20) and setenabled: truefor bothwebandabuseReporting. - Setup a reverse proxy that will redirect requests from
^/_matrix/client/(r0|v3)/rooms/([^/]*)/report/(.*)$tohttp://host:port/api/1/report/$2/$3, wherehostis the host where you run Mjölnir, andportis the port you configured inproduction.yaml. For an example nginx configuration, seetest/nginx.conf. It's the confirmation we use during runtime testing.
Security note
This mechanism can extract some information from unencrypted rooms. We have taken precautions to ensure that this cannot be abused: the only case in which this feature will publish information from room foo is:
- If it is used by a member of room foo; AND
- If said member did witness the event; AND
- If the event was unencrypted; AND
- If the event was not redacted/removed/...
Essentially, this is a more restricted variant of the Admin APIs available on homeservers.
However, if you are uncomfortable with this, please do not activate this feature.
Also, you should probably setup your production.yaml to ensure that the web
server can only receive requests from your reverse proxy (e.g. localhost).
Development
See CONTRIBUTING.md.