miniflux-legacy/README.markdown
Frederic Guillot 9c58f2235c Add contributor
2015-01-12 20:20:51 -05:00

4.8 KiB

Miniflux - Minimalist News Reader

Miniflux is a minimalist and web-based RSS reader.

Features

Host almost anywhere

  • Your Raspberry Pi, a shared web-hosting, a virtual machine or localhost
  • Easy setup => copy and paste the source code and you are done!
  • Use a lightweight Sqlite database instead of Mysql or Postgresql

Readability

  • CSS optimized for readability
  • Responsive design

Privacy and security

  • Remove Feedburner Ads and analytics trackers (1x1 pixels)
  • Open external links inside a new tab with a rel="noreferrer" attribute
  • Use secure HTTP headers (only external images and Youtube/Vimeo/Dailymotion videos are allowed)
  • Article content is filtered before being displayed

Polyglot

  • Translated in English, French, German, Italian, Czech, Spanish, Portuguese and Simplified Chinese
  • RTL languages support

Awesome features

  • Keyboard shortcuts
  • Full article download for feeds that display only a summary
  • Bookmarks
  • Send your favorite articles to Pinboard and Instapaper
  • Enclosure support (videos and podcasts)
  • Feed updates via a cronjob or with the user interface with one click

More

  • Keeps history of read items
  • Import/Export of OPML feeds
  • Themes
  • Auto-update from the user interface
  • Multiple databases (each user has his own database)
  • Image proxy to avoid mixed content warnings with HTTPS

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 and DOM)
  • PHP Sqlite extension
  • cURL extension for PHP or Stream Context with allow_url_fopen=On

Documentation

External projects build around Miniflux:

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.