Kumi
e3ea1be260
Removed the methods `upload_file`, `send_image`, and `send_file` from the ReportBot class to streamline the bot's functionality, focusing on handling reports rather than managing file uploads. This change simplifies the bot's codebase and aligns with our goal to sharpen its focus on core reporting features. Additionally, updated bare `except:` statements to `except Exception:` for better error handling practices. |
||
|---|---|---|
| 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.