diff --git a/README.md b/README.md index 361f65b..ab9ba23 100644 --- a/README.md +++ b/README.md @@ -8,15 +8,15 @@ Effortlessly connect your IoT infrastructure to Apple Home ✨ ## Description This collection is a set of Ansible roles, aiming to simplify the deployment and configuration -of HomeAssistant, -Zigbee2MQTT -and Mosquitto, +of HomeAssistant, +Zigbee2MQTT +and Mosquitto, making them ready to connect to Apple Home. ## Requirements -- A ZigBee Adapter. -- Docker. Please refer to ansible-role-docker to install it with Ansible. +- A ZigBee Adapter. +- Docker. Please refer to ansible-role-docker to install it with Ansible. ## Installation @@ -30,11 +30,11 @@ ansible-galaxy collection install artyorsh.smarthome -1. Find the ZigBee adapter +1. Find the ZigBee adapter 2. [Run the playbook](#example-playbook) -3. Enable the HomeKit integration in AppleHome (starting from step 1) +3. Enable the HomeKit integration in AppleHome (starting from step 1) -For a real-world usage example, see my infra playbooks. +For a real-world usage example, see my infra playbooks. ## Example Playbook @@ -60,9 +60,9 @@ By default, HomeAssistant and Zigbee2MQTT containers are deployed on ports 8123 ## More information -- [Ansible User guide](https://docs.ansible.com/ansible/latest/user_guide/index.html) -- [HomeAssistant / HomeKit Integration](https://www.home-assistant.io/integrations/homekit) -- [Using HomeKit component inside docker](https://community.home-assistant.io/t/using-homekit-component-inside-docker/45409/45?page=2) +- Ansible User guide +- HomeAssistant / HomeKit Integration +- Using HomeKit component inside docker ## License diff --git a/roles/homeassistant/README.md b/roles/homeassistant/README.md index 117a74e..e0a39d9 100644 --- a/roles/homeassistant/README.md +++ b/roles/homeassistant/README.md @@ -1,10 +1,10 @@ # smarthome.homeassistant -Builds and install a custom lscr.io/linuxserver/homeassistant image. +Builds and install a custom lscr.io/linuxserver/homeassistant image. ## Why a Custom Image? -When HomeAssistant is deployed in a bridge network, the HomeKit integration is not discoverable by Apple Home. To resolve this, the HomeAssistant image is built using the original LinuxServer image with [avahi-tools enabled](./templates/homeassistant-avahi-dockerfile.j2). For more details, please refer to this community thread. +When HomeAssistant is deployed in a bridge network, the HomeKit integration is not discoverable by Apple Home. To resolve this, the HomeAssistant image is built using the original LinuxServer image with [avahi-tools enabled](./templates/homeassistant-avahi-dockerfile.j2). For more details, please refer to this community thread. ## Role Variables @@ -25,17 +25,17 @@ When HomeAssistant is deployed in a bridge network, the HomeKit integration is n - Required: no - `homeassistant_env` - Default: `{}` - - Description: Docker container environment variables. See [linuxserver/homeassistant](https://docs.linuxserver.io/images/docker-homeassistant/#environment-variables-e). + - Description: Docker container environment variables. See linuxserver/homeassistant - Type: dict - Required: no - `homeassistant_config` - Default: See [homeassistant_config_default](./vars/main.yml) - - Description: Configuration for [configuration.yaml](https://home-assistant.io/docs/configuration/). + - Description: Configuration for configuration.yaml - Type: dict - Required: no - `homeassistant_homekit_config` - Default: See [homeassistant_homekit_config_default](./vars/main.yml) - - Description: Configuration for the [HomeKit integration](https://www.home-assistant.io/integrations/homekit). + - Description: Configuration for the HomeKit integration - Type: dict - Required: no - `homeassistant_mdns_host_network_interface` @@ -46,7 +46,7 @@ When HomeAssistant is deployed in a bridge network, the HomeKit integration is n ## Dependencies -- [community.docker](https://docs.ansible.com/ansible/latest/collections/community/docker/index.html) +- community.docker ## Example Playbook diff --git a/roles/mosquitto/README.md b/roles/mosquitto/README.md index 983a564..2a41a8c 100644 --- a/roles/mosquitto/README.md +++ b/roles/mosquitto/README.md @@ -1,12 +1,12 @@ # smarthome.mosquitto -Installs the eclipse-mosquitto image. +Installs the eclipse-mosquitto image. ## Role Variables - `mosquitto_version` - Default: `latest` - - Description: The version of the Mosquitto image to install. See [published tags](https://hub.docker.com/_/eclipse-mosquitto/tags). + - Description: The version of the Mosquitto image to install. See published tags. - Type: str - Required: no - `mosquitto_port` @@ -31,13 +31,13 @@ Installs the See docs. - Type: dict with keys `name` (str) and `password` (str) - Required: no ## Dependencies -- [community.docker](https://docs.ansible.com/ansible/latest/collections/community/docker/index.html) +- community.docker ## Example Playbook diff --git a/roles/smarthome/README.md b/roles/smarthome/README.md index 1abd183..5b9816f 100644 --- a/roles/smarthome/README.md +++ b/roles/smarthome/README.md @@ -4,7 +4,7 @@ An all-in-one role to install [HomeAssistant](../homeassistant/readme.md), [Mosq ## Requirements -- A Zigbee Adapter. See [prerequisites](https://www.zigbee2mqtt.io/guide/getting-started/#prerequisites). +- A ZigBee Adapter. ## Role Variables @@ -26,7 +26,7 @@ An all-in-one role to install [HomeAssistant](../homeassistant/readme.md), [Mosq ## Dependencies -- [community.docker](https://docs.ansible.com/ansible/latest/collections/community/docker/index.html) +- community.docker ## Example Playbook diff --git a/roles/zigbee2mqtt/README.md b/roles/zigbee2mqtt/README.md index 305ff98..5f33042 100644 --- a/roles/zigbee2mqtt/README.md +++ b/roles/zigbee2mqtt/README.md @@ -1,17 +1,17 @@ # smarthome.zigbee2mqtt -Installs the koenkk/zigbee2mqtt image. +Installs the koenkk/zigbee2mqtt image. ## Requirements -- A ZigBee Adapter. +- A ZigBee Adapter. - An [MQTT server](../mosquitto/readme.md). ## Role Variables - `zigbee2mqtt_version` - Default: `latest` - - Description: The version of the Zigbee2MQTT image to install. See [published tags](https://hub.docker.com/r/koenkk/zigbee2mqtt/tags). + - Description: The version of the Zigbee2MQTT image to install. See published tags. - Type: str - Required: no - `zigbee2mqtt_network` @@ -31,12 +31,12 @@ Installs the zigbee2mqtt.io. - Type: dict - Required: no - `zigbee2mqtt_config` - Default: See [zigbee2mqtt_config_default](./vars/main.yml) - - Description: Configuration for [configuration.yaml](https://www.zigbee2mqtt.io/guide/configuration/#configuration). **Must include** [server](https://www.zigbee2mqtt.io/guide/configuration/mqtt.html#server-connection) to operate. + - Description: Configuration for configuration.yaml. **Must include** server to operate. - Type: dict - Required: yes - `zigbee2mqtt_device` @@ -47,7 +47,7 @@ Installs the community.docker ## Example Playbook