1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/selfoss_ynh.git synced 2024-09-03 20:16:21 +02:00
selfoss_ynh/README.md

49 lines
2 KiB
Markdown
Raw Normal View History

2022-01-10 13:37:52 +01:00
<!--
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.
-->
2022-01-10 13:37:59 +01:00
# Selfoss for YunoHost
2022-01-10 13:37:52 +01:00
2023-03-10 12:46:30 +01:00
[![Integration level](https://dash.yunohost.org/integration/selfoss.svg)](https://dash.yunohost.org/appci/app/selfoss) ![Working status](https://ci-apps.yunohost.org/ci/badges/selfoss.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/selfoss.maintain.svg)
2022-01-10 13:37:59 +01:00
[![Install Selfoss with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=selfoss)
2022-01-10 13:37:52 +01:00
*[Lire ce readme en français.](./README_fr.md)*
2022-01-10 13:37:59 +01:00
> *This package allows you to install Selfoss quickly and simply on a YunoHost server.
2022-01-10 13:37:52 +01:00
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
## Overview
2022-01-10 13:37:59 +01:00
Selfoss is a multipurpose RSS reader and feed aggregation web application. It allows you to easily follow updates from different web sites, social networks and other platforms, all in single place. It is written in PHP, allowing you to run it basically anywhere.
2022-01-10 13:37:52 +01:00
2023-09-09 08:27:05 +02:00
**Shipped version:** 2.19~ynh2
2022-01-10 13:37:52 +01:00
## Screenshots
2022-08-15 18:29:21 +02:00
![Screenshot of Selfoss](./doc/screenshots/screenshot1.png)
2022-01-10 13:37:52 +01:00
## Documentation and resources
2022-08-15 18:29:21 +02:00
* Official app website: <https://selfoss.aditu.de/>
* Official user documentation: <https://selfoss.aditu.de/>
* Official admin documentation: <https://github.com/fossar/selfoss/wiki>
* Upstream app code repository: <https://github.com/fossar/selfoss>
* Report a bug: <https://github.com/YunoHost-Apps/selfoss_ynh/issues>
2022-01-10 13:37:52 +01:00
## Developer info
2022-01-10 13:37:59 +01:00
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/selfoss_ynh/tree/testing).
2022-01-10 13:37:52 +01:00
To try the testing branch, please proceed like that.
2022-08-15 18:29:21 +02:00
``` bash
2022-01-10 13:37:59 +01:00
sudo yunohost app install https://github.com/YunoHost-Apps/selfoss_ynh/tree/testing --debug
2022-01-10 13:37:52 +01:00
or
2022-01-10 13:37:59 +01:00
sudo yunohost app upgrade selfoss -u https://github.com/YunoHost-Apps/selfoss_ynh/tree/testing --debug
2022-01-10 13:37:52 +01:00
```
2022-08-15 18:29:21 +02:00
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>