MMM-Miniflux

A MagicMirror² module that displays articles from a Miniflux RSS reader instance.

Installation

cd ~/MagicMirror/modules
git clone https://github.com/CuSO4Deposit/MMM-Miniflux.git

No npm install needed — this module has zero dependencies.

Configuration

Add to your config/config.js:

{
    module: "MMM-Miniflux",
    position: "top_left",
    header: "News",
    config: {
        baseUrl: "https://rss.example.com",
        apiKey: "your-miniflux-api-key",
    }
}

Options

Option	Type	Default	Description
baseUrl	string	required	Miniflux instance URL
apiKey	string	required	Miniflux API key (Settings > API Keys)
updateInterval	number	300000	Polling interval in ms (default 5 min)
maxItems	number	10	Max entries to display
onlyUnread	boolean	true	Only show unread entries
showDescription	boolean	true	Show article summary
showPublishDate	boolean	true	Show relative publish time
showSourceTitle	boolean	true	Show feed name
truncateDescription	number	100	Truncate summary to N chars (0 = no limit)
animationSpeed	number	1000	DOM update animation in ms