TrueChartsClone/charts/stable/leaf2mqtt/README.md

110 lines
3.5 KiB
Markdown
Raw Normal View History

# leaf2mqtt
![Version: 4.0.26](https://img.shields.io/badge/Version-4.0.26-informational?style=flat-square) ![AppVersion: 0.6](https://img.shields.io/badge/AppVersion-0.6-informational?style=flat-square)
feat(apps): fill incubator with a bunch of new apps (#1083) * (feat) fill incubator with a bunch of new apps * Ornias' cleanup * stavros' cleanup * Ornias' second cleanup * Add basic SCALE Compatibility layer and docs * Ornias's cleanup 3 * Stavros' cleanup 2 Update service's port on the skipped apps (+32 squashed commit) Squashed commit: [361963ced] config -> data on some apps [545c32b55] wiki [41fb4f518] twtxt [02169bad9] static [a9042669c] sqlitebrowser [f09ce3d76] smokeping [01d2f9af6] sickgear [680fd358f] sickchill [71856480f] shorturl [ce130ac8a] Remmina [6410ec2ae] pixapop [a1ea2a33f] Piwigo [0b4c52d43] photoshow [25e9a44fd] novnc [84954deae] notes [b3be0b28d] muximux [43d2b37a5] mstream [736f9877f] Medusa [8ef3434d6] Headphones [05e52284f] Grav [7ce6f1723] golinks [b4eee91e6] fossil [d19b44434] FIlezilla [926236447] Doublecommander [6f68e5253] Digikam [f14d3af21] Davos [8108c01ea] Code-server [496991750] Cloud9 [4ad02a99f] Beets [f2f0565b9] Apache-musicindex [9bf8de8c4] aria2 [283edf7b0] Audacity * Ornias' cleanup 4 try something for amcrest and zigbee (+8 squashed commit) Squashed commit: [a199779a9] First part of leaf2mqtt [0eb7fea43] cryptfolio [81c2b9b8b] amcrest readonly default true [fc62aebb4] setup amcrest2mqtt [d97f7d1fe] remove empty secret references [ec0e6b1b3] remove sogo for now (till we have a decent mail server and such) [9be04c1e7] Adapt to recent serviceExpert changes (includes) (cherry picked from commit 98acc5f93f9f1aa5129942af7f196a04ed6a8c1e) [8362ebc89] Adapt to recent ingress changes in questions.yaml (includes) (cherry picked from commit d307ba98a74d470c45c8fdff51423930826015a9) * Stavros' cleanup 3 leaf2mqtt actually needs root when the core fuctionality env's are populated (+6 squashed commit) Squashed commit: [4ef306f0c] minio-console [6ad206b48] finish whoogle and move fixed envs on top [aaf48575c] finish 4 apps [97ad3fd4d] don't leave sercrets empty [e27b98841] sync more env's and sercrets [398929040] sync secrets * Initial work on valheim (WIP) * fix some linting issues * Use the configuration only as a default and let users expand it using env vars * indent issue on valheim * add second ingress to valheim * remove some old valheim comments * valheim fix port ints Co-authored-by: Stavros Kois <47820033+stavros-k@users.noreply.github.com> Co-authored-by: Stavros kois <s.kois@outlook.com>
2021-10-13 20:46:42 +00:00
Nissan Leaf connected services to MQTT adapter
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: [leaf2mqtt](https://truecharts.org/docs/charts/stable/leaf2mqtt)
**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
* <https://github.com/truecharts/charts/tree/master/charts/stable/leaf2mqtt>
feat(apps): fill incubator with a bunch of new apps (#1083) * (feat) fill incubator with a bunch of new apps * Ornias' cleanup * stavros' cleanup * Ornias' second cleanup * Add basic SCALE Compatibility layer and docs * Ornias's cleanup 3 * Stavros' cleanup 2 Update service's port on the skipped apps (+32 squashed commit) Squashed commit: [361963ced] config -> data on some apps [545c32b55] wiki [41fb4f518] twtxt [02169bad9] static [a9042669c] sqlitebrowser [f09ce3d76] smokeping [01d2f9af6] sickgear [680fd358f] sickchill [71856480f] shorturl [ce130ac8a] Remmina [6410ec2ae] pixapop [a1ea2a33f] Piwigo [0b4c52d43] photoshow [25e9a44fd] novnc [84954deae] notes [b3be0b28d] muximux [43d2b37a5] mstream [736f9877f] Medusa [8ef3434d6] Headphones [05e52284f] Grav [7ce6f1723] golinks [b4eee91e6] fossil [d19b44434] FIlezilla [926236447] Doublecommander [6f68e5253] Digikam [f14d3af21] Davos [8108c01ea] Code-server [496991750] Cloud9 [4ad02a99f] Beets [f2f0565b9] Apache-musicindex [9bf8de8c4] aria2 [283edf7b0] Audacity * Ornias' cleanup 4 try something for amcrest and zigbee (+8 squashed commit) Squashed commit: [a199779a9] First part of leaf2mqtt [0eb7fea43] cryptfolio [81c2b9b8b] amcrest readonly default true [fc62aebb4] setup amcrest2mqtt [d97f7d1fe] remove empty secret references [ec0e6b1b3] remove sogo for now (till we have a decent mail server and such) [9be04c1e7] Adapt to recent serviceExpert changes (includes) (cherry picked from commit 98acc5f93f9f1aa5129942af7f196a04ed6a8c1e) [8362ebc89] Adapt to recent ingress changes in questions.yaml (includes) (cherry picked from commit d307ba98a74d470c45c8fdff51423930826015a9) * Stavros' cleanup 3 leaf2mqtt actually needs root when the core fuctionality env's are populated (+6 squashed commit) Squashed commit: [4ef306f0c] minio-console [6ad206b48] finish whoogle and move fixed envs on top [aaf48575c] finish 4 apps [97ad3fd4d] don't leave sercrets empty [e27b98841] sync more env's and sercrets [398929040] sync secrets * Initial work on valheim (WIP) * fix some linting issues * Use the configuration only as a default and let users expand it using env vars * indent issue on valheim * add second ingress to valheim * remove some old valheim comments * valheim fix port ints Co-authored-by: Stavros Kois <47820033+stavros-k@users.noreply.github.com> Co-authored-by: Stavros kois <s.kois@outlook.com>
2021-10-13 20:46:42 +00:00
* <https://github.com/mitsumaui/leaf2mqtt>
* <https://github.com/k8s-at-home/container-images>
## Requirements
Kubernetes: `>=1.16.0-0`
## Dependencies
| Repository | Name | Version |
|------------|------|---------|
| https://library-charts.truecharts.org | common | 10.4.12 |
## Installing the Chart
### TrueNAS SCALE
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).
### Helm
To install the chart with the release name `leaf2mqtt`
```console
helm repo add TrueCharts https://charts.truecharts.org
helm repo update
helm install leaf2mqtt TrueCharts/leaf2mqtt
```
## 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/Quick-Start%20Guides/Upgrade-rollback-delete-an-App).
### Helm
To uninstall the `leaf2mqtt` deployment
```console
helm uninstall leaf2mqtt
```
## 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).
#### Configure using the command line
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.
```console
helm install leaf2mqtt \
--set env.TZ="America/New York" \
TrueCharts/leaf2mqtt
```
#### 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 leaf2mqtt TrueCharts/leaf2mqtt -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/Quick-Start%20Guides/linking-apps) quick-start guide.
## Support
- 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)
- 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/docs/about/sponsor) or contributing back to the project any way you can!
---
All Rights Reserved - The TrueCharts Project