yarr

README

yarr

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

This is a fork of the original which was designed predominantly as a small app to run locally on your Mac or PC. It used an embedded database (sqlite) and had features like menu bar icons. This fork strips all of that away to instead prioritize running the application as a service in orchestration like Kubernetes. The sqlite database has been replaced by postgres and all the features for running locally have been removed. What is left is a super simple microservice with all the same RSS features as the original, fine-tuned to run in orchestration with no local dependencies.

usage

yarr requires a Postgres database to use. Once you have that set up the easiest way to use yarr is to run it in Docker:

docker run -it -e YARR_DB=your_postgres_uri_here -p 7070:7070 jgkawell/yarr:latest

Then go to http://localhost:7070 or http://server_ip_address:7070 to start using it.

This fork of yarr is specifically designed to run as a microservice in orchestration. That could be Docker Compose or Kubernetes and the only requirement is the YARR_DB environment variable pointing to an existing Postgres database.

See more:

• Building from source code
• Fever API support

credits

Feather for icons.