133 lines
4.9 KiB
Markdown
133 lines
4.9 KiB
Markdown
# TinyTinyRSS Fever API plugin
|
|
|
|
See also [Fever API](fever-api.md)
|
|
|
|
## Description
|
|
|
|
This plugin is an open source module for TinyTinyRSS which simulates the Fever API for reading the RSS Feeds with your Fever clients.
|
|
|
|
- - -
|
|
|
|
* <a href="#features">Features</a>
|
|
* <a href="#download">Downloads</a>
|
|
* <a href="#supported">Supported/Tested Clients</a>
|
|
* <a href="#installation">Installation</a>
|
|
* <a href="#debug">Debugging</a>
|
|
* <a href="#error">Error reporting</a>
|
|
* <a href="#license">License</a>
|
|
* <a href="#changelog">Changelog</a>
|
|
|
|
## <a name="features">Features</a>
|
|
|
|
Following Features are implemented:
|
|
|
|
* getting new RSS items
|
|
* getting starred RSS items
|
|
* setting read marker for item(s)
|
|
* setting starred marker for item(s)
|
|
* hot is **not** supported
|
|
|
|
## <a name="downloads">Downloads</a>
|
|
|
|
Please click on [```releases```](https://github.com/dasmurphy/tinytinyrss-fever-plugin/releases) button to download the latest stable version. Or click the [```Download ZIP```](https://github.com/dasmurphy/tinytinyrss-fever-plugin/archive/master.zip) button to download the edge version. ;)
|
|
|
|
## <a name="supported">Supported/Tested Clients</a>
|
|
|
|
These clients should be working fine with this API emulation.
|
|
|
|
* [Reeder](http://reederapp.com) - iPhone
|
|
* [Mr.Reader](http://www.curioustimes.de/mrreader/index.html) - iPad
|
|
* [ReadKit](http://readkitapp.com) - OS X
|
|
* [Press](https://play.google.com/store/apps/details?id=com.twentyfivesquares.press) - Android
|
|
* [Meltdown](https://github.com/phubbard/Meltdown) - Android
|
|
* displays feeds as 'orphan' items, but runs fine
|
|
|
|
## <a name="installation">Installation</a>
|
|
|
|
**IMPORTENT** Enable external API access in your TinyTinyRSS installation! Otherwise this will not work!
|
|
|
|
Upload the ```fever``` folder in the ```plugins``` folder of your TinyTinyRSS installation. Enable the plugin in the preferences and set your password for the Fever API.
|
|
|
|
See [here](http://tt-rss.org/forum/viewtopic.php?f=22&t=1981) for more detailed informations.
|
|
|
|
## <a name="debug">Debugging</a>
|
|
|
|
In the file ```fever_api.php``` there are two flags for debugging at the beginning of the file.
|
|
|
|
* ```DEBUG``` - set this to true to get a fever_debug.txt file in your root folder of the Tiny Tiny RSS installation.
|
|
* ```DEBUG_USER``` - set this to the id (from ttrss_users) of your user you would like to always authenticate on your Tiny Tiny RSS installation. The authentication process is then skipped and the api gets always authentication.
|
|
* ```DEBUG_FILE``` - set this to a filename that suits you for debugging this plugin if you need to.
|
|
|
|
## <a name="error">Error reporting</a>
|
|
|
|
If you got problems with authentication after updating the plugin, try to reenter the password in TinyTinyRSS Fever plugin and save it again.
|
|
|
|
When you find an error you may post it in the plugin [thread](http://tt-rss.org/forum/viewtopic.php?f=22&t=1981) or here on github.com in the [Issues](https://github.com/dasmurphy/tinytinyrss-fever-plugin/issues/) section.
|
|
|
|
Please include your debug log which should be cleaned up. Please remove your username, password and apikey before posting it.
|
|
|
|
## <a name="license">License</a>
|
|
|
|
Licensed under GNU GPL version 2 (<- I think this is okay for this plugin…)
|
|
|
|
## <a name="changelog">Changelog</a>
|
|
|
|
v1.0-v1.2 - 2013/5/27 - DigitalDJ version
|
|
|
|
* see this [thread](http://tt-rss.org/forum/viewtopic.php?f=22&t=1981) in the TinyTinyRSS Forum
|
|
|
|
v1.3 - 2013/6/27
|
|
|
|
* fixed several bugs in json output from the plugin
|
|
* added a small fix for Mr.Reader 2.0 so it can complete loading of all items (see [FAQ](http://www.curioustimes.de/mrreader/faq/))
|
|
* added first Mr.Reader compatiblity without marking items read/starred
|
|
* changed the field ```date_entered``` to ```updated``` for better reading experience
|
|
|
|
v1.4 - 2013/6/28
|
|
|
|
* fixed authentication with Mr.Reader 2.0
|
|
* fixed debugging options
|
|
|
|
v1.4.1 - 2013/6/28
|
|
|
|
* removed password from debug log file
|
|
|
|
v1.4.2 - 2013/6/28
|
|
|
|
* changed the ```DEBUG_USER``` evaluation a little bit for disabling authentication without DEBUG = true
|
|
|
|
v1.4.3 - 2013/6/28
|
|
|
|
* added ```DEBUG_FILE``` to debug configuration
|
|
* changed authentication call from Mr.Reader so that the reply is also uppercase, since the API-KEY comes in uppercase from clients
|
|
* fixed debug output while authentication in Mr.Reader with displaying the email adress
|
|
|
|
v1.4.4 - 2013/6/28
|
|
|
|
* updated the documentation
|
|
* changed some in saving the generated API-KEY - now its generated like in the Fever API documentation
|
|
|
|
v1.4.5 - 2013/6/29
|
|
|
|
* fixed the cannot mark/star bug in Mr.Reader
|
|
|
|
v1.4.6 - 2014/1/15
|
|
|
|
* merged bigger pull request to get more Fever API RSS Readers to work
|
|
|
|
v1.4.7 - 2014/1/15
|
|
|
|
* added rewrite url function to module, since it was removed from tinytinyrss
|
|
|
|
v2.0 - 2017/5/16
|
|
|
|
* Fix ccache exceptions
|
|
* Sync previously copied snipets with latest tt-rss source
|
|
* General clean up / refactor
|
|
* Replace clunky sanitization with what is provided by tt-rss
|
|
* Use new Article class for enclosures
|
|
|
|
v2.1 - 2017/12/25
|
|
|
|
* Sync previously copied snipets with latest tt-rss source
|
|
* Use PDO API for DB queries |