docker-compose-collection/homeassistant/README.md

# Home Assistant Docker Setup with Traefik

This guide provides instructions for deploying Home Assistant using Docker and Traefik as a reverse proxy. The setup includes securing the Home Assistant instance with HTTPS and configuring a trusted proxy.

## Prerequisites
- Docker and Docker Compose installed on your system
- Traefik configured as your reverse proxy
- A domain name pointing to your Home Assistant instance

## Environment Variables
Before deploying the container, create a `.env` file from the provided `.env-example` file and adjust the values as needed.

```sh
cp .env-example .env
nano .env
```

### `.env-example` file
```ini
# Home Assistant Version (Default: latest)
HOMEASSISTANT_VERSION=latest

# Home Assistant Domain
HOMEASSISTANT_DOMAIN=homeassistant.example.com
```

## Starting the Container
Once the `.env` file is configured, start the Home Assistant container using:
```sh
docker-compose up -d
```

## Configuring the Reverse Proxy
To enable proper proxy support in Home Assistant, update `data/config/configuration.yaml` with the following settings:

### Finding the Local Subnet IP
To determine the Docker subnet used by Home Assistant, run:
```sh
docker inspect homeassistant | grep Gateway
```

### `configuration.yaml`
```yaml
http:
  ip_ban_enabled: true
  login_attempts_threshold: 5
  use_x_forwarded_for: true
  trusted_proxies:
    - 10.0.0.0/24 # Local Subnet
    - 172.18.0.0/24 # Your Docker Subnet
```

## Accessing Home Assistant
Once everything is set up, restart Home Assistant and it should be accessible via the configured domain:
```
https://homeassistant.example.com
```

If there are any issues, check the container logs with:
```sh
docker logs -f homeassistant
```