Go to file
David 1eb0a7edcc Added artifact return for ci/cd 2022-12-30 11:31:21 +01:00
src Made main function async 2022-12-30 10:50:26 +01:00
tests Finished functionality to get swear list 2022-12-21 10:28:11 +01:00
.gitignore Finished functionality to get swear list 2022-12-21 10:28:11 +01:00
.gitlab-ci.yml Added artifact return for ci/cd 2022-12-30 11:31:21 +01:00
Cargo.toml Added options to reduce binary size 2022-12-30 11:00:09 +01:00
Dockerfile Modified ci/cd to push dockerfile to dockerhub 2022-12-29 23:44:23 +01:00
LICENSE Added readme and set license 2022-11-08 15:36:51 +01:00
README.md Made main function async 2022-12-30 10:50:26 +01: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