PrivateCoffee/matrix-rssbot
4
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
matrix-rssbot/README.md
Kumi 3216df5bbb
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 15:03:45 +02:00

2.3 KiB
Raw Permalink Blame History

Matrix-RSSBot

Support Private.coffee! PyPI PyPI - Python Version PyPI - License Latest Git Commit

This is a simple, no-database RSS/Atom feed bot for Matrix. It is designed to be easy to use and lightweight.

Installation

pip install matrix-rssbot

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

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:

rssbot

Usage

The bot will automatically join all rooms it is invited to.

You have to ensure that the bot has the necessary permissions to send state events and messages in the room. Regular users cannot send state events, so you have to either raise the bot user's power level (Moderator level should do) or lower the power level required to send state events.

You can now add a feed to the bot by sending a message to the bot in the room you want the feed to be posted in. The message should be in the following format:

!rssbot addfeed https://example.com/feed.xml

To list all feeds in a room, you can use the following command:

!rssbot listfeeds

Finally, to remove a feed, you can use the following command:

!rssbot removefeed https://example.com/feed.xml

Alternatively, you can use the number of the feed in the list, which you can get by using the listfeeds command instead of the URL.

License

This project is licensed under the MIT License - see the LICENSE file for details.