Matrix-Mirrors/mjolnir
1
0
Fork 0
mirror of https://github.com/matrix-org/mjolnir.git synced 2024-06-30 16:41:29 +00:00
Code Issues Packages Projects Releases Wiki Activity
A moderation tool for Matrix
68 Commits 140 Branches 37 Tags 3 MiB
TypeScript 97.5%
Python 2.3%
Shell 0.1%
30e186ca9c
Go to file
Travis Ralston 30e186ca9c Add a config option to reduce homeserver load during ban checks
2019-11-06 18:54:59 -07:00
config Add a config option to reduce homeserver load during ban checks 2019-11-06 18:54:59 -07:00
docs Add a moderator's guide to Mjolnir 2019-10-28 20:20:47 -06:00
src Add a config option to reduce homeserver load during ban checks 2019-11-06 18:54:59 -07:00
.dockerignore Absolute bare minimum for a bot 2019-09-25 20:13:20 -06:00
.gitignore Absolute bare minimum for a bot 2019-09-25 20:13:20 -06:00
Dockerfile Use yarn in the docker image too 2019-10-31 10:55:44 -06:00
LICENSE Initial commit 2019-09-25 19:36:12 -06:00
package.json Upgrade to beta.12 of the bot-sdk 2019-11-06 15:37:43 -07:00
README.md Add a way to actually unban people 2019-10-10 12:37:42 +01:00
tsconfig.json Absolute bare minimum for a bot 2019-09-25 20:13:20 -06:00
tslint.json Fix tlsint 2019-09-27 13:54:34 -06:00
yarn.lock Upgrade to beta.12 of the bot-sdk 2019-11-06 15:37:43 -07:00

README.md

mjolnir

A moderation tool for Matrix. Visit #mjolnir:matrix.org for more information.

Features

TODO: Describe what all this means.

Phase 1:

  • Ban users
  • ACL servers
  • Update lists with new bans/ACLs

Phase 2:

  • Pantalaimon support
  • No-op mode (for verifying behaviour)
  • Redact messages on ban (optionally)
  • More useful spam in management room
  • Command to import ACLs, etc from rooms
  • Vet rooms on startup option
  • Command to actually unban users (instead of leaving them stuck)
  • Support multiple lists

Phase 3:

  • Synapse antispam module
  • Room upgrade handling (both protected+list rooms)
  • Support community-defined scopes? (ie: no hardcoded config)
  • Riot hooks (independent of mjolnir?)

Docker (preferred)

Mjolnir is on Docker Hub as matrixdotorg/mjolnir but can be built yourself with docker build -t mjolnir ..

git clone https://github.com/matrix-org/mjolnir.git
cd mjolnir

# Copy and edit the config. It is not recommended to change the data path.
mkdir -p /etc/mjolnir
cp config/default.yaml /etc/mjolnir/production.yaml
nano /etc/mjolnir/production.yaml

docker run --rm -it -v /etc/mjolnir:/data matrixdotorg/mjolnir:latest

Build it

This bot requires yarn and Node 10.

git clone https://github.com/matrix-org/mjolnir.git
cd mjolnir

yarn install
yarn build

# Copy and edit the config. It *is* recommended to change the data path.
cp config/default.yaml config/development.yaml
nano config/development.yaml

node lib/index.js

Development

TODO. It's a TypeScript project with a linter.