{"id":29717351,"url":"https://github.com/algusdark/miniflux.koplugin","last_synced_at":"2026-03-06T03:32:19.312Z","repository":{"id":305043192,"uuid":"995895014","full_name":"AlgusDark/miniflux.koplugin","owner":"AlgusDark","description":"KOReader plugin to access a Miniflux instance to read your RSS feed entries with offline capabilities.","archived":false,"fork":false,"pushed_at":"2025-08-29T12:26:53.000Z","size":1025,"stargazers_count":27,"open_issues_count":7,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-08-29T15:48:46.391Z","etag":null,"topics":["eink","koplugin","koreader","koreader-plugin","miniflux","rss"],"latest_commit_sha":null,"homepage":"","language":"Lua","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/AlgusDark.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null},"funding":{"github":"AlgusDark","buy_me_a_coffee":"algusdark"}},"created_at":"2025-06-04T06:55:36.000Z","updated_at":"2025-08-22T11:28:35.000Z","dependencies_parsed_at":"2025-07-18T03:25:38.717Z","dependency_job_id":"966400ea-6db5-497d-9076-e262b49ca44f","html_url":"https://github.com/AlgusDark/miniflux.koplugin","commit_stats":null,"previous_names":["algusdark/miniflux.koplugin"],"tags_count":18,"template":false,"template_full_name":null,"purl":"pkg:github/AlgusDark/miniflux.koplugin","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AlgusDark%2Fminiflux.koplugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AlgusDark%2Fminiflux.koplugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AlgusDark%2Fminiflux.koplugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AlgusDark%2Fminiflux.koplugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AlgusDark","download_url":"https://codeload.github.com/AlgusDark/miniflux.koplugin/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AlgusDark%2Fminiflux.koplugin/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30160873,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-05T22:39:40.138Z","status":"online","status_checked_at":"2026-03-06T02:00:08.268Z","response_time":250,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["eink","koplugin","koreader","koreader-plugin","miniflux","rss"],"created_at":"2025-07-24T07:09:40.746Z","updated_at":"2026-03-06T03:32:19.294Z","avatar_url":"https://github.com/AlgusDark.png","language":"Lua","funding_links":["https://github.com/sponsors/AlgusDark","https://buymeacoffee.com/algusdark"],"categories":[],"sub_categories":[],"readme":"# Miniflux Plugin for KOReader\n\nA KOReader plugin allows you to read RSS entries online/offline on your e-reader device.\n\n## Features\n\nBrowse your Miniflux server content directly from KOReader:\n\n- **Online/Offline Reading**: Browse feeds, categories, and entries online or offline. You can download entries individually or in batch.\n- **Context-Aware Navigation**: Navigate between entries with next/previous actions after finishing reading an entry.\n- **Status Synchronization**: Mark entries as read/unread. Don't worry if you aren't online, the system will keep an eye on it and you can sync it later or the system will remind you when you go online again.\n- **E-ink Optimized**: Efficient image downloading and display for e-readers. You can proxy the images to be transformed for e-ink optimization so you can resize them to fit your reader.\n\n## Installation\n\n1. Download the [latest release from this repository](https://github.com/AlgusDark/miniflux.koplugin/releases/latest)\n2. Unzip and copy the **miniflux.koplugin** folder into KOReader's plugin folder\n3. Activate the plugin\n\n## Usage\n\n1. **Setup**: Configure your Miniflux server URL and credentials in the settings\n2. **Browse**: Access feeds, categories, and entries from the \"read entries\" menu\n3. **Read**: Select an entry and it will start downloading it. The entry will be opened after successfully downloaded.\n4. **Download**: Tap hold an entry to enter into selection mode and batch download entries.\n5. **Sync**: Status changes sync automatically with your Miniflux server. If in offline mode, it will queue the status for the next time you are online.\n\n## Development Status\n\n### ✅ Core Features\n\n- [x] **Feed and Category Browsing**\n  - [x] List all feeds and categories from Miniflux server\n  - [x] Navigate feed and category organization\n- [x] **Entry Management**\n  - [x] Browse entries by feed, category, or unreads\n  - [x] Download entries with text and images for offline reading\n  - [x] Context-aware navigation (next/previous within current view)\n- [x] **Status Management**\n  - [x] Mark entries as read/unread without deleting local files\n  - [x] Auto-mark as read when opening entry\n  - [x] Batch mark as read when offline\n- [x] **Offline Support**\n  - [x] Full offline reading of downloaded entries\n  - [x] Local file management and organization\n\n### 🚧 Storage Management\n\n- [x] **Bulk Entry Deletion**\n  - [x] Delete selected entries\n  - [ ] Delete by date range (1 week, 1 month, 3 months, 6 months)\n  - [ ] Storage space reporting and cleanup\n- [ ] **Selective Image Management**\n  - [ ] Delete all images while preserving entry text\n  - [ ] Image storage statistics and usage breakdown\n\n### 🔄 Background Operations\n\n- [ ] **Intelligent Prefetching**\n  - [ ] Configurable prefetch count (download N entries ahead)\n- [ ] **Image Recovery**\n  - [ ] Selective re-download of missing images only\n\n### 📊 Enhanced Reading Experience\n\n- [ ] **Search and Organization**\n  - [ ] Full-text search\n  - [ ] Starred entries\n\n## Technical Details\n\n### Architecture\n\n- **Modular Design**: Separate services for API, entries, navigation, and storage\n- **Error Handling**: Comprehensive error management with user-friendly messages\n- **Offline-First**: Graceful degradation when server is unavailable\n- **E-ink Optimized**: Efficient image processing and display for e-readers\n\n## Development\n\n### Nix Development Environment (Recommended)\n\nThis project provides a complete Nix flake for reproducible development:\n\n```bash\n# With direnv (automatic)\ndirenv allow\n\n# Manual activation\nnix develop\n\n# Available tools: lua, luacheck, stylua, task\n```\n\n### Manual Setup\n\nIf not using Nix, install these tools manually:\n\n```bash\n# Install tools\ncargo install stylua\nluarocks install luacheck\n```\n\n### Code Quality Tools\n\n- **StyLua**: Code formatter\n- **Luacheck**: Static analysis and linting\n- **LuaLS**: Type checking with LuaCATS annotations\n\n### Quick Commands\n\n```bash\n# Check code quality\ntask check\n\n# Auto-fix formatting\ntask fmt-fix\n```\n\n### Development Setup with KOReader\n\nFor development testing, create a symlink to the built plugin:\n\n#### macOS\n\n```bash\n# Build the plugin first\ntask build\n\n# Create symlink to KOReader plugins directory\nln -s /path/to/miniflux.koplugin/dist/miniflux.koplugin ~/.config/koreader/plugins/miniflux.koplugin\n\n# Run KOReader with debug logging\n/System/Volumes/Data/Applications/KOReader.app/Contents/MacOS/koreader -d\n\n# Filter logs for Miniflux-specific messages\n/System/Volumes/Data/Applications/KOReader.app/Contents/MacOS/koreader -d 2\u003e\u00261 | grep -E \"Miniflux\"\n```\n\n## Contributing\n\nContributions are welcome! Please feel free to:\n\n- Report bugs and suggest features\n- Submit pull requests for improvements\n- Help with testing on different devices\n- Contribute to documentation\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falgusdark%2Fminiflux.koplugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falgusdark%2Fminiflux.koplugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falgusdark%2Fminiflux.koplugin/lists"}