Go to file
Mathias Kresin 8e78c77fc1 introduce release script
This script replaces make-archive.sh and make-tag.sh.

Switch to 'git archive' to create a ZIP file from the repo. Its way
more faster, automates a lot things and works with the GitHub download
HEAD/Release/Tag as ZIP functionality as well.

git archive reads the file .gitattributes to determine which files has
to be excluded from the zip file.

It replaces the following placeholders in common.php:

$Format:%d$": with the output of git log --pretty=format:%d which
contains the tag of the last commit (if tagged).

$Format:%H$": with the hash of the latest included commit.

If no tag can be found the hash is appended to "master" and shown as
version number.

The approach is kind of hackish since no distinct format option for the
tag exists.

Fixes #231, https://github.com/fguillot/miniflux/issues/213#issuecomment-65631765
2015-01-10 09:37:52 +01:00
assets display & update the number of unread items on every page with an "unread items" menu 2015-01-04 18:48:01 +01:00
controllers Fix bug proxy (bad url encoding) + update depencies 2015-01-06 19:08:10 -05:00
data Add Miniflux auto-update feature 2014-03-30 15:59:26 -04:00
docs introduce integration tests 2015-01-04 18:47:59 +01:00
fever Fix a bug for image proxy and update dependencies 2014-12-29 16:52:36 -05:00
lib introduce release script 2015-01-10 09:37:52 +01:00
locales Display the bookmarklet in a text box to be easy to copy and paste 2015-01-02 12:43:17 -05:00
models remove orphaned functions 2015-01-03 23:17:13 +01:00
scripts introduce release script 2015-01-10 09:37:52 +01:00
templates display & update the number of unread items on every page with an "unread items" menu 2015-01-04 18:48:01 +01:00
tests/integration Tests: Fix PHP strict standards warnings 2015-01-04 22:26:14 +01:00
themes Update Hello skin 2015-01-06 22:59:56 -05:00
vendor Add grabber rule for allgemeine-zeitung.de 2015-01-06 20:56:52 -05:00
.gitattributes introduce release script 2015-01-10 09:37:52 +01:00
.gitignore Move to Composer and update to the last version of PicoFeed 2014-12-23 21:28:26 -05: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 Update Hello skin 2015-01-06 22:59:56 -05:00
check_setup.php Move to Composer and update to the last version of PicoFeed 2014-12-23 21:28:26 -05:00
common.php introduce release script 2015-01-10 09:37:52 +01:00
composer.json Add image proxy to avoid https mixed content warnings 2014-12-24 15:58:24 -05:00
config.default.php Update default config 2014-10-30 22:01:17 -04:00
cronjob.php Add option to flush all unread items after X days, default 45 days (avoid very large database) 2014-12-15 20:38:35 -05:00
favicon.ico Move everything to the top-level directory 2013-05-21 12:34:39 +02:00
index.php introduce release script 2015-01-10 09:37:52 +01:00
jsonrpc.php Move to Composer and update to the last version of PicoFeed 2014-12-23 21:28:26 -05:00
phpunit.xml introduce integration tests 2015-01-04 18:47:59 +01: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

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.