2022-07-12 14:58:45 -04:00
# awesome-ttrss
2022-06-15 06:18:41 -04:00
2022-08-17 14:50:50 -04:00
![Version: 0.0.33 ](https://img.shields.io/badge/Version-0.0.33-informational?style=flat-square ) ![AppVersion: 2022 ](https://img.shields.io/badge/AppVersion-2022-informational?style=flat-square )
2022-07-19 09:18:28 -04:00
2022-06-15 06:18:41 -04:00
Awesome TTRSS aims to provide a powerful Dockerized all-in-one solution for Tiny Tiny RSS
2022-07-19 09:18:28 -04:00
TrueCharts can be installed as both *normal* Helm Charts or as Apps on TrueNAS SCALE.
This readme is just an automatically generated general guide on installing our Helm Charts and Apps.
2022-07-22 20:22:10 -04:00
For more information, please click here: [awesome-ttrss ](https://truecharts.org/docs/charts/stable/awesome-ttrss )
2022-07-19 09:18:28 -04:00
2022-07-22 20:22:10 -04:00
**This chart is not maintained by the upstream project and any issues with the chart should be raised [here ](https://github.com/truecharts/charts/issues/new/choose )**
2022-06-15 06:18:41 -04:00
## Source Code
2022-08-08 19:15:26 -04:00
* < https: // github . com / truecharts / charts / tree / master / charts / incubator / awesome-ttrss >
2022-06-15 06:18:41 -04:00
* < https: // github . com / HenryQW / Awesome-TTRSS >
## Requirements
Kubernetes: `>=1.16.0-0`
## Dependencies
| Repository | Name | Version |
|------------|------|---------|
2022-08-17 14:50:50 -04:00
| https://charts.truecharts.org/ | postgresql | 8.0.56 |
2022-08-12 18:39:47 -04:00
| https://library-charts.truecharts.org | common | 10.4.12 |
2022-06-15 06:18:41 -04:00
## Installing the Chart
2022-07-19 09:18:28 -04:00
### TrueNAS SCALE
2022-08-08 19:15:26 -04:00
To install this Chart on TrueNAS SCALE check our [Quick-Start Guide ](https://truecharts.org/docs/manual/SCALE%20Apps/Quick-Start%20Guides/Installing-an-App ).
2022-06-15 06:18:41 -04:00
2022-07-19 09:18:28 -04:00
### Helm
To install the chart with the release name `awesome-ttrss`
```console
2022-08-08 19:15:26 -04:00
helm repo add TrueCharts https://charts.truecharts.org
2022-07-19 09:18:28 -04:00
helm repo update
helm install awesome-ttrss TrueCharts/awesome-ttrss
```
## Uninstall
### TrueNAS SCALE
**Upgrading, Rolling Back and Uninstalling the Chart**
2022-06-15 06:18:41 -04:00
2022-08-08 19:15:26 -04:00
To upgrade, rollback or delete this Chart from TrueNAS SCALE check our [Quick-Start Guide ](https://truecharts.org/docs/manual/SCALE%20Apps/Quick-Start%20Guides/Upgrade-rollback-delete-an-App ).
2022-06-15 06:18:41 -04:00
2022-07-19 09:18:28 -04:00
### Helm
To uninstall the `awesome-ttrss` deployment
```console
helm uninstall awesome-ttrss
```
## Configuration
### Helm
#### Available Settings
Read through the [values.yaml ](./values.yaml ) file. It has several commented out suggested values.
Other values may be used from the [values.yaml ](https://github.com/truecharts/library-charts/tree/main/charts/stable/common/values.yaml ) from the [common library ](https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common ).
2022-08-08 19:15:26 -04:00
#### Configure using the command line
2022-07-19 09:18:28 -04:00
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install` .
```console
helm install awesome-ttrss \
--set env.TZ="America/New York" \
TrueCharts/awesome-ttrss
```
#### Configure using a yaml file
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
```console
helm install awesome-ttrss TrueCharts/awesome-ttrss -f values.yaml
```
2022-08-08 19:15:26 -04:00
#### Connecting to other charts
2022-07-19 09:18:28 -04:00
2022-08-08 19:15:26 -04:00
If you need to connect this Chart to other Charts on TrueNAS SCALE, please refer to our [Linking Charts Internally ](https://truecharts.org/docs/manual/SCALE%20Apps/Quick-Start%20Guides/linking-apps ) quick-start guide.
2022-07-12 14:58:45 -04:00
2022-06-15 06:18:41 -04:00
## Support
2022-07-19 09:18:28 -04:00
- Please check our [quick-start guides for TrueNAS SCALE ](https://truecharts.org/docs/manual/SCALE%20Apps/Quick-Start%20Guides/Important-MUST-READ ).
- See the [Website ](https://truecharts.org )
2022-06-15 06:18:41 -04:00
- Check our [Discord ](https://discord.gg/tVsPTHWTtr )
- Open a [issue ](https://github.com/truecharts/apps/issues/new/choose )
2022-07-12 17:13:53 -04:00
2022-06-15 06:18:41 -04:00
---
2022-07-12 17:13:53 -04:00
2022-07-19 09:18:28 -04:00
## Sponsor TrueCharts
TrueCharts can only exist due to the incredible effort of our staff.
Please consider making a [donation ](https://truecharts.org/docs/about/sponsor ) or contributing back to the project any way you can!
---
2022-06-15 06:18:41 -04:00
All Rights Reserved - The TrueCharts Project