A minimalist, E-Ink optimized client for Miniflux.
Inkflux is a lightweight, web-based RSS reader client designed specifically for E-Ink devices (Kindle, Kobo, etc.) and low-power environments. Built on top of the Miniflux API, it strips away all distractions to focus purely on reading.
The interface is high-contrast, touch-friendly, and avoids animations or complex layouts that cause ghosting on E-Ink screens.
E-Ink devices are not optimized for modern websites, they are slow and drain battery fast. Inkflux is built with three core principles:
- Network Efficiency: Data transfer optimized to be as small as possible. Minimal Javascript, no dependencies. Loading a list of 50 articles will download only around 50kb.
- Minimal Runtime: By using Server-Side Rendering (SSR) with Astro, we ship minimal JavaScript to the client. This ensures snappy performance even on older hardware with limited processing power.
- E-Ink First: The UI is designed to respect the limitations and strengths of electronic paper displays—no animations, high contrast, and clear typography.
- Miniflux Integration: Seamlessly connects to your existing Miniflux server.
- Read Unread: Focus on what's new.
- Pagination: Efficiently browse through your feed.
- Article View: Distraction-free reading experience.
- High Contrast UI: Optimized for E-Ink readability.
- Responsive: Works on various screen sizes, but optimized for tablets/readers.
- A running Miniflux server.
- Node.js (if running locally).
-
Clone the repository
-
Install dependencies:
pnpm install
-
Start the development server:
pnpm dev
-
Open
http://localhost:4321in your browser.
You can run Inkflux using Docker:
docker build -t inkflux .
docker run -p 4321:4321 inkfluxQ: Why Astro? A: Astro allows us to render everything on the server and send pure HTML to the client. This is crucial for keeping the client-side footprint minimal, which is our #1 goal.
Q: Can I use this with other RSS services? A: No, Inkflux is specifically built as a client for the Miniflux API.
Q: How do I login? A: You will need your Miniflux server URL and your API Token. You can generate an API Token in your Miniflux settings.
Contributions are welcome! Please read our Contributing Guidelines for details on how to submit pull requests, report issues, and our code of conduct.