RSS Reader Plugin for KOReader

[omerfaruq]

Hi everyone,
I’d like to share a new plugin I’ve been working on: the RSS Reader Plugin for KOReader.
It lets you follow your favorite RSS feeds directly from your device — all in a single, unified screen.

You can find the full code and installation instructions here: https://github.com/omer-faruq/rssreader.koplugin

📰 What It Does

The plugin allows you to connect to online services like NewsBlur and CommaFeed, or simply use local feed bundles that you define yourself. You can switch between accounts, browse groups, and open stories without leaving KOReader.

It’s meant for:

Readers who want to add and manage their own RSS accounts

Users who prefer a self-contained offline reading experience with local feeds

For everyday use, you only need to define your accounts and choose which local feeds to follow. Everything else happens from inside KOReader.

⚙️ Setup Overview

You only need to edit two files, both provided as .sample.lua templates:

rssreader_configuration.sample.lua → rename to rssreader_configuration.lua
Define your accounts, login info, and per-account settings.
You can add multiple accounts — even of the same service type — and toggle them on/off easily.

rssreader_local_defaults.sample.lua → rename to rssreader_local_defaults.lua
This file defines the “local” feed bundles (titles, groups, URLs).
It’s your starting point for offline reading or curated feed collections.

Once you’ve edited and renamed the files, reload the plugin in KOReader. Your accounts and feeds will show up automatically.

🚀 Quick Start

Open RSS Reader from KOReader’s main menu (under the “Search” section).

Tap an account to browse feeds, or long-press for more options.

For local accounts, feeds come directly from your rssreader_local_defaults.lua file — just edit URLs there to add new sources.

The default sample files include example groups like “Sample” and “Tech Blogs” to get you started.

🔄 How It Differs from the Built-in News Downloader

Account Support: Multiple account types (local, NewsBlur, CommaFeed) with stored preferences.

Unified Navigation: Everything stays in one hierarchical interface — accounts, folders, feeds, and stories.

External Sync: Connect to services that track your read/unread state and article history.

🧩 Extra Notes

You don’t need to edit the other Lua files — they handle internal logic.

Reload the plugin any time you change the config files.

Enjoy your reading and feel free to report feedback or suggestions here — especially if you have ideas for other feed services or offline enhancements.
Happy reading! 📖

[omerfaruq]

A quick video about plugin's usage: https://www.youtube.com/shorts/SZwr6Vm_-mc

[Homer55]

oh, this looks really really cool, it would be great if it was capable of opening the full article in a reader view, maybe using readability and keep he images on the body

[omerfaruq]

Thanks for the feedback.

I already added some sort of readability support. It may fail for some websites. If you use the "open" or "save" button, it uses that content. I may include support for Diffbot. It has a generous free plan, but requires a work email.

Image support is on my list. (for the "open" and "save" buttons).

[omerfaruq]

A quick video about:

• image support
• readability support

Link: https://youtube.com/shorts/diVyP8RVdvw