Go to file
Frédéric Guillot 5cfe2cd839 Improve documentation 2014-04-06 12:02:45 -04:00
assets Add support for multiple users/databases 2014-04-05 20:24:13 -04:00
controllers Add support for multiple users/databases 2014-04-05 20:24:13 -04:00
data Add Miniflux auto-update feature 2014-03-30 15:59:26 -04:00
docs Improve documentation 2014-04-06 12:02:45 -04:00
lib Remove PicoTools 2014-03-16 21:56:43 -04:00
locales Add support for multiple users/databases 2014-04-05 20:24:13 -04:00
models Do not remove .htaccess during auto-update sync 2014-04-05 22:10:10 -04:00
scripts Add utility script to output changes in html 2014-02-09 14:26:02 -05:00
templates Add support for multiple users/databases 2014-04-05 20:24:13 -04:00
themes Include .less files (bootstrap themes) 2014-04-01 14:01:26 +02:00
vendor Revert password_compat to be compatible with Debian 6 2014-03-31 21:19:59 -04:00
.gitignore Add autoflush value 'immediately' and improve gitignore 2013-12-22 21:25:54 -05:00
.htaccess_ovh Add a custom .htaccess for OVH shared-hosting 2014-03-30 15:48:28 -04:00
LICENSE Add license 2013-03-17 18:30:07 -04:00
README.markdown Improve documentation 2014-04-06 12:02:45 -04:00
check_setup.php Split the documentation in multiple files 2014-04-05 21:58:17 -04:00
common.php Add support for multiple users/databases 2014-04-05 20:24:13 -04:00
config.default.php Add default config file 2014-04-05 20:59:53 -04:00
cronjob.php Add support for multiple users/databases 2014-04-05 20:24:13 -04:00
favicon.ico Move everything to the top-level directory 2013-05-21 12:34:39 +02:00
index.php Remove PicoTools 2014-03-16 21:56:43 -04:00
jsonrpc.php Add new methods to the api item.get_all, item.get_all_since and item.get_all_status 2014-02-15 14:09:50 -05:00
robots.txt Add a robots.txt to disallow all search bots 2014-01-05 13:31:06 -05:00

README.markdown

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
  • Auto-update from the user interface

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

Users management

  • Alternate authentication with a Google Account or Mozilla Persona
  • Multiple databases (each user has his own database)

Awesome features

  • Keyboard shortcuts
  • Full article download for feeds that display only a summary (website scraper based on Xpath rules)
  • Feed updates via a cronjob or with the user interface with one click

More

  • Keeps history of read items
  • Basic bookmarks
  • Import/Export of OPML feeds
  • Themes

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

Documentation

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.