yarr/readme.md
2023-09-14 13:42:57 +01:00

2.8 KiB

yarr

yarr (yet another rss reader) is a web-based feed aggregator which can be used both as a desktop application and a personal self-hosted server.

The app is a single binary with an embedded database (SQLite).

screenshot

usage

The latest prebuilt binaries for Linux/MacOS/Windows AMD64 are available here.

macos

Download yarr-*-macos64.zip, unzip it, place yarr.app in /Applications folder, open the app, click the anchor menu bar icon, select "Open".

windows

Download yarr-*-windows64.zip, unzip it, open yarr.exe, click the anchor system tray icon, select "Open".

linux

Download yarr-*-linux64.zip, unzip it, place yarr in $HOME/.local/bin and run the script.

For self-hosting, see yarr -h for auth, tls & server configuration flags. For building from source code, see build.md

Fever API support

Fever API is a kind of RSS HTTP API interface, because the Fever API definition is not very clear, so the implementation of Fever server and Client may have some compatibility problems.

The Fever API implemented by Yarr is based on the Fever API spec: https://github.com/DigitalDJ/tinytinyrss-fever-plugin/blob/master/fever-api.md.

Here are some Apps that have been tested to work with yarr. Feel free to test other Clients/Apps and update the list here.

Different apps support different URL/Address formats. Please note whether the URL entered has http:// scheme and / suffix.

App Platforms Config Server URL
Reeder MacOS
iOS
127.0.0.1:7070/fever
http://127.0.0.1:7070/fever
ReadKit MacOS
iOS
http://127.0.0.1:7070/fever
Fluent Reader MacOS
Windows
http://127.0.0.1:7070/fever/
Unread iOS http://127.0.0.1:7070/fever
Fiery Feeds MacOS
iOS
http://127.0.0.1:7070/fever

If you are having trouble using Fever, please open an issue and @icefed, thanks.

credits

Feather for icons.