Skip to content

markdevel/xExtension-TagFilter

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 

Repository files navigation

FreshRSS Extension: Tag Filter

A custom extension for FreshRSS that filters incoming articles based on feed URLs and specific tags.

Instead of marking unwanted articles as read, this extension hooks into the entry_before_insert process and entirely discards articles that do not contain the specified tags. This approach prevents unwanted articles from ever reaching your database, keeping your FreshRSS instance incredibly clean, lightweight.

Features

  • Pre-database Filtering: Unmatched articles are rejected before insertion, saving database storage.
  • Feed-Specific Rules: Apply tag filters only to the feeds you specify.
  • Web UI Configuration: Easily manage your filtering rules directly from the FreshRSS extension settings menu.

Installation

Standard Installation

  1. Download or clone this repository.
  2. Copy the xExtension-TagFilter folder into the extensions directory of your FreshRSS installation: /path/to/FreshRSS/extensions/xExtension-TagFilter/
  3. Ensure the folder permissions match your web server user (e.g., www-data).

Docker Installation

If you are running FreshRSS via Docker, you can install the extension by adding a volume mount or by building a custom image.

Option A: Volume Mount (docker-compose.yml)

volumes:
  - ./extensions/xExtension-TagFilter:/var/www/FreshRSS/extensions/xExtension-TagFilter

Option B: Custom Build (Dockerfile)

FROM freshrss/freshrss:latest
COPY --chown=www-data:www-data ./extensions/xExtension-TagFilter /var/www/FreshRSS/extensions/xExtension-TagFilter

Configuration & Usage

  1. Log in to your FreshRSS instance as an administrator.
  2. Navigate to Configuration (Settings) > Extensions.
  3. Locate Tag Filter in the list and toggle the switch to enable it.
  4. Click the Gear icon (⚙️) next to the extension to open the configuration page.
  5. Enter your filtering rules in the text area.

Rule Format

Write one rule per line using the following format: [Part of Feed URL] | [Target Tag]

Example

example.com/feed | tagnamewithoutsharp
example.net/rss | network

Note: If a feed matches the URL string but the article does not contain the specified tag, the article will be silently discarded.

License

This software is released under the MIT License.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors