8e78c77fc1
This script replaces make-archive.sh and make-tag.sh. Switch to 'git archive' to create a ZIP file from the repo. Its way more faster, automates a lot things and works with the GitHub download HEAD/Release/Tag as ZIP functionality as well. git archive reads the file .gitattributes to determine which files has to be excluded from the zip file. It replaces the following placeholders in common.php: $Format:%d$": with the output of git log --pretty=format:%d which contains the tag of the last commit (if tagged). $Format:%H$": with the hash of the latest included commit. If no tag can be found the hash is appended to "master" and shown as version number. The approach is kind of hackish since no distinct format option for the tag exists. Fixes #231, https://github.com/fguillot/miniflux/issues/213#issuecomment-65631765 |
||
---|---|---|
assets | ||
controllers | ||
data | ||
docs | ||
fever | ||
lib | ||
locales | ||
models | ||
scripts | ||
templates | ||
tests/integration | ||
themes | ||
vendor | ||
.gitattributes | ||
.gitignore | ||
.htaccess_ovh | ||
check_setup.php | ||
common.php | ||
composer.json | ||
config.default.php | ||
cronjob.php | ||
Dockerfile | ||
favicon.ico | ||
index.php | ||
jsonrpc.php | ||
LICENSE | ||
phpunit.xml | ||
README.markdown | ||
robots.txt |
Miniflux - Minimalist News Reader
Miniflux is a minimalist and web-based RSS reader.
Features
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
Readability
- CSS optimized for readability
- Responsive design
Privacy and security
- Remove Feedburner Ads and analytics 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
Polyglot
- Translated in English, French, German, Italian, Czech, Spanish, Portuguese and Simplified Chinese
- RTL languages support
Awesome features
- Keyboard shortcuts
- Full article download for feeds that display only a summary
- Bookmarks
- 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
More
- 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
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
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.
- Hello Theme Theme for Miniflux.
Todo and known bugs
- See Issues: https://github.com/fguillot/miniflux/issues
License
Authors
Original author: Frédéric Guillot
Contributors
People who sent a pull-request, report a bug, make a new theme or share a super cool idea:
- André Kelpe
- Augustin Lacour
- Ayodio
- Bjauy
- Bohwaz
- Chase Arnold
- Chris Lemonier
- Delehef
- Derjus
- Eauland
- Félix
- Geriel Castro
- Hika0
- Horsely
- Ing. Jan Kaláb
- Itoine
- James Scott-Brown
- James Barwell
- Julian Oster
- Jarek
- Kaminary Shadows
- Luca Marra
- Martin Simon
- Mathias Kresin
- Maxime
- Meradoou
- MonsieurPaulLeBoulanger
- Necku
- Nicolas Dewaele
- Pcwalden
- Pitel
- Silvus
- Skasi7
- Thiriot Christophe
- Tobi
- Vincent Ozanam
- Ygbillet
Many people also sent bug reports and feature requests.