Matrix RSS Room Bot

A Matrix bot that creates and manages public rooms for RSS feeds.

Why?

Most bots serve any feed in any channel; this bot serves every feed in a separate channel. This means it's most useful for:

Users who prefer to have separate RSS feeds in separate Matrix rooms
Users who wish to find other people with the same interests and discuss the topics of the RSS feed

How to run

You can run the program

Using Docker
Using Docker compose
By running Python directly from your computer

Using Docker

Download sample.config.yml and sample.database.db and rename them to config.yml and database.db, respectively.
Fill in the details in your config.yml file. Leave database.db unchanged.
Open a terminal in the directory of your files and run the following command:

docker run -it -v ./config.yml:/config.yml -v ./database.db:/database.db noordstar/matrix-rss-room-bot

Using Docker compose

Instead of running the command directly, you can run the program in a compose file.

version: '3'
services:
    matrix-rss-room-bot:
        image: noordstar/matrix-rss-room-bot:latest
        restart: unless-stopped
        volumes:
            - ./config.yml:/config.yml
            - ./database.db:/database.db

Using Python

Download this repository.
Install dependencies by running the following command:

pip install -r requirements.txt

Copy sample.config.yml to config.yml and fill it with your desired settings.
Run the following command to set up a new database:

python update.py

You have now set up the Matrix-RSS Room Bot. You can start the bot by running python main.py in your terminal indefinitely or until you interrupt the process.

Potential features

Feel free to contribute! The following features would be useful to have added.

Bot moderation channel to monitor spam
Allow URL links with parameters if they render different RSS feeds
User blacklist so the bot ignores misbehaving users

BramvdnHeuvel / Matrix-RSS-Room-Bot