PrivateCoffee/matrix-reportbot
4
0
Fork 0
Code Issues 1 Pull requests Projects Releases Packages Wiki Activity Actions
No description
133 commits 1 branch 3 tags 501 KiB
Find a file
Exact
Kumi b9cae8e168 Merge pull request 'chore: Configure Renovate' (#1) from renovate/configure into main 
Reviewed-on: #1
2025-03-06 08:01:11 +00:00
src/matrix_reportbot refactor(bot): remove file upload functionality 2024-05-18 17:41:40 +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
get_access_token.py refactor: simplify authentication process 2024-05-05 19:48:56 +02:00
LICENSE Created RSSBot 2024-03-02 15:31:14 +01:00
pyproject.toml fix: bugfix release v0.0.3, fix invite handling 2024-05-18 15:38:22 +02:00
README.md feat: transform Matrix-RSSBot into Matrix-ReportBot 2024-05-05 19:21:18 +02:00
renovate.json Add renovate.json 2025-03-06 07:25:30 +00:00
reportbot.service fix: update reportbot startup command 2024-05-05 19:46:15 +02:00

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.