diff --git a/charts/incubator/magicmirror2/CHANGELOG.md b/charts/incubator/magicmirror2/CHANGELOG.md new file mode 100644 index 00000000000..4736539c179 --- /dev/null +++ b/charts/incubator/magicmirror2/CHANGELOG.md @@ -0,0 +1,6 @@ +# Changelog + + + +## [magicmirror2-0.0.1]magicmirror2-0.0.1 (2022-11-10) + diff --git a/charts/incubator/magicmirror2/Chart.yaml b/charts/incubator/magicmirror2/Chart.yaml index c63f01b1b99..b7682d59223 100644 --- a/charts/incubator/magicmirror2/Chart.yaml +++ b/charts/incubator/magicmirror2/Chart.yaml @@ -1,5 +1,5 @@ apiVersion: v2 -appVersion: "0.20.2218" +appVersion: "latest" dependencies: - name: common repository: https://library-charts.truecharts.org diff --git a/charts/incubator/magicmirror2/README.md b/charts/incubator/magicmirror2/README.md index ed1df73b26e..40954be5f64 100644 --- a/charts/incubator/magicmirror2/README.md +++ b/charts/incubator/magicmirror2/README.md @@ -1 +1,106 @@ -# magicmirror-2 +# magicmirror2 + +Open source modular smart mirror platform. + +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: [magicmirror2](https://truecharts.org/docs/charts/incubator/magicmirror2) + +**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://library-charts.truecharts.org | common | 10.9.1 | + +## 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 `magicmirror2` + +```console +helm repo add TrueCharts https://charts.truecharts.org +helm repo update +helm install magicmirror2 TrueCharts/magicmirror2 +``` + +## 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 `magicmirror2` deployment + +```console +helm uninstall magicmirror2 +``` + +## 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/truecharts/library-charts/tree/main/charts/common). + +#### Configure using the command line + +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + +```console +helm install magicmirror2 \ + --set env.TZ="America/New York" \ + TrueCharts/magicmirror2 +``` + +#### 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 magicmirror2 TrueCharts/magicmirror2 -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