Skip to content

Commit

Permalink
open external links in new tabs
Browse files Browse the repository at this point in the history
  • Loading branch information
artyorsh committed Aug 24, 2024
1 parent 8c80831 commit 07ff490
Show file tree
Hide file tree
Showing 5 changed files with 29 additions and 29 deletions.
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <a href="https://home-assistant.io" target="_blank">HomeAssistant</a>,
<a href="https://www.zigbee2mqtt.io" target="_blank">Zigbee2MQTT</a>
and <a href="https://mosquitto.org" target="_blank">Mosquitto</a>,
of <a href="https://home-assistant.io" alt target="_blank">HomeAssistant</a>,
<a href="https://www.zigbee2mqtt.io" alt target="_blank">Zigbee2MQTT</a>
and <a href="https://mosquitto.org" alt target="_blank">Mosquitto</a>,
making them ready to connect to Apple Home.

## Requirements

- A <a href="https://www.zigbee2mqtt.io/guide/getting-started/#prerequisites" target="_blank">ZigBee Adapter</a>.
- Docker. Please refer to <a href="https://github.com/geerlingguy/ansible-role-docker?tab=readme-ov-file#ansible-role-docker" target="_blank">ansible-role-docker</a> to install it with Ansible.
- A <a href="https://www.zigbee2mqtt.io/guide/getting-started/#prerequisites" alt target="_blank">ZigBee Adapter</a>.
- Docker. Please refer to <a href="https://github.com/geerlingguy/ansible-role-docker?tab=readme-ov-file#ansible-role-docker" alt target="_blank">ansible-role-docker</a> to install it with Ansible.

## Installation

Expand All @@ -30,11 +30,11 @@ ansible-galaxy collection install artyorsh.smarthome
<!-- see https://www.home-assistant.io/integrations/alarm_control_panel.mqtt/#state_topic -->
<!-- see https://www.home-assistant.io/integrations/alarm_control_panel.mqtt/#command_topic -->

1. <a href="https://www.zigbee2mqtt.io/guide/getting-started/#installation" target="_blank">Find the ZigBee adapter</a>
1. <a href="https://www.zigbee2mqtt.io/guide/getting-started/#installation" alt target="_blank">Find the ZigBee adapter</a>
2. [Run the playbook](#example-playbook)
3. <a href="https://www.home-assistant.io/integrations/homekit/#setup" target="_blank">Enable the HomeKit integration in AppleHome</a> (starting from step 1)
3. <a href="https://www.home-assistant.io/integrations/homekit/#setup" alt target="_blank">Enable the HomeKit integration in AppleHome</a> (starting from step 1)

For a real-world usage example, see my <a href="https://github.com/artyorsh/infra" target="_blank">infra playbooks</a>.
For a real-world usage example, see my <a href="https://github.com/artyorsh/infra" alt target="_blank">infra playbooks</a>.

## Example Playbook

Expand All @@ -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)
- <a href="https://docs.ansible.com/ansible/latest/user_guide/index.html" alt target="_blank">Ansible User guide</a>
- <a href="https://www.home-assistant.io/integrations/homekit" alt target="_blank">HomeAssistant / HomeKit Integration</a>
- <a href="https://community.home-assistant.io/t/using-homekit-component-inside-docker/45409/45?page=2" alt target="_blank">Using HomeKit component inside docker</a>
## License
Expand Down
12 changes: 6 additions & 6 deletions roles/homeassistant/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# smarthome.homeassistant

Builds and install a custom <a href="https://hub.docker.com/r/linuxserver/homeassistant" target="_blank">lscr.io/linuxserver/homeassistant</a> image.
Builds and install a custom <a href="https://hub.docker.com/r/linuxserver/homeassistant" alt target="_blank">lscr.io/linuxserver/homeassistant</a> 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 <a href="https://community.home-assistant.io/t/using-homekit-component-inside-docker/45409/45?page=2" target="_blank">community thread</a>.
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 <a href="https://community.home-assistant.io/t/using-homekit-component-inside-docker/45409/45?page=2" alt target="_blank">community thread</a>.

## Role Variables

Expand All @@ -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 <a href="https://docs.linuxserver.io/images/docker-homeassistant/#environment-variables-e" alt target="_blank">linuxserver/homeassistant</a>
- 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 <a href="https://home-assistant.io/docs/configuration/" alt target="_blank">configuration.yaml</a>
- 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 <a href="https://www.home-assistant.io/integrations/homekit" alt target="_blank">HomeKit integration</a>
- Type: dict
- Required: no
- `homeassistant_mdns_host_network_interface`
Expand All @@ -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)
- <a href="https://docs.ansible.com/ansible/latest/collections/community/docker/index.html" alt target="_blank">community.docker</a>

## Example Playbook

Expand Down
8 changes: 4 additions & 4 deletions roles/mosquitto/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# smarthome.mosquitto

Installs the <a href="https://github.com/eclipse/mosquitto/tree/master/docker#docker-images" target="_blank">eclipse-mosquitto</a> image.
Installs the <a href="https://github.com/eclipse/mosquitto/tree/master/docker#docker-images" alt target="_blank">eclipse-mosquitto</a> 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 <a href="https://hub.docker.com/_/eclipse-mosquitto/tags" alt target="_blank">published tags</a>.
- Type: str
- Required: no
- `mosquitto_port`
Expand All @@ -31,13 +31,13 @@ Installs the <a href="https://github.com/eclipse/mosquitto/tree/master/docker#do
- Required: no
- `mosquitto_user`
- Default: `{ name: "{{ ansible_user }}", password: "mosquitto" }`
- Description: Authentication credentials for the Mosquitto instance. [See docs](https://mosquitto.org/documentation/authentication-methods).
- Description: Authentication credentials for the Mosquitto instance. <a href="https://mosquitto.org/documentation/authentication-methods" alt target="_blank">See docs</a>.
- 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)
- <a href="https://docs.ansible.com/ansible/latest/collections/community/docker/index.html" alt target="_blank">community.docker</a>

## Example Playbook

Expand Down
4 changes: 2 additions & 2 deletions roles/smarthome/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <a href="https://www.zigbee2mqtt.io/guide/getting-started/#prerequisites" alt target="_blank">ZigBee Adapter</a>.

## Role Variables

Expand All @@ -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)
- <a href="https://docs.ansible.com/ansible/latest/collections/community/docker/index.html" alt target="_blank">community.docker</a>

## Example Playbook

Expand Down
12 changes: 6 additions & 6 deletions roles/zigbee2mqtt/README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
# smarthome.zigbee2mqtt

Installs the <a href="https://hub.docker.com/r/koenkk/zigbee2mqtt/" target="_blank">koenkk/zigbee2mqtt</a> image.
Installs the <a href="https://hub.docker.com/r/koenkk/zigbee2mqtt/" alt target="_blank">koenkk/zigbee2mqtt</a> image.

## Requirements

- A <a href="https://www.zigbee2mqtt.io/guide/getting-started/#prerequisites" target="_blank">ZigBee Adapter</a>.
- A <a href="https://www.zigbee2mqtt.io/guide/getting-started/#prerequisites" alt target="_blank">ZigBee Adapter</a>.
- 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 <a href="https://hub.docker.com/r/koenkk/zigbee2mqtt/tags" alt target="_blank">published tags</a>.
- Type: str
- Required: no
- `zigbee2mqtt_network`
Expand All @@ -31,12 +31,12 @@ Installs the <a href="https://hub.docker.com/r/koenkk/zigbee2mqtt/" target="_bla
- Required: no
- `zigbee2mqtt_env`
- Default: `{}`
- Description: Docker container environment variables. See [zigbee2mqtt.io](https://www.zigbee2mqtt.io/guide/installation/02_docker.html#running-the-container).
- Description: Docker container environment variables. <a href="https://www.zigbee2mqtt.io/guide/installation/02_docker.html#running-the-container" alt target="_blank">zigbee2mqtt.io</a>.
- 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 <a href="https://www.zigbee2mqtt.io/guide/configuration/#configuration" alt target="_blank">configuration.yaml</a>. **Must include** <a href="https://www.zigbee2mqtt.io/guide/configuration/mqtt.html#server-connection" alt target="_blank">server</a> to operate.
- Type: dict
- Required: yes
- `zigbee2mqtt_device`
Expand All @@ -47,7 +47,7 @@ Installs the <a href="https://hub.docker.com/r/koenkk/zigbee2mqtt/" target="_bla

## Dependencies

- [community.docker](https://docs.ansible.com/ansible/latest/collections/community/docker/index.html)
- <a href="https://docs.ansible.com/ansible/latest/collections/community/docker/index.html" alt target="_blank">community.docker</a>

## Example Playbook

Expand Down

0 comments on commit 07ff490

Please sign in to comment.