YunoHost-Apps/ttrss_ynh
1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/ttrss_ynh.git synced 2024-10-01 13:34:46 +02:00
Code Issues Activity Actions
ttrss_ynh/README.md

63 lines
2.2 KiB
Markdown
Raw Normal View History

Testing (#109)
2022-02-23 14:50:16 +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.
-->
cleaning up
2020-08-14 23:36:09 +02:00
# Tiny Tiny RSS for YunoHost
Create README.md
2013-11-24 11:41:11 +01:00
Update README.md
2020-03-29 13:52:54 +02:00
[![Integration level](https://dash.yunohost.org/integration/ttrss.svg)](https://dash.yunohost.org/appci/app/ttrss) ![](https://ci-apps.yunohost.org/ci/badges/ttrss.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/ttrss.maintain.svg)
Set SVG badge
2020-12-26 23:11:34 +01:00
[![Install Tiny Tiny RSS with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=ttrss)
Normalization from example_ynh
2019-05-01 20:35:48 +02:00
add README_fr
2020-06-10 16:01:00 +02:00
*[Lire ce readme en français.](./README_fr.md)*
Testing (#109)
2022-02-23 14:50:16 +01:00
> *This package allows you to install Tiny Tiny RSS 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.*
Normalization from example_ynh
2019-05-01 20:35:48 +02:00
## Overview
Tiny Tiny RSS is a free and open source web-based news feed (RSS/Atom) reader and aggregator.
Testing (#109)
2022-02-23 14:50:16 +01:00
## Features
Normalization from example_ynh
2019-05-01 20:35:48 +02:00
Testing (#109)
2022-02-23 14:50:16 +01:00
- feed aggregation / syndication,
- OPML import/export,
- multiple ways to share stuff: export RSS feeds, plugins for various social sites, sharing by URL, etc,
- sharing arbitrary content through tt-rss,
- Plugins and themes,
- podcasts,
- flexible article filtering
Normalization from example_ynh
2019-05-01 20:35:48 +02:00
Testing (#123) * Update manifest.json (#96) * Update manifest.json * Update manifest.json * Fix badges * Fix shasum (#99) * Add ynh_add_config (#98) * Add ynh_add_config * Add restictions * Revert "Add restictions" This reverts commit d68f41c03e71d107a0264935eab278ebdf270cde. * Update check_process * [autopatch] Update issue and PR templates (#101) Co-authored-by: Yunohost-Bot <> * Add templates * Fix files permissions * Apply example_ynh (#104) * Increment version * Upgrade config file (#108) Patches that allows to connect to the app without authentication are not working anymore. I see 3 possible solutions: - rework patches to work with upstream changes - use built-in authentication - set authentication to false and protect app access with SSO (as in this PR) * Add readme * Auto-update README * Update change_url * Update install * cleaning up * set cron * Update config.php * Update config.php * Update config.php * Update app.src * Create DISCLAIMER.md * Auto-update README * Update DISCLAIMER.md * Auto-update README * Upgrade to upstream * Auto-update README * Update config.php * Upgrade to upstream * Update manifest.json * Auto-update README * Update change_url * Update change_url * upgrade to upstream * Auto-update README * Api (#111) removing cron job. We already have update_daemon running as a service * Update manifest.json * Auto-update README * Upstream (#114) * upgrade to upstream * Auto-update README Co-authored-by: Yunohost-Bot <> * Fix upstream repo * Update check_process * Auto-update README * Update manifest.json * Upgrade from upstream * Auto-update README * Update manifest.json Co-authored-by: YunoHost Bot <yunohost-bot@users.noreply.github.com> Co-authored-by: tituspijean <tituspijean@outlook.com> Co-authored-by: yalh76 <yalh@yahoo.com> Co-authored-by: Yunohost-Bot <> Co-authored-by: yunohost-bot <yunohost@yunohost.org>
2022-03-26 23:07:47 +01:00
**Shipped version:** 20220326~ynh1
Normalization from example_ynh
2019-05-01 20:35:48 +02:00
Testing (#109)
2022-02-23 14:50:16 +01:00
**Demo:** https://demo.yunohost.org/ttrss/
Normalization from example_ynh
2019-05-01 20:35:48 +02:00
Testing (#109)
2022-02-23 14:50:16 +01:00
## Screenshots
Normalization from example_ynh
2019-05-01 20:35:48 +02:00
Testing (#109)
2022-02-23 14:50:16 +01:00
![](./doc/screenshots/screenshot.png)
Normalization from example_ynh
2019-05-01 20:35:48 +02:00
Testing (#109)
2022-02-23 14:50:16 +01:00
## Disclaimers / important information
Normalization from example_ynh
2019-05-01 20:35:48 +02:00
Testing (#109)
2022-02-23 14:50:16 +01:00
### Default login credentials
Normalization from example_ynh
2019-05-01 20:35:48 +02:00
Testing (#109)
2022-02-23 14:50:16 +01:00
- Username: `admin`
- password: `password`
## Documentation and resources
Normalization from example_ynh
2019-05-01 20:35:48 +02:00
Testing (#109)
2022-02-23 14:50:16 +01:00
* Official app website: http://tt-rss.org
* Official admin documentation: https://git.tt-rss.org/git/tt-rss/wiki
* Upstream app code repository: https://git.tt-rss.org/git/tt-rss
* YunoHost documentation for this app: https://yunohost.org/app_ttrss
* Report a bug: https://github.com/YunoHost-Apps/ttrss_ynh/issues
Normalization from example_ynh
2019-05-01 20:35:48 +02:00
Testing (#109)
2022-02-23 14:50:16 +01:00
## Developer info
Normalization from example_ynh
2019-05-01 20:35:48 +02:00
Testing (#109)
2022-02-23 14:50:16 +01:00
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/ttrss_ynh/tree/testing).
Normalization from example_ynh
2019-05-01 20:35:48 +02:00
To try the testing branch, please proceed like that.
```
sudo yunohost app install https://github.com/YunoHost-Apps/ttrss_ynh/tree/testing --debug
or
sudo yunohost app upgrade ttrss -u https://github.com/YunoHost-Apps/ttrss_ynh/tree/testing --debug
```
Testing (#109)
2022-02-23 14:50:16 +01:00
**More info regarding app packaging:** https://yunohost.org/packaging_apps
Reference in a new issue Copy permalink