03dbc3e17d
|
||
|---|---|---|
| assets | ||
| controllers | ||
| data | ||
| docs | ||
| fever | ||
| lib | ||
| locales | ||
| models | ||
| rules | ||
| scripts | ||
| templates | ||
| tests/integration | ||
| themes | ||
| vendor | ||
| .gitattributes | ||
| .gitignore | ||
| .htaccess_ovh | ||
| CONTRIBUTORS.md | ||
| Dockerfile | ||
| LICENSE | ||
| README.markdown | ||
| check_setup.php | ||
| common.php | ||
| composer.json | ||
| config.default.php | ||
| cronjob.php | ||
| favicon.ico | ||
| index.php | ||
| jsonrpc.php | ||
| phpunit.xml | ||
| producer.php | ||
| robots.txt | ||
| worker.php | ||
README.markdown
Miniflux - Minimalist News Reader
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
- Upgrade to a new version
- Cronjob
- Advanced configuration
- Full article download
- Multiple users
- Translations
- Themes
- Json-RPC API
- Fever API
- Run Miniflux with Docker
- FAQ
- Tests
License
Authors
- Original author: Frédéric Guillot
- List of contributors
Related projects
External projects build around Miniflux:
- Miniflux embedded is an Android app for Miniflux. It's basically an embedded WebView that saves your Miniflux URL and cookies. Download on the Play Store.
- munin-miniflux is a munin wildcard plugin to draw graphs of your miniflux read and unread count.
- List of themes