Skip to content

Gabryel666/RSS-Discord-Bridge

Repository files navigation

RSS-Discord-Bridge.

An automated script that monitors RSS feeds and pushes new articles to Discord channels with multi-channel support.

🚀 Installation & Configuration (The Easy Way)

This project comes with a built-in configuration website to help you manage your feeds without editing code.

1. Enable the Config Site

After forking this repository (making your own copy):

  1. Go to Settings > Actions > General and select Allow all actions and reusable workflows. Click Save.
  2. Go to Settings > Pages.
  3. Under "Build and deployment", set Branch to main and folder to /docs. Click Save.
  4. Wait 1-2 minutes. Your configuration site will appear at: https://YOUR-USERNAME.github.io/RSS-Discord-Bridge/

👉 Use this website to follow the setup guide and manage your RSS feeds easily.


Key Features

  • Exhaustive History Retrieval: Retrieves all missed articles between checks.
  • Smart Desync Protection: Prevents spam if a feed changes significantly.
  • Multi-Channel Routing: Send feeds to different Discord channels.
  • Multi-Feed Tracking: Monitor unlimited RSS feeds.
  • Web Dashboard: Manage feeds via a friendly UI (/docs).
  • Scheduled Updates: Configurable check frequency via GitHub Actions.

Manual Setup (Advanced)

If you prefer not to use the web interface, you can configure everything manually:

  1. Clone the repository:

    git clone https://github.com/Gabryel666/RSS-Discord-Bridge.git
    cd RSS-Discord-Bridge
  2. Configure feeds: Edit feeds.json:

    {
      "Hugin & Munin": {
        "url": "https://example.com/feed.rss",
        "webhookKey": "news"
      }
    }
  3. Set up Discord webhooks: Add them to GitHub Secrets as DISCORD_WEBHOOKS:

    {
      "news": "https://discord.com/api/webhooks/..."
    }

Technical Overview

sequenceDiagram
    participant GA as GitHub Actions
    participant Script
    participant RSS as RSS Feeds
    participant Discord

    GA->>Script: Scheduled Trigger
    Script->>RSS: GET Request
    RSS-->>Script: New Items
    Script->>Discord: Post to Webhook
    Script->>GA: Update last_posts.json
Loading

📄 License

MIT © [Gabryel666] - Free for use and modification

About

An automated script that monitors RSS feeds and pushes new articles to Discord channels.

Topics

Resources

License

Stars

Watchers

Forks

Contributors