Go to file
Frédéric Guillot e26a1873ef Update documentation 2014-11-07 20:41:09 -05:00
assets HTML Cleanup 2014-11-05 14:45:10 +01:00
controllers Split settings page into mutliple pages 2014-11-07 20:37:12 -05:00
data Add Miniflux auto-update feature 2014-03-30 15:59:26 -04:00
docs Update documentation 2014-11-07 20:41:09 -05:00
fever Fever API - Fix Mark all as read for feed unread 2014-11-06 19:54:12 +01:00
lib Add option to force RTL mode per feed and improve feed modification 2014-10-19 19:14:33 -04:00
locales Split settings page into mutliple pages 2014-11-07 20:37:12 -05:00
models Add Fever API support 2014-10-29 21:28:23 -04:00
scripts Move Docker files 2014-11-01 12:14:33 -04:00
templates Split settings page into mutliple pages 2014-11-07 20:37:12 -05:00
themes Hello Theme: do not depend on language specific labels 2014-11-05 17:10:10 +01:00
vendor Add grabber rule for undeadly.org 2014-11-02 08:55:20 -05:00
.gitignore Fix gitignore: missing file PicoFeed/Config.php 2014-05-20 20:25:39 -04:00
.htaccess_ovh Update OVH .htaccess 2014-10-30 20:36:48 -04:00
Dockerfile Move Docker files 2014-11-01 12:14:33 -04:00
LICENSE Add license 2013-03-17 18:30:07 -04:00
README.markdown Move Docker files 2014-11-01 12:14:33 -04:00
check_setup.php Change text message for check_setup.php 2014-05-28 19:24:59 -04:00
common.php Prefix custom config with __DIR__ 2014-11-06 21:15:37 -05:00
config.default.php Update default config 2014-10-30 22:01:17 -04:00
cronjob.php Update to the last version of PicoFeed 2014-05-20 14:20:27 -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
  • Enclosure support (videos and podcasts)
  • 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 and 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.