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

59 lines
2.2 KiB
Markdown
Raw Normal View History

2020-08-14 11:34:13 +02:00
# FreshRSS for YunoHost
2014-07-23 18:30:46 +02:00
2020-08-14 11:34:13 +02:00
[![Integration level](https://dash.yunohost.org/integration/freshrss.svg)](https://dash.yunohost.org/appci/app/freshrss) ![](https://ci-apps.yunohost.org/ci/badges/freshrss.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/freshrss.maintain.svg)
2020-08-30 11:00:00 +02:00
[![Install FreshRSS with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=freshrss)
2019-07-27 16:41:51 +02:00
> *This package allow you to install FreshRSS quickly and simply on a YunoHost server.
2019-07-02 00:38:57 +02:00
If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to know how to install and enjoy it.*
2014-07-24 15:36:20 +02:00
2019-07-02 00:38:57 +02:00
## Overview
2018-07-07 16:21:03 +02:00
2019-07-02 00:38:57 +02:00
An efficient but powerful RSS aggregator with a nice and mobile-friendly design, as well as extension and themes support.
2020-10-01 22:19:32 +02:00
**Shipped version:** 1.17.0
2019-07-02 00:38:57 +02:00
## Screenshots
![](https://freshrss.org/images/screenshot.png)
2019-07-02 00:38:57 +02:00
## Demo
* [Official demo](https://demo.freshrss.org)
2019-07-02 00:38:57 +02:00
## Configuration
2020-08-14 11:34:13 +02:00
API (mini) How To:
* Into your user profile: Settings > profil
* Setup an API password
2021-01-25 10:24:18 +01:00
* 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
2019-07-02 00:38:57 +02:00
## Documentation
* Official documentation: https://freshrss.github.io/FreshRSS/
#### Supported architectures
2020-08-14 11:34:13 +02:00
* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/freshrss%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/freshrss/)
2019-07-02 00:38:57 +02:00
* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/freshrss%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/freshrss/)
## 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/
---
2020-08-14 11:34:13 +02:00
## Developers info
2019-07-02 00:38:57 +02:00
Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/freshrss_ynh/tree/testing).
2021-01-25 10:24:18 +01:00
To try the testing branch, please proceed like this:
2019-07-02 00:38:57 +02:00
```
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
2020-08-14 11:34:13 +02:00
```