chore: Auto-update chart README [skip ci]
This commit is contained in:
@@ -1,16 +1,15 @@
|
||||
# mosquitto
|
||||
|
||||
  
|
||||
  
|
||||
|
||||
Eclipse Mosquitto - An open source MQTT broker
|
||||
|
||||
**Homepage:** <https://github.com/truecharts/apps/tree/master/charts/stable/mosquitto>
|
||||
TrueCharts can be installed as both *normal* Helm Charts or as Apps on TrueNAS SCALE.
|
||||
|
||||
## Maintainers
|
||||
This readme is just an automatically generated general guide on installing our Helm Charts and Apps.
|
||||
For more information, please click here: [mosquitto](https://truecharts.org/charts/stable/mosquitto)
|
||||
|
||||
| Name | Email | Url |
|
||||
| ---- | ------ | --- |
|
||||
| TrueCharts | info@truecharts.org | https://truecharts.org |
|
||||
**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
|
||||
|
||||
@@ -20,31 +19,89 @@ Eclipse Mosquitto - An open source MQTT broker
|
||||
|
||||
Kubernetes: `>=1.16.0-0`
|
||||
|
||||
## Dependencies
|
||||
|
||||
| Repository | Name | Version |
|
||||
|------------|------|---------|
|
||||
| https://library-charts.truecharts.org | common | 10.4.4 |
|
||||
|
||||
## Values
|
||||
## Installing the Chart
|
||||
|
||||
| Key | Type | Default | Description |
|
||||
|-----|------|---------|-------------|
|
||||
| auth.enabled | bool | `false` | By enabling this, `allow_anonymous` gets set to `false` in the mosquitto config. |
|
||||
| configmap.config.data."mosquitto.conf" | string | `"listener {{ .Values.service.main.ports.main.port }}\n{{- if .Values.auth.enabled }}\nallow_anonymous false\npassword_file /mosquitto/data/passwords.txt\n{{- else }}\nallow_anonymous true\n{{- end }}\n{{- if .Values.persistence.data.enabled }}\npersistence true\npersistence_location {{ .Values.persistence.data.mountPath }}\nautosave_interval 1800\n{{- end }}\n{{- if .Values.persistence.configinc.enabled }}\ninclude_dir {{ .Values.persistence.configinc.mountPath }}\n{{- end }}\n"` | |
|
||||
| configmap.config.enabled | bool | `true` | |
|
||||
| image.pullPolicy | string | `"IfNotPresent"` | |
|
||||
| image.repository | string | `"tccr.io/truecharts/eclipse-mosquitto"` | |
|
||||
| image.tag | string | `"v2.0.14@sha256:3a706bd94ae6f98a9eacf56c4ba43f3895e567f23eb0c9bdd74a0d912052c883"` | |
|
||||
| persistence.configinc.enabled | bool | `true` | |
|
||||
| persistence.configinc.mountPath | string | `"/mosquitto/configinc"` | |
|
||||
| persistence.data.enabled | bool | `true` | |
|
||||
| persistence.data.mountPath | string | `"/mosquitto/data"` | |
|
||||
| persistence.mosquitto-config.enabled | string | `"true"` | |
|
||||
| persistence.mosquitto-config.mountPath | string | `"/mosquitto/config/mosquitto.conf"` | |
|
||||
| persistence.mosquitto-config.subPath | string | `"mosquitto.conf"` | |
|
||||
| persistence.mosquitto-config.type | string | `"custom"` | |
|
||||
| persistence.mosquitto-config.volumeSpec.configMap.name | string | `"{{ template \"tc.common.names.fullname\" . }}-config"` | |
|
||||
| service.main.ports.main.port | int | `1883` | |
|
||||
| service.main.ports.main.targetPort | int | `1883` | |
|
||||
### TrueNAS SCALE
|
||||
|
||||
----------------------------------------------
|
||||
Autogenerated from chart metadata using [helm-docs v0.1.1](https://github.com/k8s-at-home/helm-docs/releases/v0.1.1)
|
||||
To install this App on TrueNAS SCALE check our [Quick-Start Guide](https://truecharts.org/manual/Quick-Start%20Guides/02-Installing-an-App/).
|
||||
|
||||
### Helm
|
||||
|
||||
To install the chart with the release name `mosquitto`
|
||||
|
||||
```console
|
||||
helm repo add TrueCharts https://helm.truecharts.org
|
||||
helm repo update
|
||||
helm install mosquitto TrueCharts/mosquitto
|
||||
```
|
||||
|
||||
## 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/).
|
||||
|
||||
### Helm
|
||||
|
||||
To uninstall the `mosquitto` deployment
|
||||
|
||||
```console
|
||||
helm uninstall mosquitto
|
||||
```
|
||||
|
||||
## 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 Commandline
|
||||
|
||||
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.
|
||||
|
||||
```console
|
||||
helm install mosquitto \
|
||||
--set env.TZ="America/New York" \
|
||||
TrueCharts/mosquitto
|
||||
```
|
||||
|
||||
#### 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 mosquitto TrueCharts/mosquitto -f values.yaml
|
||||
```
|
||||
|
||||
#### 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.
|
||||
|
||||
## 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
|
||||
|
||||
Reference in New Issue
Block a user