Go to file
David eb710a0efe Added logic to detect and remove spam 2023-01-06 23:09:55 +01:00
src Added logic to detect and remove spam 2023-01-06 23:09:55 +01:00
tests Added function to delete swears from room when detected 2023-01-01 14:31:03 +01:00
.gitignore Finished functionality to get swear list 2022-12-21 10:28:11 +01:00
.gitlab-ci.yml Decreased expire time for artifacts 2023-01-03 18:43:00 +01:00
Cargo.toml Added way to add more data to key in sled 2023-01-05 20:39:26 +01:00
Dockerfile Modified CI/CD pipeline to build only once 2022-12-31 13:10:16 +01:00
LICENSE Added readme and set license 2022-11-08 15:36:51 +01:00
README.md Fixed typo in url 2023-01-03 17:40:51 +00:00

README.md

Matrix Modbot

Matrix Modbot is a bot for Matrix used to automatically moderate Matrix rooms.

Who is this bot for?

The bot is orientated towards admins of large Matrix rooms that are public and require moderation. With this bot, simple jobs such as swear filtering and spam prevention could be accomplished without intervention of human moderators.

How to run?

Using Docker: A minimal Docker image containing the compiled binary is published on Docker Hub. Note that this image is automatically pushed using a CI/CD Pipeline for every commit made to the main branch. Expect there to be bugs and breaking changes. sudo docker run -v /local/path/to/config.ini:/config.ini -t matrix-modbot:latest

Using Cargo:

cargo build --release
cargo run /path/to/config.ini