miniflux-legacy/README.markdown

127 lines
3.7 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
--------
2014-04-06 18:02:45 +02:00
### 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
2013-02-18 03:48:21 +01:00
- CSS optimized for readability
2014-04-06 18:02:45 +02:00
- Responsive design
### Privacy and security
- 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
### Polyglot
- Translated in English, French, German, Italian, Czech, Spanish, Portuguese and Simplified Chinese
2014-03-17 03:17:44 +01:00
- RTL languages support
2014-04-06 18:02:45 +02:00
### Users management
- Alternate authentication with a Google Account or Mozilla Persona
- Multiple databases (each user has his own database)
2013-02-18 03:48:21 +01:00
2014-04-06 18:02:45 +02:00
### Awesome features
- Keyboard shortcuts
2014-04-16 00:15:31 +02:00
- Full article download for feeds that display only a summary
- 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
### 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, DOM...)
- PHP Sqlite extension
- cURL extension for PHP or Stream Context with `allow_url_fopen=On`
Documentation
-------------
- [Installation and updates](docs/installation-and-updates.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)
- [Session](docs/session.markdown)
- [API documentation](http://miniflux.net/api.html)
- [FAQ](docs/faq.markdown)
2013-04-06 03:52:58 +02:00
Todo and known bugs
-------------------
2013-02-18 03:48:21 +01:00
2013-04-06 03:52:58 +02:00
- See Issues: <https://github.com/fguillot/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
- André Kelpe: https://github.com/fs111
- Ayodio: https://github.com/ayodio
2013-08-04 20:26:46 +02:00
- Bjauy: https://github.com/bjauy
- Bohwaz: https://github.com/bohwaz
2013-08-18 18:28:15 +02:00
- Chase Arnold: https://github.com/chase4926
2013-07-20 03:01:55 +02:00
- Chris Lemonier: https://github.com/chrislemonier
2013-11-23 04:49:52 +01:00
- Delehef: https://github.com/delehef
2013-07-09 00:31:25 +02:00
- 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
2013-07-09 00:31:25 +02:00
- Horsely: https://github.com/horsley
2013-07-14 18:35:11 +02:00
- Ing. Jan Kaláb: https://github.com/Pitel
- Itoine: https://github.com/itoine
2013-07-21 17:11:41 +02:00
- James Scott-Brown: https://github.com/jamesscottbrown
- James Barwell: https://github.com/JamesBarwell
2014-06-10 00:56:30 +02:00
- Julian Oster: https://github.com/jlnostr
2013-07-09 00:31:25 +02:00
- Luca Marra: https://github.com/facciocose
2013-07-20 15:10:17 +02:00
- Maxime: https://github.com/EpocDotFr
2013-07-09 00:31:25 +02:00
- MonsieurPaulLeBoulanger: https://github.com/MonsieurPaulLeBoulanger
- Necku: https://github.com/Necku
- Nicolas Dewaele: http://adminrezo.fr/
2014-02-18 04:04:49 +01:00
- Pcwalden: https://github.com/pcwalden
2014-02-28 23:41:25 +01:00
- Pitel: https://github.com/Pitel
- Silvus: https://github.com/Silvus
2013-12-18 03:45:03 +01:00
- Skasi7: https://github.com/skasi7
2013-07-09 00:31:25 +02:00
- Thiriot Christophe: https://github.com/doubleface
2014-05-17 15:26:17 +02:00
- Tobi: https://github.com/tobir
- Vincent Ozanam
2013-07-09 00:31:25 +02:00
- Ygbillet: https://github.com/ygbillet
Many people also sent bug reports and feature requests.