# 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 <span class="code" data-prosemirror-content-type="mark" data-prosemirror-mark-name="code" spellcheck="false">extensions</span> folder on your host machine, in the same directory as your <span class="code" data-prosemirror-content-type="mark" data-prosemirror-mark-name="code" spellcheck="false">docker-compose.yml</span>.

Example:

<div class="fabric-editor-breakout-mark" data-mode="wide" data-prosemirror-content-type="mark" data-prosemirror-mark-name="breakout" data-width="760" id="bkmrk-cd-%2Fpath%2Fto%2Fyour%2Ffre"><div class="code-block--start" contenteditable="false">  
</div><div class="code-block-content-wrapper"><div contenteditable="false" style="background-color: var(--ds-background-neutral, #0515240f); box-sizing: content-box; flex-shrink: 0; font-size: 0.875em; padding: var(--ds-space-100, 8px) var(--ds-space-250, 20px) var(--ds-space-100, 8px) var(--ds-space-075, 6px); position: relative; width: var(--lineNumberGutterWidth, 2rem);"><div class="code-block-gutter-pseudo-element" data-label="1" style="color: var(--ds-text-subtlest, #6b6e76); font-family: var(--ds-font-family-code, 'Atlassian Mono', ui-monospace, Menlo, 'Segoe UI Mono', 'Ubuntu Mono', monospace); text-align: right; white-space: pre-wrap;">  
</div></div><div class="code-content"><code>cd &#47;path&#47;to&#47;your&#47;freshrss&#45;project mkdir &#45;p extensions</code></div></div></div>Then clone the extension into that folder:

<div class="fabric-editor-breakout-mark" data-mode="wide" data-prosemirror-content-type="mark" data-prosemirror-mark-name="breakout" data-width="760" id="bkmrk-git-clone-https%3A%2F%2Fgi"><div class="code-block--start" contenteditable="false">  
</div><div class="code-block-content-wrapper"><div contenteditable="false" style="background-color: var(--ds-background-neutral, #0515240f); box-sizing: content-box; flex-shrink: 0; font-size: 0.875em; padding: var(--ds-space-100, 8px) var(--ds-space-250, 20px) var(--ds-space-100, 8px) var(--ds-space-075, 6px); position: relative; width: var(--lineNumberGutterWidth, 2rem);"><div class="code-block-gutter-pseudo-element" data-label="1" style="color: var(--ds-text-subtlest, #6b6e76); font-family: var(--ds-font-family-code, 'Atlassian Mono', ui-monospace, Menlo, 'Segoe UI Mono', 'Ubuntu Mono', monospace); text-align: right; white-space: pre-wrap;">  
</div></div><div class="code-content"><code>git clone https&#58;&#47;&#47;github&#46;com&#47;rnkln&#47;freshrss&#45;xExtension&#45;Discord&#46;git extensions&#47;Discord</code></div></div></div>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:

<div class="fabric-editor-breakout-mark" data-mode="wide" data-prosemirror-content-type="mark" data-prosemirror-mark-name="breakout" data-width="760" id="bkmrk-docker-compose-up--d"><div class="code-block--start" contenteditable="false">  
</div><div class="code-block-content-wrapper"><div contenteditable="false" style="background-color: var(--ds-background-neutral, #0515240f); box-sizing: content-box; flex-shrink: 0; font-size: 0.875em; padding: var(--ds-space-100, 8px) var(--ds-space-250, 20px) var(--ds-space-100, 8px) var(--ds-space-075, 6px); position: relative; width: var(--lineNumberGutterWidth, 2rem);"><div class="code-block-gutter-pseudo-element" data-label="1" style="color: var(--ds-text-subtlest, #6b6e76); font-family: var(--ds-font-family-code, 'Atlassian Mono', ui-monospace, Menlo, 'Segoe UI Mono', 'Ubuntu Mono', monospace); text-align: right; white-space: pre-wrap;">  
</div></div><div class="code-content"><code>docker compose up &#45;d</code></div></div></div>Or, if needed:

<div class="fabric-editor-breakout-mark" data-mode="wide" data-prosemirror-content-type="mark" data-prosemirror-mark-name="breakout" data-width="760" id="bkmrk-docker-restart-fresh"><div class="code-block--start" contenteditable="false">  
</div><div class="code-block-content-wrapper"><div contenteditable="false" style="background-color: var(--ds-background-neutral, #0515240f); box-sizing: content-box; flex-shrink: 0; font-size: 0.875em; padding: var(--ds-space-100, 8px) var(--ds-space-250, 20px) var(--ds-space-100, 8px) var(--ds-space-075, 6px); position: relative; width: var(--lineNumberGutterWidth, 2rem);"><div class="code-block-gutter-pseudo-element" data-label="1" style="color: var(--ds-text-subtlest, #6b6e76); font-family: var(--ds-font-family-code, 'Atlassian Mono', ui-monospace, Menlo, 'Segoe UI Mono', 'Ubuntu Mono', monospace); text-align: right; white-space: pre-wrap;">  
</div></div><div class="code-content"><code>docker restart freshrss&#45;app</code></div></div></div>## 3. Enable the extension in FreshRSS

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

Go to:

**Settings &gt; 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:

<div class="fabric-editor-breakout-mark" data-mode="wide" data-prosemirror-content-type="mark" data-prosemirror-mark-name="breakout" data-width="760" id="bkmrk-https%3A%2F%2Fdiscord.com%2F"><div class="code-block--start" contenteditable="false">  
</div><div class="code-block-content-wrapper"><div contenteditable="false" style="background-color: var(--ds-background-neutral, #0515240f); box-sizing: content-box; flex-shrink: 0; font-size: 0.875em; padding: var(--ds-space-100, 8px) var(--ds-space-250, 20px) var(--ds-space-100, 8px) var(--ds-space-075, 6px); position: relative; width: var(--lineNumberGutterWidth, 2rem);"><div class="code-block-gutter-pseudo-element" data-label="1" style="color: var(--ds-text-subtlest, #6b6e76); font-family: var(--ds-font-family-code, 'Atlassian Mono', ui-monospace, Menlo, 'Segoe UI Mono', 'Ubuntu Mono', monospace); text-align: right; white-space: pre-wrap;">  
</div></div><div class="code-content"><code>https&#58;&#47;&#47;discord&#46;com&#47;api&#47;webhooks&#47;XXXXXXXXXXXXXXXXXXXXXXXX&#47;XXXXXXXXXXXXXXXXXXXXXXXX</code></div></div></div>## 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:

<div class="fabric-editor-breakout-mark" data-mode="wide" data-prosemirror-content-type="mark" data-prosemirror-mark-name="breakout" data-width="760" id="bkmrk-https%3A%2F%2Fyour-domain."><div class="code-block--start" contenteditable="false">  
</div><div class="code-block-content-wrapper"><div contenteditable="false" style="background-color: var(--ds-background-neutral, #0515240f); box-sizing: content-box; flex-shrink: 0; font-size: 0.875em; padding: var(--ds-space-100, 8px) var(--ds-space-250, 20px) var(--ds-space-100, 8px) var(--ds-space-075, 6px); position: relative; width: var(--lineNumberGutterWidth, 2rem);"><div class="code-block-gutter-pseudo-element" data-label="1" style="color: var(--ds-text-subtlest, #6b6e76); font-family: var(--ds-font-family-code, 'Atlassian Mono', ui-monospace, Menlo, 'Segoe UI Mono', 'Ubuntu Mono', monospace); text-align: right; white-space: pre-wrap;">  
</div></div><div class="code-content"><code>https&#58;&#47;&#47;your&#45;domain&#46;com&#47;assets&#47;freshrss&#45;avatar&#46;png</code></div></div></div>## 9. Recommended setup values

A simple working configuration could be:

- **Username**: <span class="code" data-prosemirror-content-type="mark" data-prosemirror-mark-name="code" spellcheck="false">FreshRSS</span>
- **Avatar URL**: <span class="code" data-prosemirror-content-type="mark" data-prosemirror-mark-name="code" spellcheck="false">https://your-domain.com/assets/freshrss-avatar.png</span>

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.