PrivateCoffee/matrix-reportbot
4
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
matrix-reportbot/README.md

41 lines
1.6 KiB
Markdown
Raw Normal View History

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 17:21:18 +00:00
# Matrix-ReportBot
Initial working version
2023-04-16 14:08:57 +00:00
feat: enhance README with badges and detailed docs - Added informative badges for versioning, Python versions, license, and the latest commit to enhance project visibility and credibility. - Expanded documentation to include detailed installation, usage instructions, and added a comprehensive guide on configuring and running the bot, emphasizing the ease of set up and operation. - Recommended the use of pantalaimon for E2E encryption support, catering to user security concerns. - Included commands for adding, listing, and removing feeds, ensuring users have clear guidance on bot interaction. This update makes the project more accessible and user-friendly, encouraging adoption and contribution by providing all necessary information upfront. fix: ignore build directory in .gitignore - The `build/` directory is now ignored, preventing compiled files or artifacts from being tracked in the repository, ensuring a cleaner project structure.
2024-05-03 13:03:45 +00:00
[![Support Private.coffee!](https://shields.private.coffee/badge/private.coffee-support%20us!-pink?logo=coffeescript)](https://private.coffee)
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 17:21:18 +00:00
[![PyPI](https://shields.private.coffee/pypi/v/matrix-reportbot)](https://pypi.org/project/matrix-reportbot/)
[![PyPI - Python Version](https://shields.private.coffee/pypi/pyversions/matrix-reportbot)](https://pypi.org/project/matrix-reportbot/)
[![PyPI - License](https://shields.private.coffee/pypi/l/matrix-reportbot)](https://pypi.org/project/matrix-reportbot/)
[![Latest Git Commit](https://shields.private.coffee/gitea/last-commit/privatecoffee/matrix-reportbot?gitea_url=https://git.private.coffee)](https://git.private.coffee/privatecoffee/matrix-reportbot)
feat: enhance README with badges and detailed docs - Added informative badges for versioning, Python versions, license, and the latest commit to enhance project visibility and credibility. - Expanded documentation to include detailed installation, usage instructions, and added a comprehensive guide on configuring and running the bot, emphasizing the ease of set up and operation. - Recommended the use of pantalaimon for E2E encryption support, catering to user security concerns. - Included commands for adding, listing, and removing feeds, ensuring users have clear guidance on bot interaction. This update makes the project more accessible and user-friendly, encouraging adoption and contribution by providing all necessary information upfront. fix: ignore build directory in .gitignore - The `build/` directory is now ignored, preventing compiled files or artifacts from being tracked in the repository, ensuring a cleaner project structure.
2024-05-03 13:03:45 +00:00
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 17:21:18 +00:00
This is a simple bot that can be used to display incoming moderation reports in a Matrix room.
feat: enhance README with badges and detailed docs - Added informative badges for versioning, Python versions, license, and the latest commit to enhance project visibility and credibility. - Expanded documentation to include detailed installation, usage instructions, and added a comprehensive guide on configuring and running the bot, emphasizing the ease of set up and operation. - Recommended the use of pantalaimon for E2E encryption support, catering to user security concerns. - Included commands for adding, listing, and removing feeds, ensuring users have clear guidance on bot interaction. This update makes the project more accessible and user-friendly, encouraging adoption and contribution by providing all necessary information upfront. fix: ignore build directory in .gitignore - The `build/` directory is now ignored, preventing compiled files or artifacts from being tracked in the repository, ensuring a cleaner project structure.
2024-05-03 13:03:45 +00:00
## Installation
```bash
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 17:21:18 +00:00
pip install matrix-reportbot
feat: enhance README with badges and detailed docs - Added informative badges for versioning, Python versions, license, and the latest commit to enhance project visibility and credibility. - Expanded documentation to include detailed installation, usage instructions, and added a comprehensive guide on configuring and running the bot, emphasizing the ease of set up and operation. - Recommended the use of pantalaimon for E2E encryption support, catering to user security concerns. - Included commands for adding, listing, and removing feeds, ensuring users have clear guidance on bot interaction. This update makes the project more accessible and user-friendly, encouraging adoption and contribution by providing all necessary information upfront. fix: ignore build directory in .gitignore - The `build/` directory is now ignored, preventing compiled files or artifacts from being tracked in the repository, ensuring a cleaner project structure.
2024-05-03 13:03:45 +00:00
```
Create a configuration file in `config.ini` based on the [config.dist.ini](config.dist.ini) provided in the repository.
At the very least, you need to provide the following configuration:
```ini
[Matrix]
Homeserver = http://your-homeserver.example.com
AccessToken = syt_YourAccessTokenHere
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 17:21:18 +00:00
RoomId = !yourRoomId:your-homeserver.example.com
feat: enhance README with badges and detailed docs - Added informative badges for versioning, Python versions, license, and the latest commit to enhance project visibility and credibility. - Expanded documentation to include detailed installation, usage instructions, and added a comprehensive guide on configuring and running the bot, emphasizing the ease of set up and operation. - Recommended the use of pantalaimon for E2E encryption support, catering to user security concerns. - Included commands for adding, listing, and removing feeds, ensuring users have clear guidance on bot interaction. This update makes the project more accessible and user-friendly, encouraging adoption and contribution by providing all necessary information upfront. fix: ignore build directory in .gitignore - The `build/` directory is now ignored, preventing compiled files or artifacts from being tracked in the repository, ensuring a cleaner project structure.
2024-05-03 13:03:45 +00:00
```
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 17:21:18 +00:00
Note: The AccessToken must be for a admin user, because the bot needs to be able to read the moderation events.
feat: enhance README with badges and detailed docs - Added informative badges for versioning, Python versions, license, and the latest commit to enhance project visibility and credibility. - Expanded documentation to include detailed installation, usage instructions, and added a comprehensive guide on configuring and running the bot, emphasizing the ease of set up and operation. - Recommended the use of pantalaimon for E2E encryption support, catering to user security concerns. - Included commands for adding, listing, and removing feeds, ensuring users have clear guidance on bot interaction. This update makes the project more accessible and user-friendly, encouraging adoption and contribution by providing all necessary information upfront. fix: ignore build directory in .gitignore - The `build/` directory is now ignored, preventing compiled files or artifacts from being tracked in the repository, ensuring a cleaner project structure.
2024-05-03 13:03:45 +00:00
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:
```bash
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 17:21:18 +00:00
reportbot
feat: enhance README with badges and detailed docs - Added informative badges for versioning, Python versions, license, and the latest commit to enhance project visibility and credibility. - Expanded documentation to include detailed installation, usage instructions, and added a comprehensive guide on configuring and running the bot, emphasizing the ease of set up and operation. - Recommended the use of pantalaimon for E2E encryption support, catering to user security concerns. - Included commands for adding, listing, and removing feeds, ensuring users have clear guidance on bot interaction. This update makes the project more accessible and user-friendly, encouraging adoption and contribution by providing all necessary information upfront. fix: ignore build directory in .gitignore - The `build/` directory is now ignored, preventing compiled files or artifacts from being tracked in the repository, ensuring a cleaner project structure.
2024-05-03 13:03:45 +00:00
```
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
Reference in a new issue Copy permalink