miniflux-legacy/README.markdown

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

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

Miniflux is a minimalist and web-based RSS reader.

Features
--------

- Host almost anywhere
- 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!**
- Use a lightweight Sqlite database instead of Mysql or Postgresql
- 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 and Instapaper
- Enclosure support (videos and podcasts)
- Feed updates via a cronjob or with the user interface with one click
- 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`
- Iconv and mbstring extensions

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

- [Installation](docs/installation.markdown)
- [Upgrade to a new version](docs/upgrade.markdown)
- [Cronjob](docs/cronjob.markdown)
- [Advanced configuration](docs/config.markdown)
- [Full article download](docs/full-article-download.markdown)
- [Multiple users](docs/multiple-users.markdown)
- [Translations](docs/translations.markdown)
- [Themes](docs/themes.markdown)
- [Json-RPC API](docs/json-rpc-api.markdown)
- [Fever API](docs/fever.markdown)
- [Run Miniflux with Docker](docs/docker.markdown)
- [FAQ](docs/faq.markdown)
- [Tests](docs/tests.markdown)

License
-------

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

Authors
-------

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

Related projects
----------------

External projects build around Miniflux:

- [Miniflux embedded](https://github.com/repat/miniflux-embedded-android) is an Android app for Miniflux. It's basically an embedded WebView that saves your Miniflux URL and cookies. [Download on the Play Store](https://play.google.com/store/apps/details?id=de.repat.embeddedminiflux).
- [munin-miniflux](https://github.com/dewey/munin-plugins/tree/master/munin-miniflux) is a munin wildcard plugin to draw graphs of your miniflux read and unread count.
- [List of themes](docs/themes.markdown)
Big update 2013-03-17 18:16:25 -04:00			`Miniflux - Minimalist News Reader`
first commit 2013-02-17 21:48:21 -05:00			`=================================`

Move get_ip_address() and get_user_agent() to Request namespace 2016-08-17 21:27:05 -04:00			`[![Build Status](https://travis-ci.org/miniflux/miniflux.svg?branch=master)](https://travis-ci.org/miniflux/miniflux)`

Improve documentation 2014-04-06 12:02:45 -04:00			`Miniflux is a minimalist and web-based RSS reader.`
first commit 2013-02-17 21:48:21 -05:00
			`Features`
			`--------`

Change Hello theme address 2015-02-07 12:09:44 -05:00			`- Host almost anywhere`
Update README 2015-04-06 13:51:02 -04:00			`- 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!`
Improve documentation 2014-04-06 12:02:45 -04:00			`- Use a lightweight Sqlite database instead of Mysql or Postgresql`
Update documentation 2015-12-07 21:05:31 -05:00			`- Remove Feedburner Ads and analytic trackers (1x1 pixels)`
Update readme 2013-02-24 14:09:16 -05:00			- Open external links inside a new tab with a `rel="noreferrer"` attribute
Improve documentation 2014-04-06 12:02:45 -04:00			`- Use secure HTTP headers (only external images and Youtube/Vimeo/Dailymotion videos are allowed)`
			`- Article content is filtered before being displayed`
Update readme 2016-03-08 22:18:47 -05:00			`- Translated in Arabic, English, French, German, Italian, Japanese, Czech, Spanish, Turkish, Portuguese, Russian, Serbian and Simplified Chinese`
Update of PicoFeed 2014-03-16 22:17:44 -04:00			`- RTL languages support`
Improve documentation 2014-04-06 12:02:45 -04:00			`- Keyboard shortcuts`
Improve content grabber 2014-04-15 18:15:31 -04:00			`- Full article download for feeds that display only a summary`
Update readme 2014-12-24 14:44:40 -05:00			`- Bookmarks`
Added group feature and link to original author to docs - Removed mention of unsupported groups feature for Fever API + Added groups feature to feature list + Linked to Frédéric’s personal GitHub profile + Added more clients to tested with Fever API o Fixed URL typo 2015-10-10 20:21:35 +02:00			`- Groups for categorization of feeds (like folders or tags)`
Update readme 2014-12-24 14:44:40 -05:00			`- Send your favorite articles to Pinboard and Instapaper`
Improve content grabber 2014-04-15 18:15:31 -04:00			`- Enclosure support (videos and podcasts)`
Improve documentation 2014-04-06 12:02:45 -04:00			`- Feed updates via a cronjob or with the user interface with one click`
			`- Keeps history of read items`
			`- Import/Export of OPML feeds`
			`- Themes`
Remove Google auth (openid is deprecated) and Persona auth (useless) 2014-11-07 20:53:50 -05:00			`- Auto-update from the user interface`
			`- Multiple databases (each user has his own database)`
Add image proxy to avoid https mixed content warnings 2014-12-24 15:58:24 -05:00			`- Image proxy to avoid mixed content warnings with HTTPS`
Improve documentation 2014-04-06 12:02:45 -04:00
			`Requirements`
			`------------`

			`- Recent version of libxml2 >= 2.7.x (version 2.6.32 on Debian Lenny is not supported anymore)`
			`- PHP >= 5.3.3`
Improve readme 2014-10-29 21:35:00 -04:00			`- PHP XML extensions (SimpleXML and DOM)`
Improve documentation 2014-04-06 12:02:45 -04:00			`- PHP Sqlite extension`
			- cURL extension for PHP or Stream Context with `allow_url_fopen=On`
Move themes outside of the main repo 2015-01-29 21:06:54 -05:00			`- Iconv and mbstring extensions`
Improve documentation 2014-04-06 12:02:45 -04:00
			`Documentation`
			`-------------`

Improve documentation 2014-10-30 22:10:59 -04:00			`- [Installation](docs/installation.markdown)`
			`- [Upgrade to a new version](docs/upgrade.markdown)`
Improve documentation 2014-04-06 12:02:45 -04:00			`- [Cronjob](docs/cronjob.markdown)`
			`- [Advanced configuration](docs/config.markdown)`
			`- [Full article download](docs/full-article-download.markdown)`
			`- [Multiple users](docs/multiple-users.markdown)`
			`- [Translations](docs/translations.markdown)`
			`- [Themes](docs/themes.markdown)`
Improve documentation 2014-10-30 22:10:59 -04:00			`- [Json-RPC API](docs/json-rpc-api.markdown)`
Add Fever API support 2014-10-29 21:28:23 -04:00			`- [Fever API](docs/fever.markdown)`
Move Docker files 2014-11-01 12:14:33 -04:00			`- [Run Miniflux with Docker](docs/docker.markdown)`
Improve documentation 2014-04-06 12:02:45 -04:00			`- [FAQ](docs/faq.markdown)`
Update README 2015-01-04 16:36:56 -05:00			`- [Tests](docs/tests.markdown)`
Improve documentation 2014-04-06 12:02:45 -04:00
Add license 2013-03-17 18:30:07 -04:00			`License`
			`-------`

Update README and contributor list 2015-06-21 09:36:53 -04:00			`- AGPLv3: <http://www.gnu.org/licenses/agpl-3.0.txt>`
Add license 2013-03-17 18:30:07 -04:00
Add author section to the readme 2013-04-05 21:58:17 -04:00			`Authors`
			`-------`

Added group feature and link to original author to docs - Removed mention of unsupported groups feature for Fever API + Added groups feature to feature list + Linked to Frédéric’s personal GitHub profile + Added more clients to tested with Fever API o Fixed URL typo 2015-10-10 20:21:35 +02:00			`- Original author: [Frédéric Guillot](https://github.com/fguillot)`
Update README and contributor list 2015-06-21 09:36:53 -04:00			`- [List of contributors](CONTRIBUTORS.md)`
Add list of contributors to the readme 2013-07-08 18:31:25 -04:00
Update README and contributor list 2015-06-21 09:36:53 -04:00			`Related projects`
			`----------------`
Add list of contributors to the readme 2013-07-08 18:31:25 -04:00
Update README and contributor list 2015-06-21 09:36:53 -04:00			`External projects build around Miniflux:`
Add list of contributors to the readme 2013-07-08 18:31:25 -04:00
Update README and contributor list 2015-06-21 09:36:53 -04:00			`- [Miniflux embedded](https://github.com/repat/miniflux-embedded-android) is an Android app for Miniflux. It's basically an embedded WebView that saves your Miniflux URL and cookies. [Download on the Play Store](https://play.google.com/store/apps/details?id=de.repat.embeddedminiflux).`
			`- [munin-miniflux](https://github.com/dewey/munin-plugins/tree/master/munin-miniflux) is a munin wildcard plugin to draw graphs of your miniflux read and unread count.`
			`- [List of themes](docs/themes.markdown)`