Skip to content

Add Keyword Auto Read extension - #526

Closed
hyprninja wants to merge 1 commit into
FreshRSS:mainfrom
hyprninja:add-keyword-auto-read
Closed

hyprninja wants to merge 1 commit into
FreshRSS:mainfrom
hyprninja:add-keyword-auto-read

Conversation

@hyprninja

Copy link
Copy Markdown

Adds Keyword Auto Read to repositories.json and the README list.

It marks incoming articles as read when they match a keyword rule, so they never reach the unread stream. FreshRSS already does this per feed through filter actions; this applies one rule set across every feed.

  • Hooks entry_before_insert; rules can be plain keywords, scoped to a single field (title:, content:, author:, url:, tag:) or full PCRE, with whole-word and case-sensitivity options
  • Feed include/exclude lists, a dry-run mode that only logs, and an in-page tester for checking a rule against a sample headline
  • An optional sweep that applies the rules to articles already stored, paging through FreshRSS_EntryDAO::listWhere() under a time budget; it only ever marks read, never deletes

Written against the 1.29.1 sources. metadata.json carries name, author, description, version, entrypoint and type, and the extension lives in xExtension-KeywordAutoRead/ at the repository root, so generate.php should pick it up. Licensed AGPL-3.0.

The repository has a standalone test harness (no FreshRSS or composer needed) that stubs the FreshRSS API, run in CI with php -l on every source file across PHP 7.4 to 8.4.

🤖 Generated with Claude Code

https://github.com/hyprninja/freshrss-keyword-auto-read

Marks incoming articles as read when they match keyword, field-scoped or
regular expression rules, applied across every feed rather than per feed.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@Inverle

Inverle commented Sep 12, 2026

Copy link
Copy Markdown
Member

FreshRSS already does this per feed through filter actions; this applies one rule set across every feed

And for all feeds, if you put the search filters for auto mark as read in Configuration > Reading > Filter actions.

See https://freshrss.github.io/FreshRSS/en/users/10_filter.html#with-the-search-field for the syntax.

@hyprninja hyprninja closed this Sep 12, 2026
@hyprninja
hyprninja deleted the add-keyword-auto-read branch September 12, 2026 04:00
@hyprninja

Copy link
Copy Markdown
Author

fair enough then

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants