mirror of
https://github.com/matrix-org/mjolnir.git
synced 2024-10-01 01:36:06 -04:00
A moderation tool for Matrix
130e44abcf
We can only do ban on sight because it's impossible to ban `@*:example.org` without knowing what `*` is. |
||
|---|---|---|
| config | ||
| src | ||
| .dockerignore | ||
| .gitignore | ||
| Dockerfile | ||
| LICENSE | ||
| package.json | ||
| README.md | ||
| tsconfig.json | ||
| tslint.json | ||
| yarn.lock | ||
mjolnir
A moderation tool for Matrix.
Features
TODO: Describe what all this means.
Phase 1:
- Ban users
- ACL servers
- Update lists with new bans/ACLs
Phase 2:
- Synapse antispam module
- Riot hooks (independent of mjolnir?)
- Support community-defined scopes? (ie: no hardcoded config)
- Vet rooms on startup option
- Room upgrade handling (both protected+list rooms)
Docker (preferred)
Mjolnir does not yet have its own image published.
git clone https://github.com/matrix-org/mjolnir.git
cd mjolnir
docker build -t 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 mjolnir
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.