miniflux-legacy/README.markdown

3.4 KiB

Miniflux - Minimalist News Reader

Miniflux is a minimalist web-based news reader. Less is more.

Features

  • Host anywhere (shared hosting, vps or localhost)
  • Easy setup => copy and paste and you are done!
  • CSS optimized for readability
  • Keeps history of read items
  • Remove Feedburner Ads and analytics trackers
  • Import/Export of OPML feeds
  • Feed updates via a cronjob or with the user interface with one click
  • Use secure HTTP headers (only external images and Youtube/Vimeo/Dailymotion videos are allowed)
  • Open external links inside a new tab with a rel="noreferrer" attribute
  • Mobile CSS (responsive design)
  • Keyboard shortcuts
  • Basic bookmarks
  • Translated in English, French, German, Italian, Czech, Spanish, Portuguese and Simplified Chinese
  • RTL languages support
  • Themes
  • Alternative login with a Google Account or Mozilla Persona
  • Full article download for feeds that display only a summary (website scraper based on Xpath rules)
  • Auto-update from the user interface
  • Multiple databases (each user has his own database)

Todo and known bugs

License

Authors

Original author: Frédéric Guillot

Contributors

People who sent a pull-request, report a bug, make a new theme or share a super cool idea:

Many people also sent bug reports and feature requests.

ChangeLog

Requirements

  • Recent version of libxml2 >= 2.7.x (version 2.6.32 on Debian Lenny is not supported anymore)
  • PHP >= 5.3.3
  • PHP XML extensions (SimpleXML, DOM...)
  • PHP Sqlite extension
  • cURL extension for PHP or stream context with (allow_url_fopen=On)
  • Short tags enabled for PHP < 5.4

Documentation