docs(zigbee2mqtt): helmify docs (#32979)

**Description**
<!--
helmify docs
-->
⚒️ Fixes  # <!--(issue)-->

**⚙️ Type of change**

- [ ] ⚙️ Feature/App addition
- [ ] 🪛 Bugfix
- [ ] ⚠️ Breaking change (fix or feature that would cause existing
functionality to not work as expected)
- [ ] 🔃 Refactor of current code
- [x] 📜 Documentation Changes

**🧪 How Has This Been Tested?**
<!--
Please describe the tests that you ran to verify your changes. Provide
instructions so we can reproduce. Please also list any relevant details
for your test configuration
-->

**📃 Notes:**
<!-- Please enter any other relevant information here -->

**✔️ Checklist:**

- [ ] ⚖️ My code follows the style guidelines of this project
- [ ] 👀 I have performed a self-review of my own code
- [ ] #️⃣ I have commented my code, particularly in hard-to-understand
areas
- [x] 📄 I have made changes to the documentation
- [ ] 🧪 I have added tests to this description that prove my fix is
effective or that my feature works
- [ ] ⬆️ I increased versions for any altered app according to semantic
versioning
- [x] I made sure the title starts with `feat(chart-name):`,
`fix(chart-name):`, `chore(chart-name):`, `docs(chart-name):` or
`fix(docs):`

** App addition**

If this PR is an app addition please make sure you have done the
following.

- [ ] 🖼️ I have added an icon in the Chart's root directory called
`icon.png`

---

_Please don't blindly check all the boxes. Read them and only check
those that apply.
Those checkboxes are there for the reviewer to see what is this all
about and
the status of this PR with a quick glance._
This commit is contained in:
Boemeltrein
2025-03-07 15:30:35 +01:00
committed by GitHub
parent 1d91054461
commit a42a1378c4
9 changed files with 31 additions and 15 deletions

Binary file not shown.

Before

Width:  |  Height:  |  Size: 64 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 61 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 60 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 57 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 57 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 41 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 225 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 78 KiB

View File

@@ -2,29 +2,45 @@
title: Installation Guide
---
## TrueNAS SCALE Installation Hints
## How-To
Here's an example of a default installation of zigbee2mqtt. Pay particular attention to the section "Configure Mount USB Devices" to configure the USB adapter to your container as those two paths should match.
### Application Configuration
### Deployment Configuration
Enter `MQTT User`, `MQTT Password` if necessary, as this will override the specific value of config file. Leave empty if you plan to use custom config or you don't have set a user on your MQTT broker.
Set `ZIGBEE2MQTT_CONFIG_MQTT_USER`, `ZIGBEE2MQTT_CONFIG_MQTT_PASSWORD` if necessary, as this will override the specific value of config file. Leave empty if you plan to use custom config or you don't have set a user on your MQTT broker.
For `MQTT Server` Internal DNS Cluster IP can be used (default) of `mqtt://mosquitto.ix-mosquitto.svc.cluster.local` or you can use the external IP.
For `MQTT Server` Internal DNS Cluster IP can be used (default) of `mqtt://mosquitto.mosquitto.svc.cluster.local` or you can use the external IP.
![config1](./images/config1.png)
![config1](./images/config1.png)
![config2](./images/config2.png)
![config3](./images/config3.png)
![config4](./images/config4.png)
![config5](./images/config5.png)
```yaml
workload:
main:
podSpec:
containers:
main:
env:
USE_CUSTOM_CONFIG_FILE: false
# This values are required for the autogenerated file to work.
# ZIGBEE2MQTT_CONFIG_PERMIT_JOIN: false
ZIGBEE2MQTT_CONFIG_MQTT_SERVER: "mqtt://mosquitto.mosquitto.svc.cluster.local"
ZIGBEE2MQTT_CONFIG_MQTT_BASE_TOPIC: "zigbee2mqtt"
ZIGBEE2MQTT_CONFIG_SERIAL_PORT: "/dev/ttyUSB0"
ZIGBEE2MQTT_CONFIG_SERIAL_ADAPTER: "auto"
ZIGBEE2MQTT_CONFIG_MQTT_USER: "mqtt_user"
ZIGBEE2MQTT_CONFIG_MQTT_PASSWORD: "secretpassword"
```
### Mount USB Devices
Make sure `Enable the Storage is Checked` and enter your USB device by ID as per below, in this example we use `/dev/serial/by-id/usb-ithead_SONOFF`
- Passthrough your USB device to your cluster node.
- Add a persistence configuration for your USB device
- Best practice is to do by ID as per below, in this example we use `/dev/serial/by-id/usb-ithead_SONOFF`
![config6](./images/config6.png)
```yaml
persistence:
zigbee:
enabled: true
type: device
hostPath: /dev/serial/by-id/usb-ithead_SONOFF
```
This guide should prevent one of the following error messages:
![error message 1](./images/error_log1.png)
![error message 2](./images/error_log2.png)