TheLovinator/discord-rss-bot
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
A RSS bot for Discord
740 commits 1 branch 0 tags 2 MiB
  • Python 77.7%
  • jinja 22%
  • Dockerfile 0.2%
Find a file
Joakim Hellsén 4d4791955f
 Merge pull request #418 from mirusu400/master
2025-10-15 04:47:06 +02:00
.github Update astral-sh/setup-uv action to v7 (#402) 2025-10-08 00:55:53 +00:00
.vscode Add additional words to cSpell configuration in settings.json 2025-06-07 06:05:14 +02:00
discord_rss_bot fix: classify Reddit feeds only when URL contains both "reddit.com" and ".rss" 2025-10-15 04:43:39 +02:00
tests Refactor search response to use named parameters and update search context test 2025-08-29 16:41:34 +02:00
.gitattributes Add .gitattributes to set Jinja as the language for HTML files 2025-04-01 22:58:42 +02:00
.gitignore Update .gitignore 2025-06-07 05:00:26 +02:00
.pre-commit-config.yaml Improve search page 2025-08-29 03:02:32 +02:00
.python-version Add uv stuff 2025-06-07 05:04:10 +02:00
docker-compose.yml Update Docker healthcheck 2025-05-04 05:28:37 +02:00
Dockerfile Update Docker healthcheck 2025-05-04 05:28:37 +02:00
LICENSE Initial commit 2021-12-11 23:32:40 +01:00
pyproject.toml Improve search page 2025-08-29 03:02:32 +02:00
README.md Fix formatting in installation instructions and update email link 2025-07-08 01:10:58 +02:00
requirements.txt Update dependency pydantic to v2.12.2 (#417) 2025-10-14 18:09:28 +00:00
uv.lock Improve search page 2025-08-29 03:02:32 +02:00

README.md

discord-rss-bot

Subscribe to RSS feeds and get updates to a Discord webhook.

Features

  • Subscribe to RSS feeds and get updates to a Discord webhook.
  • Web interface to manage subscriptions.
  • Customizable message format for each feed.
  • Choose between Discord embed or plain text.
  • Regex filters for RSS feeds.
  • Blacklist/whitelist words in the title/description/author/etc.
  • Gets extra information from APIs if available, currently for:

Installation

You have two choices, using Docker or install directly on your computer.

Docker

  • Open a terminal in the repository folder.
    • Shift + right-click in the folder and Open PowerShell window here
  • Run the Docker Compose file:
    • docker-compose up
      • You can stop the bot with Ctrl + c.
      • If you want to run the bot in the background, you can run docker-compose up -d.
  • You should run this bot behind a reverse proxy like Caddy or Nginx.
    • 5000 is the port the bot listens on.
  • You can update the container with docker-compose pull

Install directly on your computer

  • Install the latest of uv:

    • powershell -ExecutionPolicy ByPass -c "irm <https://astral.sh/uv/install.ps1> | iex"

  • Download the project from GitHub with Git or download the ZIP.

    • If you want to update the bot, you can run git pull in the project folder or download the ZIP again.

  • Open a terminal in the repository folder.

    • Shift + right-click in the folder and Open PowerShell window here

  • Start the bot:

    • Type uv run discord_rss_bot/main.py into the PowerShell window.
      • You can stop the bot with Ctrl + c.

  • Bot is now running on port 3000.

  • You should run this bot behind a reverse proxy like Caddy or Nginx if you want to access it from the internet. Remember to add authentication.

  • You can access the web interface at http://localhost:3000/.

  • To run automatically on boot:

    • Use Windows Task Scheduler.
    • Or add a shortcut to %userprofile%\AppData\Roaming\Microsoft\Windows\Start Menu\Programs\Startup.

Contact

Email: tlovinator@gmail.com

Discord: TheLovinator#9276