mirror of https://github.com/YunoHost-Apps/freshrss_ynh.git synced 2024-09-03 18:36:33 +02:00

FreshRSS package for YunoHost

closember freshrss rss-reader yunohost yunohost-apps

Find a file

Alexandre Aubin b611e4acf2 Merge pull request #132 from YunoHost-Apps/4.3 4.3		2021-11-29 18:56:29 +01:00
.github	4.3	2021-11-21 23:15:26 +01:00
conf	4.3	2021-11-21 23:15:26 +01:00
doc	Fix linter warnings (#120 )	2021-06-28 22:23:04 +02:00
hooks	fix final_path in hooks post_user_create	2021-08-13 20:48:31 +02:00
scripts	4.3	2021-11-21 23:15:26 +01:00
check_process	Fix linter warnings (#120 )	2021-06-28 22:23:04 +02:00
LICENSE	[enh]Add LICENCE file	2016-02-18 19:46:08 +01:00
manifest.json	4.3	2021-11-21 23:15:26 +01:00
README.md	Auto-update README	2021-11-13 15:54:44 +00:00
README_fr.md	Auto-update README	2021-11-13 15:54:44 +00:00

README.md

FreshRSS for YunoHost

Lire ce readme en français.

This package allows you to install FreshRSS quickly and simply on a YunoHost server. If you don't have YunoHost, please consult the guide to learn how to install it.

Overview

RSS aggregator with a nice and mobile-friendly design

Shipped version: 1.18.1~ynh4

Demo: https://demo.freshrss.org

Screenshots

Disclaimers / important information

Configuration

API (mini) How To:

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

Documentation and resources

Official app website: http://freshrss.org/
Official admin documentation: https://freshrss.github.io/FreshRSS/
Upstream app code repository: https://github.com/FreshRSS/FreshRSS
YunoHost documentation for this app: https://yunohost.org/app_freshrss
Report a bug: https://github.com/YunoHost-Apps/freshrss_ynh/issues

Developer info

Please send 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

More info regarding app packaging: https://yunohost.org/packaging_apps