README.md 1.6 KB

Matrix-ReportBot

Support Private.coffee! PyPI PyPI - Python Version PyPI - License Latest Git Commit

This is a simple bot that can be used to display incoming moderation reports in a Matrix room.

Installation

pip install matrix-reportbot

Create a configuration file in config.ini based on the config.dist.ini provided in the repository.

At the very least, you need to provide the following configuration:

[Matrix]
Homeserver = http://your-homeserver.example.com
AccessToken = syt_YourAccessTokenHere
RoomId = !yourRoomId:your-homeserver.example.com

Note: The AccessToken must be for a admin user, because the bot needs to be able to read the moderation events.

We recommend using pantalaimon as a proxy, because the bot itself does not support end-to-end encryption.

You can start the bot by running:

reportbot

License

This project is licensed under the MIT License - see the LICENSE file for details.