chore: Auto-update chart README [skip ci]

2022-07-19 11:57:33 +00:00
parent b6e4491cbe
commit 2c197c2324
2 changed files with 56 additions and 11 deletions
@@ -1,6 +1,10 @@
 # Changelog


+## [jackett-11.0.40](https://github.com/truecharts/apps/compare/jackett-11.0.38...jackett-11.0.40) (2022-07-19)
+
+
+
 ## [jackett-11.0.38](https://github.com/truecharts/apps/compare/jackett-11.0.37...jackett-11.0.38) (2022-07-19)


@@ -2,7 +2,11 @@

 API Support for your favorite torrent trackers.

-TrueCharts are designed to be installed as TrueNAS SCALE app only. We can not guarantee this charts works as a standalone helm installation.
+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.
+For more information, please click here: [jackett](https://truecharts.org/charts/stable/jackett)
+
 **This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/truecharts/apps/issues/new/choose)**

 ## Source Code
@@ -21,22 +25,59 @@ Kubernetes: `>=1.16.0-0`

 ## Installing the Chart

+### TrueNAS SCALE
+
 To install this App on TrueNAS SCALE check our [Quick-Start Guide](https://truecharts.org/manual/Quick-Start%20Guides/02-Installing-an-App/).

-## Upgrading, Rolling Back and Uninstalling the Chart
+### Helm
+
+To install the chart with the release name `jackett`
+
+```console
+helm repo add TrueCharts https://helm.truecharts.org
+helm repo update
+helm install jackett TrueCharts/jackett
+```
+
+## Uninstall
+
+### TrueNAS SCALE
+
+**Upgrading, Rolling Back and Uninstalling the Chart**

 To upgrade, rollback or delete this App from TrueNAS SCALE check our [Quick-Start Guide](https://truecharts.org/manual/Quick-Start%20Guides/04-Upgrade-rollback-delete-an-App/).

-##### Connecting to other apps
-If you need to connect this App to other Apps on TrueNAS SCALE, please refer to our [Linking Apps Internally](https://truecharts.org/manual/Quick-Start%20Guides/06-linking-apps/) quick-start guide.
+### Helm

-## Support
+To uninstall the `jackett` deployment

- Please check our [quick-start guides](https://truecharts.org/manual/Quick-Start%20Guides/01-Adding-TrueCharts/) first.
- See the [Wiki](https://truecharts.org)
- Check our [Discord](https://discord.gg/tVsPTHWTtr)
- Open a [issue](https://github.com/truecharts/apps/issues/new/choose)
+```console
+helm uninstall jackett
+```

---
+## Configuration

-All Rights Reserved - The TrueCharts Project
+### 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).
+
+#### Configure using the Commandline
+
+Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.
+
+```console
+helm install jackett \
+  --set env.TZ="America/New York" \
+    TrueCharts/jackett
+```
+
+#### 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 jackett TrueCharts/jackett -f values.yaml
+```