Home Automation

Automation using docker compose in your NAS (raspberry pi, orange pi, nuc or delorean lol)

Steps

• Install docker
• Install docker compose
• Configure Github user if you need it (see Github section)
• Check mount-hdd.sh to mount your disk in NAS
• Clone this repository
• Set static ip in the NAS (explained below)
• Configure your .env file with all variables required as described in .env.example
• Run docker compose up --build -d to start containers
• Run sh install-hacs.sh to install HACS in Home Assistant container
• Configure your router with the static ip assigned to NAS as DNS primary, necessary for pihole
• Configure all devices you need in Home Assistant
• Go to Cloudflare Tunnel Dashboard and expose all containers you want. You need a domain previously configured in Cloudflare
• Enjoy!

Services

Available

• Home Assistant (HACS)
• SFTPGo (secure file transfer)
• Homebridge (integrate devices with HomeKit)
• Cloudflared (Cloudflare Tunnel)
• Portainer (Manage containers)
• WatchTower (Update containers)
• PiHole (DNS filtering / ad blocking / privacy)
• Tailscale (VPN)

Coming soon

• WireGuard Easy (VPN) ...some day. CGNAT is too complicated.
• Addons for Home Assistant
• QBitTorrent
• Mosquitto (MQTT Broker for IOT)

Configuration

Set static ip

sudo nmtui

Edit your connection with this values.

Values

• address: 192.168.1.10/24 (static ip example)
• gateway: 192.168.1.1
• dns: 1.1.1.1
• dns: 1.0.0.1

Github

Generate ssh key in NAS with email

ssh-keygen -t rsa -b 4096 -C "your@email.com"

Add ssh key in Github

Setting > SSH and GPG keys > New SSH key

Good job, you can now clone all repositories!

Tailscale

Create account and generate auth key

Go to Tailscale and create account. Move to Setting > Personal Settings > Keys > Generate auth key

Complete form and enable Reusable option. Remember auth key expire in 90 days (free mode). Add this key in your .env file.

After run docker containers go to Machines section, in homelab-docker machine > 3 dots > edit route settings > check if subnet routes and exit node is enabled.

Install tailscale app in your mobile, login with your account and enjoy!

PiHole

Fix database, maybe you need in first time

docker exec -it pihole pihole -g

Home Assistant in Cloudflare Tunnel.

Go to Home Assistant > File Editor > configuration.yaml > Edit

http:
  use_x_forwarded_for: true
  trusted_proxies:
    - 172.20.0.0/24
  ip_ban_enabled: true
  login_attempts_threshold: 5

Docker commands

Up services

docker compose up --build -d

Check status

docker ps

Enter into container

docker exec -ti <container-name-or-id> /bin/bash

Stop services

docker compose down

See logs

docker compose logs -f <container-name-or-id>