Skip to main content

FreshRSS Discord Bot

FreshRSS Discord Extension Setup

This guide explains how to install the Discord extension for FreshRSS, configure the webhook, and customize the bot name and avatar.

1. Prepare the extension folder

If you run FreshRSS with Docker, create the extensions folder on your host machine, in the same directory as your docker-compose.yml.

Example:



cd /path/to/your/freshrss-project mkdir -p extensions

Then clone the extension into that folder:



git clone https://github.com/rnkln/freshrss-xExtension-Discord.git extensions/Discord

Your Docker Compose file should include this volume:

This makes the extension visible inside the FreshRSS container.

2. Restart FreshRSS

After adding the extension, restart your containers:



docker compose up -d

Or, if needed:



docker restart freshrss-app

3. Enable the extension in FreshRSS

Open the FreshRSS web interface and log in as an administrator.

Go to:

Settings > Extensions

Find the Discord extension and enable it.

4. Create a Discord webhook

In Discord:

  1. Open the channel where you want notifications.

  2. Go to Channel Settings.

  3. Open Integrations.

  4. Click Webhooks.

  5. Create a new webhook.

  6. Copy the webhook URL.

It will look like this:



https://discord.com/api/webhooks/XXXXXXXXXXXXXXXXXXXXXXXX/XXXXXXXXXXXXXXXXXXXXXXXX

5. Configure the extension

In FreshRSS, open the Discord extension settings and fill in:

  • URL: paste the Discord webhook URL.

  • Username: the name shown in Discord for the bot.

  • Avatar URL: a direct public link to the image you want to use as the bot icon.

Then click Validate.

6. Test the setup

Use the Test button in the extension page.

If everything is correct, FreshRSS should send a test message to your Discord channel.

7. Adjust behavior

The extension also has a Behavior section. Common options include:

  • Skip when autoread: do not send notifications for articles marked as read automatically.

  • Skip for categories: ignore articles from selected categories.

  • Embed as link: send the article as a link format instead of the default message.

Leave these blank or disabled at first, then adjust later if needed.

8. Change the bot logo

If you want to change the icon shown in Discord, use the Avatar URL field.

Important points:

  • It must be a public direct image URL.

  • Use a PNG or JPG file.

  • A square image works best.

  • The image must be reachable by Discord from the internet.

Example:



https://your-domain.com/assets/freshrss-avatar.png

A simple working configuration could be:

  • Username: FreshRSS

  • Avatar URL: https://your-domain.com/assets/freshrss-avatar.png

Then:

  1. Click Validate.

  2. Click Test.

  3. Check the Discord channel.

10. Troubleshooting

If the test fails, check the following:

  • The webhook URL is correct.

  • The webhook is still active in Discord.

  • The FreshRSS container has internet access.

  • The extension is enabled in FreshRSS.

  • The avatar image URL is public and directly accessible.

If you want, I can turn this into a cleaner step-by-step README-style version for your notes or portfolio.