Miniflux - Minimalist News Reader
=================================

[![Build Status](https://travis-ci.org/miniflux/miniflux-legacy.svg?branch=master)](https://travis-ci.org/miniflux/miniflux-legacy)

Miniflux is a minimalist and web-based RSS reader.

Features
--------

- Self-hosted
- Readability (CSS optimized for readability, responsive design, compatible with mobile and tablet devices)
- Easy setup => **copy and paste the source code and you are done!**
- Remove Feedburner Ads and analytic 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
- Translated in Arabic, English, French, German, Italian, Japanese, Czech, Spanish, Turkish, Portuguese, Russian, Serbian and Simplified Chinese
- RTL languages support
- Keyboard shortcuts
- Full article download for feeds that display only a summary
- Bookmarks
- Groups for categorization of feeds (like folders or tags)
- Send your favorite articles to Pinboard, Instapaper, Shaarli or Wallabag
- Enclosure support (videos and podcasts)
- Feed updates via a cronjob or with the user interface in one click
- Keeps history of read items
- Import/Export of OPML feeds
- Themes
- Multiple users
- Image proxy to avoid mixed content warnings with HTTPS

Documentation
-------------

- [ChangeLog](https://github.com/miniflux/miniflux-legacy/blob/master/ChangeLog)
- [Installation and Requirements](https://github.com/miniflux/miniflux-legacy/blob/master/docs/installation.markdown)
- [Upgrade to a new version](https://github.com/miniflux/miniflux-legacy/blob/master/docs/upgrade.markdown)
- [Cronjob](https://github.com/miniflux/miniflux-legacy/blob/master/docs/cronjob.markdown)
- [Advanced configuration](https://github.com/miniflux/miniflux-legacy/blob/master/docs/config.markdown)
- [Full article download](https://github.com/miniflux/miniflux-legacy/blob/master/docs/full-article-download.markdown)
- [Translations](https://github.com/miniflux/miniflux-legacy/blob/master/docs/translations.markdown)
- [Themes](https://github.com/miniflux/miniflux-legacy/blob/master/docs/themes.markdown)
- [Json-RPC API](https://github.com/miniflux/miniflux-legacy/blob/master/docs/json-rpc-api.markdown)
- [Fever API](https://github.com/miniflux/miniflux-legacy/blob/master/docs/fever.markdown)
- [Run Miniflux with Docker](https://github.com/miniflux/miniflux-legacy/blob/master/docs/docker.markdown)
- [FAQ](https://github.com/miniflux/miniflux-legacy/blob/master/docs/faq.markdown)

License
-------

- AGPLv3: <http://www.gnu.org/licenses/agpl-3.0.txt>

Authors
-------

- Original author: Frédéric Guillot
- [List of contributors](https://github.com/miniflux/miniflux/graphs/contributors)