Skip to main content

Simple content report subscription bot for Matrix.

Project description

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

matrix_reportbot-0.0.3.tar.gz (8.8 kB view details)

Uploaded Source

Built Distribution

matrix_reportbot-0.0.3-py3-none-any.whl (9.8 kB view details)

Uploaded Python 3

File details

Details for the file matrix_reportbot-0.0.3.tar.gz.

File metadata

  • Download URL: matrix_reportbot-0.0.3.tar.gz
  • Upload date:
  • Size: 8.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.3

File hashes

Hashes for matrix_reportbot-0.0.3.tar.gz
Algorithm Hash digest
SHA256 c17a592c15613f5724a2cd982bca9d6ba9de54849f18c468c74fe010d262e9ec
MD5 535bd92f5d1dd39b61638f76bc5d2891
BLAKE2b-256 619fa3dec4273fc520830472bfae58f546c5d7cf042c770e063fce9297bf6a15

See more details on using hashes here.

File details

Details for the file matrix_reportbot-0.0.3-py3-none-any.whl.

File metadata

File hashes

Hashes for matrix_reportbot-0.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 df732c68399352a18c954931a587d2a5f504870f0490e4de6f0ba79bb807249b
MD5 6d4561719a254282098f94eab830f470
BLAKE2b-256 f5620ce31bdaa3dd8ed3141098e898175765a09c7e3c415aedc8e5fa4617cdd8

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page