mirror of
https://github.com/YunoHost-Apps/freshrss_ynh.git
synced 2024-09-03 18:36:33 +02:00
58 lines
No EOL
2.2 KiB
Markdown
58 lines
No EOL
2.2 KiB
Markdown
<!--
|
|
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
|
|
It shall NOT be edited by hand.
|
|
-->
|
|
|
|
# FreshRSS for YunoHost
|
|
|
|
[](https://dash.yunohost.org/appci/app/freshrss)  
|
|
[](https://install-app.yunohost.org/?app=freshrss)
|
|
|
|
*[Lire ce readme en français.](./README_fr.md)*
|
|
|
|
> *This package allows you to install FreshRSS quickly and simply on a YunoHost server.
|
|
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
|
|
|
|
## Overview
|
|
|
|
RSS aggregator with a nice and mobile-friendly design
|
|
|
|
**Shipped version:** 1.18.1~ynh3
|
|
|
|
**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 user documentation: https://yunohost.org/apps
|
|
* 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](https://github.com/YunoHost-Apps/freshrss_ynh/tree/testing).
|
|
|
|
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 |