miniflux-legacy/README.markdown

123 lines
4.2 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
=================================
Miniflux is a minimalist web-based news reader.
Features
--------
- Host anywhere (shared hosting, vps or localhost)
- Easy setup => copy and paste and you are done!
- CSS optimized for readability
- Keep an history of read items
- Remove Feedburner Ads and analytics trackers
- Import/Export OPML feeds
- Feeds update by a cronjob or with the user interface in one click
- Protected by a login/password (only one possible user)
2013-04-06 03:52:58 +02:00
- Use secure headers (only external images and Youtube/Vimeo videos are allowed)
2013-02-24 20:09:16 +01:00
- Open external links inside a new tab with a `rel="noreferrer"` attribute
2013-03-17 23:16:25 +01:00
- Mobile CSS (responsive design)
2013-04-06 03:52:58 +02:00
- Keyboard shortcuts
2013-02-18 03:48:21 +01:00
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
-------
- Original author: [Frédéric Guillot](http://fredericguillot.com/)
- Contributors: [Pull requesters](https://github.com/fguillot/miniflux/pulls?direction=desc&page=1&sort=created&state=closed) and [Bug reporters](https://github.com/fguillot/miniflux/issues?page=1&state=closed)
2013-02-18 03:48:21 +01:00
Requirements
------------
- PHP >= 5.3.7
2013-03-17 23:16:25 +01:00
- PHP XML extensions (SimpleXML, DOM...)
2013-04-06 03:52:58 +02:00
- PHP Sqlite extension
2013-02-18 03:48:21 +01:00
2013-03-17 23:16:25 +01:00
Libraries used
--------------
2013-02-18 03:48:21 +01:00
- [PicoFeed](https://github.com/fguillot/picoFeed)
- [PicoFarad](https://github.com/fguillot/picoFarad)
- [PicoTools](https://github.com/fguillot/picoTools)
- [PicoDb](https://github.com/fguillot/picoDb)
- [SimpleValidator](https://github.com/fguillot/simpleValidator)
- [PHP 5.5 password backport](https://github.com/ircmaxell/password_compat)
2013-02-18 03:48:21 +01:00
Installation
------------
1. You must have a web server with PHP installed (version 5.3.7 minimum) with the Sqlite and XML extensions
2013-03-17 23:16:25 +01:00
2. Download the source code and copy the directory miniflux where you want
3. Check if the directory data is writeable (Miniflux store everything inside a Sqlite database)
4. With your browser go to <http://yourpersonalserver/miniflux>
2013-03-22 00:57:47 +01:00
5. The default login and password is **admin/admin**
2013-03-17 23:16:25 +01:00
6. Start to use the software
FAQ
----
### How to update your feeds with a cronjob?
2013-05-21 12:25:13 +02:00
You just need to be inside the directory `miniflux` and run the script `cronjob.php`.
Parameters | Type | Value
--------------------|--------------------------------|-----------------------------
2013-05-21 20:18:41 +02:00
--limit | optional | number of feeds
2013-05-21 12:25:13 +02:00
--call-interval | optional, excluded by --limit, require --update-interval | time in minutes < update interval time
--update-interval | optional, excluded by --limit, require --call-interval | time in minutes >= call interval time
2013-03-17 23:16:25 +01:00
2013-05-18 20:35:16 +02:00
Examples:
2013-03-17 23:16:25 +01:00
crontab -e
2013-05-21 12:25:13 +02:00
# Update all feeds
2013-03-17 23:16:25 +01:00
0 */4 * * * cd /path/to/miniflux && php cronjob.php >/dev/null 2>&1
2013-05-18 20:35:16 +02:00
2013-05-21 12:25:13 +02:00
# Update the 10 oldest feeds each time
2013-05-18 20:35:16 +02:00
0 */4 * * * cd /path/to/miniflux && php cronjob.php --limit=10 >/dev/null 2>&1
2013-05-21 12:25:13 +02:00
# Update all feeds in 60 minutes (updates the 8 oldest feeds each time with a total of 120 feeds).
* */4 * * * cd /path/to/miniflux && php cronjob.php --call-interval=4 --update-interval=60 >/dev/null 2>&1
2013-03-17 23:16:25 +01:00
2013-05-21 20:39:18 +02:00
Note: cronjob.php can also be called from the web; in this case specify the options as GET variables. For example: <http://yourpersonalserver/miniflux/cronjob.php?call-interval=4&update-interval=60>
2013-05-21 20:38:09 +02:00
2013-03-17 23:16:25 +01:00
### How Miniflux update my feeds from the user interface?
Miniflux use an Ajax request to refresh each subscription.
By default, there is only 5 feeds updated in parallel.
### I have 600 subscriptions, how Miniflux handle that?
Your life is cluttered.
### Why there is no categories? Why the feature X is missing?
Miniflux is a minimalist software. Less is more.
2013-04-06 03:52:58 +02:00
### Why there is no favourites?
Use the right tool for the right job.
2013-04-06 03:59:50 +02:00
Your browser already have bookmarks, if you don't like it there is many online tools for that.
2013-04-06 03:52:58 +02:00
### I found a bug, what next?
2013-03-22 00:57:47 +01:00
Report the bug to the [issues tracker](https://github.com/fguillot/miniflux/issues) and I will fix it.
You can report feeds that doesn't works properly too.
### Which browser is compatible with Miniflux?
Miniflux is tested with the last version of Mozilla Firefox, Google Chrome and Safari.
I don't use Microsoft products, then I have no idea if Miniflux works correctly with Internet Explorer.