No description
Kumi
8f2cc288ad
Updated the version of matrix-reportbot to 0.0.2 in `pyproject.toml` to reflect new features and improvements in the application. This version increment signifies progress in the development cycle and prepares the project for upcoming releases. This update is a part of our regular maintenance and feature rollout schedule, ensuring the application stays up-to-date with the latest enhancements for our users and contributors. |
||
---|---|---|
src/matrix_reportbot | ||
.gitignore | ||
config.dist.ini | ||
get_access_token.py | ||
LICENSE | ||
pyproject.toml | ||
README.md | ||
reportbot.service |
Matrix-ReportBot
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.