https://git.private.coffee/PrivateCoffee/matrix-reportbot

Kumi 8a31063bb2 feat: transform Matrix-RSSBot into Matrix-ReportBot 6 ヶ月 前
src 8a31063bb2 feat: transform Matrix-RSSBot into Matrix-ReportBot 6 ヶ月 前
.gitignore 8a31063bb2 feat: transform Matrix-RSSBot into Matrix-ReportBot 6 ヶ月 前
LICENSE 967d738e64 Created RSSBot 8 ヶ月 前
README.md 8a31063bb2 feat: transform Matrix-RSSBot into Matrix-ReportBot 6 ヶ月 前
config.dist.ini 8a31063bb2 feat: transform Matrix-RSSBot into Matrix-ReportBot 6 ヶ月 前
pantalaimon.example.conf 57b68ef3e3 Enhance Pantalaimon integration and config 11 ヶ月 前
pantalaimon_first_login.py 57b68ef3e3 Enhance Pantalaimon integration and config 11 ヶ月 前
pyproject.toml 8a31063bb2 feat: transform Matrix-RSSBot into Matrix-ReportBot 6 ヶ月 前
reportbot-pantalaimon.service 8a31063bb2 feat: transform Matrix-RSSBot into Matrix-ReportBot 6 ヶ月 前
reportbot.service 8a31063bb2 feat: transform Matrix-RSSBot into Matrix-ReportBot 6 ヶ月 前

README.md

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.