TiloBox
Back to directory
Miniflux project preview

Miniflux

A minimalist feed reader with web and API clients, full-text options, filtering rules, and scheduled refreshes.

LicenseApache-2.0
GitHub stars9.6k
Last commit1 weeks ago
Tags6 topics
Feed ReaderGoRssSelf HostedOpen SourceDeveloper Tools
Overview

Why consider Miniflux?

Miniflux is a lightweight, self-hosted feed reader written in Go that supports RSS, Atom, and JSON formats. Designed for simplicity and speed, it pairs with PostgreSQL to deliver privacy-conscious feed aggregation without bloat.

Guided learning

Learn Miniflux by building

Practical setup notes, real use cases, and copy-ready examples in one focused guide.

4 min read 5 sections
In this guide5 sections

Deploying and Operating Miniflux Feed Reader

Miniflux is a minimalist and opinionated feed reader designed to be fast and lightweight. As detailed in the project's official README, the system focuses on speed, simplicity, and low resource utilization rather than complicated social features, providing an efficient environment for tracking content feeds across personal servers.

When subscribing to content streams, compatibility across syndication standards is essential. Supported feed formats include Atom 0.3 and 1.0, RSS 1.0 and 2.0, and JSON Feed 1.0 and 1.1. According to the README specifications, users can also import and export existing subscription lists using OPML files, fetch site favicons automatically, and organize items with categories and bookmarks.

Architecture and System Requirements

The architecture prioritizes operational reliability and minimal overhead. The application is written in Go, compiles to a statically linked binary, and works exclusively with PostgreSQL. As noted on the official repository page, Miniflux does not use an ORM, embeds all static assets directly into the binary with Go's embed package, and uses only a negligible amount of system memory during feed polling.

Privacy and Content Scrubbing

Miniflux includes built-in safeguards to preserve reader anonymity and protect against tracking telemetry. It removes pixel trackers and strips tracking parameters from URLs such as utm_source, utm_medium, and fbclid. Documentation in the project repository highlights that external links use strict security attributes, HTTP referrer leakage is suppressed, and external content is sanitized prior to browser presentation.

Content Rules and Language Detection

Users can refine incoming feeds by establishing custom processing instructions. Miniflux features a regex-based filtering system where block rules ignore matching articles and keep rules retain only matching entries using RE2 syntax. As outlined in the filtering rules documentation, rules can target specific fields such as entry titles, URLs, tags, authors, or dates to prevent unwanted content from reaching the database.

Accessibility and multi-language rendering are handled natively by the engine. Miniflux reads the language declared by feeds and entries, automatically rendering article titles and content with a matching HTML lang attribute. As documented in the 2.3.3 release notes, this feature parses language data from RSS, Atom, RDF, and JSON Feed sources to enhance screen reader accuracy and browser translation.

Configuration and Command-Line Operations

Runtime configuration can be established through a configuration file or environment variables. Configuration files are loaded first if specified, while environment variables take precedence over options defined in the configuration file. According to the configuration parameters reference, boolean parameters accept standard values such as 1/0, yes/no, or true/false, and secret keys can be loaded directly from file paths ending in _FILE.

Operators can specify a custom configuration file path using the config-file command line parameter. According to the command line documentation, passing the configuration file path initializes the server with those parameters:

bash
1miniflux -config-file /etc/miniflux.conf

Administrators can inspect all active configuration values by executing the config-dump command from the terminal. As shown in the command line documentation, running the dump flag outputs the evaluated settings to verify the database connection string and daemon parameters before starting the service:

bash
1miniflux -config-dump

Licensing and Ecosystem

Miniflux is developed as open-source software by Frédéric Guillot and community contributors. The software is released under the terms of the Apache License Version 2.0. Users interested in exploring user guides, deployment instructions, and hosting details can visit the official website or review the complete license text on the license page.

Related tools

More options with a similar category or technology profile.

Miniflux FAQs

Miniflux is listed as a Content Cms tool on TiloBox. Review the overview, features, and official documentation on this page to decide whether it solves your specific workflow.

Start with the project's GitHub repository and official website for supported installation and deployment instructions. Test the setup with representative data or a small project before rolling it out more widely.

Miniflux is listed under the Apache-2.0 license. Read the complete license text and the project's notices before using, modifying, or distributing the software.

Production readiness depends on your requirements. Review maintenance activity, security practices, documentation, backup and upgrade procedures, and compatibility with your stack; then validate it in a non-production environment.

Miniflux is listed as an alternative to Feedly. Compare the core workflow, deployment model, integrations, and licensing against your must-have requirements before switching.