TheLovinator/discord-rss-bot
Watch
1
Fork
You've already forked discord-rss-bot
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
A RSS bot for Discord
224 commits 2 branches 0 tags 2.7 MiB
  • Python 81.9%
  • jinja 17.6%
  • CSS 0.4%
  • Dockerfile 0.1%
Find a file
Repository files (latest commit first)
Filename Latest commit message Latest commit date
Joakim Hellsén 3bc5d1c24e
 Update feed page 
Only show summary, content if not available
Only show author if not None
2023-01-14 13:21:06 +01:00
.github Delete codeql.yml 2023-01-09 01:00:44 +01:00
.vscode Fix .vscode/launch.json 2022-12-25 16:01:27 +01:00
discord_rss_bot Update feed page 2023-01-14 13:21:06 +01:00
tests Fix all errors and warnings 2023-01-10 23:07:15 +01:00
.gitignore Ignore .pyi files 2023-01-10 19:03:37 +01:00
docker-compose.yml Add docker-compose.yml 2022-12-19 03:30:47 +01:00
Dockerfile Run uvicorn with --forwarded-allow-ips 2022-12-19 04:09:09 +01:00
LICENSE Initial commit 2021-12-11 23:32:40 +01:00
poetry.lock Convert HTML in content/summary to Markdown 2023-01-14 12:54:03 +01:00
pyproject.toml Convert HTML in content/summary to Markdown 2023-01-14 12:54:03 +01:00
README.md Format README.md 2023-01-10 17:14:07 +01:00

README.md

discord-rss-bot

Subscribe to RSS feeds and get updates to a Discord webhook. Built with reader.

Installation

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

Docker

  • Open a terminal in the repository folder.
    • Windows 10: Shift + right-click in the folder and select Open PowerShell window here
    • Windows 11: Shift + right-click in the folder and Show more options 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

This is not recommended if you don't have an init system (e.g., systemd)

  • Install the latest version of needed software:
    • Python
      • You should use the latest version.
      • You want to add Python to your PATH.
      • Windows: Find App execution aliases and disable python.exe and python3.exe
    • Poetry
      • Windows: You have to add %appdata%\Python\Scripts to your PATH for Poetry to work.
  • 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.
    • Windows 10: Shift + right-click in the folder and select Open PowerShell window here
    • Windows 11: Shift + right-click in the folder and Show more options and Open PowerShell window here
  • Install requirements:
    • Type poetry install into the PowerShell window. Make sure you are in the repository folder where the pyproject.toml file is located.
      • (You may have to restart your terminal if it can't find the poetry command. Also double check it is in your PATH.)
  • Start the bot:
    • Type poetry run bot into the PowerShell window.
      • You can stop the bot with Ctrl + c.

Note: You will need to run poetry install again if poetry.lock has been modified.

Need help?