miniflux-legacy/README.markdown

129 lines
4.8 KiB
Markdown
Raw Normal View History

2013-03-17 23:16:25 +01:00
Miniflux - Minimalist News Reader
2013-02-18 03:48:21 +01:00
=================================
2014-04-06 18:02:45 +02:00
Miniflux is a minimalist and web-based RSS reader.
2013-02-18 03:48:21 +01:00
Features
--------
2015-02-07 18:09:44 +01:00
- Host almost anywhere
2015-04-06 19:51:02 +02: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!**
2014-04-06 18:02:45 +02:00
- Use a lightweight Sqlite database instead of Mysql or Postgresql
- Remove Feedburner Ads and analytics trackers (1x1 pixels)
2013-02-24 20:09:16 +01:00
- Open external links inside a new tab with a `rel="noreferrer"` attribute
2014-04-06 18:02:45 +02:00
- Use secure HTTP headers (only external images and Youtube/Vimeo/Dailymotion videos are allowed)
- Article content is filtered before being displayed
2015-04-06 19:51:02 +02:00
- Translated in Arabic, English, French, German, Italian, Czech, Spanish, Portuguese, Serbian and Simplified Chinese
2014-03-17 03:17:44 +01:00
- RTL languages support
2014-04-06 18:02:45 +02:00
- Keyboard shortcuts
2014-04-16 00:15:31 +02:00
- Full article download for feeds that display only a summary
2014-12-24 20:44:40 +01:00
- Bookmarks
- Send your favorite articles to Pinboard and Instapaper
2014-04-16 00:15:31 +02:00
- Enclosure support (videos and podcasts)
2014-04-06 18:02:45 +02: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
- Auto-update from the user interface
- Multiple databases (each user has his own database)
- Image proxy to avoid mixed content warnings with HTTPS
2014-04-06 18:02:45 +02:00
Requirements
------------
- Recent version of libxml2 >= 2.7.x (version 2.6.32 on Debian Lenny is not supported anymore)
- PHP >= 5.3.3
2014-10-30 02:35:00 +01:00
- PHP XML extensions (SimpleXML and DOM)
2014-04-06 18:02:45 +02:00
- PHP Sqlite extension
- cURL extension for PHP or Stream Context with `allow_url_fopen=On`
2015-01-30 03:06:54 +01:00
- Iconv and mbstring extensions
2014-04-06 18:02:45 +02:00
Documentation
-------------
2014-10-31 03:10:59 +01:00
- [Installation](docs/installation.markdown)
- [Upgrade to a new version](docs/upgrade.markdown)
2014-04-06 18:02:45 +02: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)
2014-10-31 03:10:59 +01:00
- [Json-RPC API](docs/json-rpc-api.markdown)
2014-10-30 02:28:23 +01:00
- [Fever API](docs/fever.markdown)
2014-11-01 17:14:33 +01:00
- [Run Miniflux with Docker](docs/docker.markdown)
2014-04-06 18:02:45 +02:00
- [FAQ](docs/faq.markdown)
2015-01-04 22:36:56 +01:00
- [Tests](docs/tests.markdown)
2014-04-06 18:02:45 +02:00
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.
2015-02-07 18:09:44 +01:00
- [List of themes](docs/themes.markdown)
2013-04-06 03:52:58 +02:00
Todo and known bugs
-------------------
2013-02-18 03:48:21 +01:00
2015-02-07 17:49:55 +01:00
- See Issues: <https://github.com/miniflux/miniflux/issues>
2013-02-18 03:48:21 +01:00
2013-03-17 23:30:07 +01:00
License
-------
- AGPL: <http://www.gnu.org/licenses/agpl-3.0.txt>
2013-04-06 03:58:17 +02:00
Authors
-------
2013-07-09 00:31:25 +02:00
Original author: [Frédéric Guillot](http://fredericguillot.com/)
### Contributors
2013-09-19 23:54:50 +02:00
People who sent a pull-request, report a bug, make a new theme or share a super cool idea:
2013-07-09 00:31:25 +02:00
2014-10-30 02:35:00 +01:00
- [André Kelpe](https://github.com/fs111)
- [Augustin Lacour](https://github.com/gugu4-9)
- [Ayodio](https://github.com/ayodio)
- [Bjauy](https://github.com/bjauy)
- [Bohwaz](https://github.com/bohwaz)
- [Chase Arnold](https://github.com/chase4926)
- [Chris Lemonier](https://github.com/chrislemonier)
- [Delehef](https://github.com/delehef)
- [Derjus](https://github.com/derjus)
- [Eauland](https://github.com/eauland)
- [Félix](https://github.com/dysosmus)
- [Geriel Castro](https://github.com/GerielCastro)
- [Hika0](https://github.com/hika0)
- [Horsely](https://github.com/horsley)
- [Ing. Jan Kaláb](https://github.com/Pitel)
- [Itoine](https://github.com/itoine)
2015-01-13 02:20:51 +01:00
- [Kordian Bruck](https://github.com/kordianbruck)
2014-10-30 02:35:00 +01:00
- [James Scott-Brown](https://github.com/jamesscottbrown)
- [James Barwell](https://github.com/JamesBarwell)
- [Julian Oster](https://github.com/jlnostr)
- [Jarek](https://github.com/jarek)
2015-01-02 18:17:04 +01:00
- [Kaminary Shadows](https://github.com/kaminary)
2014-10-30 02:35:00 +01:00
- [Luca Marra](https://github.com/facciocose)
2014-11-01 17:14:33 +01:00
- [Martin Simon](https://github.com/c0ding)
2014-10-30 02:35:00 +01:00
- [Mathias Kresin](https://github.com/mkresin)
- [Maxime](https://github.com/EpocDotFr)
- [Meradoou](https://github.com/meradoou)
2015-03-09 23:46:43 +01:00
- [Miloš Jovanović](https://github.com/mrjovanovic)
2014-10-30 02:35:00 +01:00
- [MonsieurPaulLeBoulanger](https://github.com/MonsieurPaulLeBoulanger)
- [Necku](https://github.com/Necku)
- [Nicolas Dewaele](http://adminrezo.fr/)
- [Pcwalden](https://github.com/pcwalden)
- [Pitel](https://github.com/Pitel)
- [Silvus](https://github.com/Silvus)
- [Skasi7](https://github.com/skasi7)
- [Thiriot Christophe](https://github.com/doubleface)
- [Tobi](https://github.com/tobir)
- Vincent Ozanam
2014-10-30 02:35:00 +01:00
- [Ygbillet](https://github.com/ygbillet)
2015-04-22 00:22:47 +02:00
- [小秦](https://github.com/xqin)
2013-07-09 00:31:25 +02:00
Many people also sent bug reports and feature requests.