freshrss_ynh/README.md

<!--
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

[![Integration level](https://dash.yunohost.org/integration/freshrss.svg)](https://ci-apps.yunohost.org/ci/apps/freshrss/) ![Working status](https://ci-apps.yunohost.org/ci/badges/freshrss.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/freshrss.maintain.svg)

[![Install FreshRSS with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=freshrss)

*[Read this README in other languages.](./ALL_README.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

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


**Shipped version:** 1.24.1~ynh1

**Demo:** <https://demo.freshrss.org>

## Screenshots

![Screenshot of FreshRSS](./doc/screenshots/screenshot.png)

## 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 Store: <https://apps.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:

```bash
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>
Fix linter warnings (#120) - Upgrade to 1.18.1 2021-06-28 22:23:04 +02:00			`<!--`
Auto-update README 2024-03-29 07:03:40 +01:00			`N.B.: This README was automatically generated by <https://github.com/YunoHost/apps/tree/master/tools/readme_generator>`
Fix linter warnings (#120) - Upgrade to 1.18.1 2021-06-28 22:23:04 +02:00			`It shall NOT be edited by hand.`
			`-->`

Update README.md -Add badges 2020-08-14 11:34:13 +02:00			`# FreshRSS for YunoHost`
ajout du readme 2014-07-23 18:30:46 +02:00
Testing (#187) * Update install: stupid typo in fail2ban conf ... * Update upgrade: stupid typo in fail2ban conf * Update remove * Auto-update READMEs --------- Co-authored-by: Éric Gaspar <46165813+ericgaspar@users.noreply.github.com> Co-authored-by: yunohost-bot <yunohost@yunohost.org> 2024-07-26 21:07:25 +02:00			`[![Integration level](https://dash.yunohost.org/integration/freshrss.svg)](https://ci-apps.yunohost.org/ci/apps/freshrss/) ![Working status](https://ci-apps.yunohost.org/ci/badges/freshrss.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/freshrss.maintain.svg)`
Auto-update README 2023-02-23 23:06:05 +01:00
Set badge to SVG (#110) 2021-01-25 10:33:37 +01:00			`[![Install FreshRSS with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=freshrss)`
Add "install with yunohost" button + short FreshRSS description 2017-07-09 17:53:34 +02:00
Testing 1.23.1~ynh2 (#180) * change autoupdate.strategy from "latest_github_tag" to "latest_github_release" * [autopatch] TEST BEFORE MERGE ynh_setup_source --full_replace=1 * bump minimal required ynh version * bump package version * backup & restore logs (#179) * cleaning * Auto-update READMEs --------- Co-authored-by: Yunohost-Bot <> Co-authored-by: Éric Gaspar <46165813+ericgaspar@users.noreply.github.com> Co-authored-by: yunohost-bot <yunohost@yunohost.org> 2024-05-12 22:39:06 +02:00			`[Read this README in other languages.](./ALL_README.md)`
Fix linter warnings (#120) - Upgrade to 1.18.1 2021-06-28 22:23:04 +02:00
Auto-update README 2024-03-29 07:03:40 +01:00			`> 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.`
Ajout TODO 2014-07-24 15:36:20 +02:00
Apply example_ynh 2019-07-02 00:38:57 +02:00			`## Overview`
update readme 2018-07-07 16:21:03 +02:00
Auto-update README 2022-10-02 23:03:51 +02:00			`An efficient but powerful RSS aggregator with a nice and mobile-friendly design, as well as extension and themes support.`
Apply example_ynh 2019-07-02 00:38:57 +02:00
Auto-update README 2022-10-02 23:03:51 +02:00
Testing (#185) * change autoupdate.strategy from "latest_github_tag" to "latest_github_release" * [autopatch] TEST BEFORE MERGE ynh_setup_source --full_replace=1 * bump minimal required ynh version * bump package version * backup & restore logs (#179) * cleaning * Auto-update READMEs * Upgrade to v1.24.0 (#181) * Upgrade to v1.24.0 https://github.com/FreshRSS/FreshRSS/releases/tag/1.24.0 * Auto-update READMEs * Update upgrade (#184) * Update manifest.toml * Auto-update READMEs --------- Co-authored-by: OniriCorpe <oniricorpe@disroot.org> Co-authored-by: Yunohost-Bot <> Co-authored-by: OniriCorpe <oniricorpe@yunohost.org> Co-authored-by: yunohost-bot <yunohost@yunohost.org> Co-authored-by: YunoHost Bot <yunohost-bot@users.noreply.github.com> 2024-06-09 22:14:14 +02:00			`Shipped version: 1.24.1~ynh1`
Auto-update README 2022-10-02 22:24:51 +02:00
Auto-update README 2024-03-29 07:03:40 +01:00			`Demo: <https://demo.freshrss.org>`
Add "install with yunohost" button + short FreshRSS description 2017-07-09 17:53:34 +02:00
Fix linter warnings (#120) - Upgrade to 1.18.1 2021-06-28 22:23:04 +02:00			`## Screenshots`
Readme: Add a screenshoot It's always nice to get an overview of the look of the software before installing :) 2018-07-08 11:56:31 +02:00
Auto-update README 2022-10-02 22:24:51 +02:00			`![Screenshot of FreshRSS](./doc/screenshots/screenshot.png)`
Apply example_ynh 2019-07-02 00:38:57 +02:00
Fix linter warnings (#120) - Upgrade to 1.18.1 2021-06-28 22:23:04 +02:00			`## Documentation and resources`
Apply example_ynh 2019-07-02 00:38:57 +02:00
Auto-update README 2024-03-29 07:03:40 +01:00			`- Official app website: <http://freshrss.org/>`
			`- Official admin documentation: <https://freshrss.github.io/FreshRSS/>`
			`- Upstream app code repository: <https://github.com/FreshRSS/FreshRSS>`
			`- YunoHost Store: <https://apps.yunohost.org/app/freshrss>`
			`- Report a bug: <https://github.com/YunoHost-Apps/freshrss_ynh/issues>`
Apply example_ynh 2019-07-02 00:38:57 +02:00
Fix linter warnings (#120) - Upgrade to 1.18.1 2021-06-28 22:23:04 +02:00			`## Developer info`
Apply example_ynh 2019-07-02 00:38:57 +02:00
Auto-update README 2024-03-29 07:03:40 +01:00			Please send your pull request to the [`testing` branch](https://github.com/YunoHost-Apps/freshrss_ynh/tree/testing).
Apply example_ynh 2019-07-02 00:38:57 +02:00
Auto-update README 2024-03-29 07:03:40 +01:00			To try the `testing` branch, please proceed like that:
Auto-update README 2022-10-02 22:24:51 +02:00
Auto-update README 2024-03-29 07:03:40 +01:00			```bash
Apply example_ynh 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`
Update README.md -Add badges 2020-08-14 11:34:13 +02:00			```
Fix linter warnings (#120) - Upgrade to 1.18.1 2021-06-28 22:23:04 +02:00
Auto-update README 2022-10-02 22:24:51 +02:00			`More info regarding app packaging: <https://yunohost.org/packaging_apps>`