# Home Assistant (Portainer template)

Home Assistant is an open-source home automation platform that puts local control and privacy first. It acts as a central hub for smart home devices, allowing for complex automation and integration across thousands of different brands.

Quick notes:

- **Network Mode**: For many integrations (like discovery of smart bulbs or TVs), it is highly recommended to use `network_mode: host`.
- **Persistence**: Ensure the `/config` directory is mapped to a persistent volume to save your configuration, dashboards, and integrations.
- **Devices**: If you are using Zigbee or Z-Wave USB sticks, you will need to map the device path (e.g., `/dev/ttyUSB0`) into the container.

Usage:

1. Import the compose file into Portainer's Stacks or App Templates.
2. Configure the volume mapping for the configuration folder.
3. (Optional) Set the timezone environment variable (e.g., `TZ=America/New_York`).
4. Deploy the stack via Portainer.
5. Access the web interface at `http://<your-ip>:8123` to begin the onboarding process.

Helpful links:

- Official Website: https://www.home-assistant.io/
- Documentation: https://www.home-assistant.io/docs/
- GitHub Repository: https://github.com/home-assistant/core
- Docker Hub: https://hub.docker.com/r/homeassistant/home-assistant

**Status:** Ready for configuration