freshrss_ynh/README.md

FreshRSS package for YunoHost

This package allow you to install FreshRSS quickly and simply on a YunoHost server. If you don't have YunoHost, please see here to know how to install and enjoy it.

Overview

An efficient but powerful RSS aggregator with a nice and mobile-friendly design, as well as extension and themes support.

Shipped version: 1.16.2

Screenshots

Demo

• Official demo

Configuration

API (mini) How To :

• Into your user profile : Settings > profil
• Setup an API password
• Check the API is working : https://exemple.tld/rss/api/greader.php
• Setup your client with : username : ynh user, password : the password you just setup, url https://exemple.tld/rss/api/greader.php

Documentation

• Official documentation: https://freshrss.github.io/FreshRSS/

Supported architectures

• x86-64b -
• ARMv8-A -
• Jessie x86-64b -

Links

• Report a bug: https://github.com/YunoHost-Apps/freshrss_ynh/issues
• App website: https://freshrss.org/
• Upstream app repository: https://github.com/FreshRSS/FreshRSS
• YunoHost website: https://yunohost.org/

---

Developers info

Only if you want to use a testing branch for coding, instead of merging directly into master. Please do your pull request to the testing branch.

To try the testing branch, please proceed like that.

sudo yunohost app install https://github.com/YunoHost-Apps/freshrss_ynh/tree/testing --debug
or
sudo yunohost app upgrade freshrss -u https://github.com/YunoHost-Apps/freshrss_ynh/tree/testing --debug