Skip to content

Latest commit

 

History

History
62 lines (50 loc) · 2.89 KB

README.md

File metadata and controls

62 lines (50 loc) · 2.89 KB
Raw

discord-rss-bot

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

Note

You should look at MonitoRSS for a more feature-rich project.

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 python discord_rss_bot/main.py 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.

Contact

Email: mailto:[email protected] Discord: TheLovinator#9276