Files
zigbee-stack/README.md
John Lancaster 76efdb0274 readme update
2024-05-19 20:37:19 -05:00

53 lines
1.3 KiB
Markdown

# zigbee-stack
Zigbee smarthome stack
| Service | Name | Image |
|---------|-------------|----------------------|
| mqtt | mosquitto | [eclipse-mosquitto] |
| z2m | zigbee2mqtt | [koenkk/zigbee2mqtt] |
[eclipse-mosquitto]: https://hub.docker.com/_/eclipse-mosquitto
[koenkk/zigbee2mqtt]: https://hub.docker.com/r/koenkk/zigbee2mqtt
## Setup
### 1. Create LXC in Proxmox
```title="Proxmox helper script"
bash -c "$(wget -qLO - https://github.com/tteck/Proxmox/raw/main/ct/docker.sh)"
```
### 2. Clone repo
```bash
git clone https://gitea.john-stream.com/john/zigbee-stack
```
### 3. Setup script
```bash
./zigbee-stack/scripts/setup.sh
```
Process:
- clears all the existing data, except certain files
- asks for a new MQTT password, which gets saved in `./zigbee2mqtt/secret.yaml`
- runs `docker compose up ...`
### 4. Mount backup
Mount from within Proxmox using the `pct` tool.
```bash
pct set $VMID -mp0 $BACKUP_DIR,mp=/mnt/backups
```
### 5. Set env variables
| Environment variable | Description |
|----------------------|---------------------------------------------------|
| RESTIC_REPOSITORY | Path the the mounted restic repo (`/mnt/backups`) |
| RESTIC_PASSWORD | Password to the restic repo |