diff --git a/charts/incubator/midarr/CHANGELOG.md b/charts/incubator/midarr/CHANGELOG.md new file mode 100644 index 00000000000..e3490c38562 --- /dev/null +++ b/charts/incubator/midarr/CHANGELOG.md @@ -0,0 +1,11 @@ +# Changelog + + + +## [midarr-0.0.1]midarr-0.0.1 (2022-10-01) + +### Feat + +- add midarr ([#3984](https://github.com/truecharts/charts/issues/3984)) + + \ No newline at end of file diff --git a/charts/incubator/midarr/Chart.yaml b/charts/incubator/midarr/Chart.yaml index 224e9f55221..20c9f18f4ee 100644 --- a/charts/incubator/midarr/Chart.yaml +++ b/charts/incubator/midarr/Chart.yaml @@ -1,5 +1,5 @@ apiVersion: v2 -appVersion: "10.6.2" +appVersion: "1.16.0" dependencies: - name: common repository: https://library-charts.truecharts.org @@ -9,8 +9,8 @@ dependencies: repository: https://charts.truecharts.org/ version: 8.0.88 description: Midarr is a minimal lightweight media server for enjoying your media -home: https://truecharts.org/docs/charts/stable/airsonic -icon: https://truecharts.org/img/hotlink-ok/chart-icons/airsonic.png +home: https://truecharts.org/docs/charts/incubator/midarr +icon: https://truecharts.org/img/hotlink-ok/chart-icons/midarr.png keywords: - midarr kubeVersion: ">=1.16.0-0" @@ -20,7 +20,7 @@ maintainers: url: https://truecharts.org name: midarr sources: - - https://github.com/truecharts/charts/tree/master/charts/stable/airsonic + - https://github.com/truecharts/charts/tree/master/charts/incubator/midarr - https://github.com/midarrlabs/midarr-server version: 0.0.1 annotations: diff --git a/charts/incubator/midarr/README.md b/charts/incubator/midarr/README.md index e69de29bb2d..5aacf529f58 100644 --- a/charts/incubator/midarr/README.md +++ b/charts/incubator/midarr/README.md @@ -0,0 +1,107 @@ +# midarr + +Midarr is a minimal lightweight media server for enjoying your media + +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: [midarr](https://truecharts.org/docs/charts/incubator/midarr) + +**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)** + +## Source Code + +* +* + +## Requirements + +Kubernetes: `>=1.16.0-0` + +## Dependencies + +| Repository | Name | Version | +|------------|------|---------| +| https://charts.truecharts.org/ | postgresql | 8.0.88 | +| https://library-charts.truecharts.org | common | 10.6.4 | + +## Installing the Chart + +### TrueNAS SCALE + +To install this Chart on TrueNAS SCALE check our [Quick-Start Guide](https://truecharts.org/docs/manual/SCALE%20Apps/Installing-an-App). + +### Helm + +To install the chart with the release name `midarr` + +```console +helm repo add TrueCharts https://charts.truecharts.org +helm repo update +helm install midarr TrueCharts/midarr +``` + +## Uninstall + +### TrueNAS SCALE + +**Upgrading, Rolling Back and Uninstalling the Chart** + +To upgrade, rollback or delete this Chart from TrueNAS SCALE check our [Quick-Start Guide](https://truecharts.org/docs/manual/SCALE%20Apps/Upgrade-rollback-delete-an-App). + +### Helm + +To uninstall the `midarr` deployment + +```console +helm uninstall midarr +``` + +## Configuration + +### Helm + +#### Available Settings + +Read through the 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 command line + +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + +```console +helm install midarr \ + --set env.TZ="America/New York" \ + TrueCharts/midarr +``` + +#### 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 midarr TrueCharts/midarr -f values.yaml +``` + +#### Connecting to other charts + +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/linking-apps) quick-start guide. + +## Support + +- Please check our [quick-start guides for TrueNAS SCALE](https://truecharts.org/docs/manual/SCALE%20Apps/Important-MUST-READ). +- See the [Website](https://truecharts.org) +- Check our [Discord](https://discord.gg/tVsPTHWTtr) +- Open a [issue](https://github.com/truecharts/apps/issues/new/choose) + +--- + +## Sponsor TrueCharts + +TrueCharts can only exist due to the incredible effort of our staff. +Please consider making a [donation](https://truecharts.org/sponsor) or contributing back to the project any way you can! + +--- + +All Rights Reserved - The TrueCharts Project