No description
Find a file
Kumi ec505cfc3b
feat(bot): add operator property to RSSBot class
Introduced a new 'operator' property to the RSSBot class that retrieves the bot operator's name from the configuration file. Defaults to "your Matrix administrator" if not specified. Enhances configuration clarity and accessibility by allowing easy retrieval of the bot operator information.
2024-06-16 17:54:29 +02:00
.forgejo/workflows feat: add CI/CD workflow for Python package 2024-05-18 09:01:25 +02:00
.github feat(dependabot): enable daily pip package updates 2024-05-17 16:16:18 +02:00
contrib feat: add message event type configuration 2024-05-17 16:49:27 +02:00
src/matrix_rssbot feat(bot): add operator property to RSSBot class 2024-06-16 17:54:29 +02:00
.gitignore feat: enhance README with badges and detailed docs 2024-05-03 15:03:45 +02:00
config.dist.ini feat: add support for proxying feed requests 2024-06-15 19:58:15 +02:00
LICENSE Created RSSBot 2024-03-02 15:31:14 +01:00
pantalaimon_first_login.py Enhance Pantalaimon integration and config 2023-12-05 10:09:14 +01:00
pyproject.toml chore: bump version to 0.1.6 in pyproject.toml 2024-06-16 08:41:06 +02:00
README.md feat: enhance README with badges and detailed docs 2024-05-03 15:03:45 +02:00
rssbot.service Created RSSBot 2024-03-02 15:31:14 +01:00

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.