v0.13.9-ha_addon

ha-addon/NETWORKING.en.md

@@ -0,0 +1,32 @@
+# Home Assistant add-on: networking, VLANs, and multiple interfaces
+
+This directory contains the full set of materials related to running GREE Controller as a Home Assistant add-on:
+
+- multi-arch build (`build.sh`)
+- Dockerfile targets for `trixie` and `alpine`
+- add-on repository (`https://git.linuxiarz.pl/gru/gree-controller-ha-addon/`)
+- networking documentation (`https://git.linuxiarz.pl/gru/gree-controller-ha-addon/gree-controller/DOCS.md`, `https://git.linuxiarz.pl/gru/gree-controller-ha-addon/gree-controller/DOCS.pl.md`)
+- topology diagrams (`docs/topology-ha-vlan-gree-en.png`, `docs/topologia-ha-vlan-gree-pl.png`)
+
+## Quick conclusion
+
+For a Home Assistant add-on, the recommended model is:
+
+- `host_network: true`
+- configure VLANs and interfaces on the HA OS host
+- the add-on reuses the host interfaces
+- do not use `macvlan` inside the add-on
+
+## Where the diagrams are
+
+- `docs/topology-ha-vlan-gree-en.png` - English version
+- `docs/topologia-ha-vlan-gree-pl.png` - Polish version
+- `https://git.linuxiarz.pl/gru/gree-controller-ha-addon/gree-controller/topology-ha-vlan-gree-en.png` - repository copy EN
+- `https://git.linuxiarz.pl/gru/gree-controller-ha-addon/gree-controller/topologia-ha-vlan-gree-pl.png` - repository copy PL
+
+## Where the docs are
+
+- `docs/README.en.md`
+- `docs/README.pl.md`
+- `https://git.linuxiarz.pl/gru/gree-controller-ha-addon/gree-controller/DOCS.md`
+- `https://git.linuxiarz.pl/gru/gree-controller-ha-addon/gree-controller/DOCS.pl.md`