No description
Find a file
Kumi 8a31063bb2
feat: transform Matrix-RSSBot into Matrix-ReportBot
This major overhaul shifts the project's focus from serving RSS feeds to reporting content within the Matrix ecosystem. Key changes include:
- Renaming from Matrix-RSSBot to Matrix-ReportBot, aligning the project with its new purpose.
- Removal of RSS related functionalities and incorporation of report handling capabilities, facilitating automated content reporting and monitoring in Matrix rooms.
- Introduction of new dependencies and configurations specific to the report handling features.
- Updating service configurations to ensure compatibility with the bot's new functionality.

This transformation addresses the need for a specialized tool in the Matrix community for managing and automating content reports, enhancing moderation efficiency and response time.
2024-05-05 19:21:18 +02:00
src/matrix_reportbot feat: transform Matrix-RSSBot into Matrix-ReportBot 2024-05-05 19:21:18 +02:00
.gitignore feat: transform Matrix-RSSBot into Matrix-ReportBot 2024-05-05 19:21:18 +02:00
config.dist.ini feat: transform Matrix-RSSBot into Matrix-ReportBot 2024-05-05 19:21:18 +02:00
LICENSE Created RSSBot 2024-03-02 15:31:14 +01:00
pantalaimon.example.conf Enhance Pantalaimon integration and config 2023-12-05 10:09:14 +01:00
pantalaimon_first_login.py Enhance Pantalaimon integration and config 2023-12-05 10:09:14 +01:00
pyproject.toml feat: transform Matrix-RSSBot into Matrix-ReportBot 2024-05-05 19:21:18 +02:00
README.md feat: transform Matrix-RSSBot into Matrix-ReportBot 2024-05-05 19:21:18 +02:00
reportbot-pantalaimon.service feat: transform Matrix-RSSBot into Matrix-ReportBot 2024-05-05 19:21:18 +02:00
reportbot.service feat: transform Matrix-RSSBot into Matrix-ReportBot 2024-05-05 19:21:18 +02:00

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.