SuperAPI AI Directory
Partner with us中文AI newsFavorites
Skillshaos-https-tunnel

haos-https-tunnel

Deployment & operations

View repository

Updated 10-15 17:31

About this skill

HAOS HTTPS via Cloudflare Tunnel

Give a HAOS box a public https://ha.<domain> that works from anywhere, without opening router ports or installing anything on client devices. Battle-tested 2026-07-10 on a Raspberry Pi 4 (HAOS 18.1, Core 2026.6.4) with the brenner-tobias/cloudflared add-on v7.0.9; §4's ≥ 2026.8 UI steps follow the official http integration page. Every pitfall below was hit for real; ⚠️ marks them.

0. Why this route (and what was rejected)

Tunnel = the RPi opens an outbound long-lived connection to Cloudflare; DNS is a CNAME to cfargotunnel.com, never your home IP. No inbound port, dynamic IP is a non-event, TLS terminates at Cloudflare against a tunnel token.

Rejected alternatives (re-suggest one only on new facts):

  • HA-native SSL (http: ssl_certificate): forces HTTPS globally — local http://<ip>:8123 stops working and everything gets slower. Real-world regret.
  • DuckDNS + port-forward 443: exposes the home IP and an inbound port to the internet.
  • Nabu Casa: works, but monthly fee.
  • Tailscale: needs an app on every client device.

1. Prerequisites

  • A domain in the user's Cloudflare account as a zone. Bought via Cloudflare Registrar → zone exists automatically. Verify from anywhere: dig +short NS <domain> → should return *.ns.cloudflare.com names.
  • SSH access to the HAOS box per haos-addon-deploy §0/§8 (⚠️ non-interactive ha CLI calls need ssh ha 'bash -lc "…"', otherwise unauthorized).
  • ha = SSH alias into the Advanced SSH & Web Terminal add-on, Protection mode off.
  • ⚠️ You (the agent) can do everything below except the user's steps: the Cloudflare login authorisation (§5), and on Core ≥ 2026.8 the proxy settings in the UI (§4) — plan the hand-offs.

2. Install the cloudflared add-on

ssh ha 'bash -lc "ha store add https://github.com/brenner-tobias/ha-addons && ha store reload"'
ssh ha 'bash -lc "ha store repositories | grep -B2 -A4 -i brenner"'   # repo slug: 9074a9fa
ssh ha 'bash -lc "ha apps install 9074a9fa_cloudflared"'
  • ⚠️ The subcommand is ha store add <url>. There is no add-repository; a wrong subcommand doesn't error — it dumps the whole store listing and exits 0, so verify the repo actually appeared (ha store repositories) instead of trusting the exit code.
  • The installed add-on slug is <repo-slug>_cloudflared, e.g. 9074a9fa_cloudflared.

3. Configure the add-on

Only one option is required — the public hostname:

echo '{"options":{"external_hostname":"ha.<domain>","additional_hosts":[]}}' \
  | ssh ha 'bash -lc "curl -sS -X POST -H \"Authorization: Bearer \$SUPERVISOR_TOKEN\" \
            -H \"Content-Type: application/json\" -d @- \
            http://supervisor/addons/9074a9fa_cloudflared/options"'

(Or the add-on's Configuration tab in the HA UI.) Leave tunnel_token unset: §5's login flow creates the tunnel. Done when the same curl as a plain GET on …/addons/9074a9fa_cloudflared/info shows external_hostname set (haos-addon-deploy §4).

4. Trust the proxy (before first start)

Tunnel traffic reaches HA as reverse-proxied requests; HA rejects them (or logs the proxy's IP for everything, breaking IP banning) unless the proxy subnet is trusted. Where the setting lives depends on the Core version (ssh ha 'bash -lc "ha core info"'):

Core ≥ 2026.8 — UI, user hand-off. The HTTP server is configured under Settings → System → Network; saving there restarts HA. Ask the user to set: Trust X-Forwarded-For on; Trusted proxies 172.30.33.0/24 (Supervisor docker subnet, where add-ons live); Enable IP banning on (public endpoint now — keep it on); Login attempts before ban 3. Use the UI on every ≥ 2026.8 box, fresh installs included — the docs describe YAML import only as a one-time upgrade step. Done when the user confirms the four values saved and HA is back after its restart.

  • ⚠️ A box upgraded across 2026.8 imported its old http: block into .storage/http on first start and ignores the YAML from then on (repair: "HTTP YAML configuration is ignored after migration"). Editing configuration.yaml changes nothing; the UI holds the live values. Observed 2026-08-15 on Core 2026.8.1.

Core < 2026.8 — configuration.yaml.

http:
  use_x_forwarded_for: true
  trusted_proxies:
    - 172.30.33.0/24   # Supervisor docker subnet, where add-ons live
  ip_ban_enabled: true          # public endpoint now — keep this on
  login_attempts_threshold: 3
  • File location from the SSH add-on: /config/configuration.yaml (/homeassistant/... is an alias mount of the same volume).
  • ⚠️ /config is root-owned — cp/sed need sudo from the SSH add-on.
  • High-risk config edit: back up first (sudo cp configuration.yaml configuration.yaml.bak-YYYYMMDD), then edit, then ha core check before ha core restart. Don't skip the check — a broken yaml keeps HA from booting.

5. Start and authorise (user hand-off)

ssh ha 'bash -lc "ha apps start 9074a9fa_cloudflared"'
ssh ha 'bash -lc "ha apps logs 9074a9fa_cloudflared"'

First start with no tunnel_token: the log prints Please open the following URL and log in with your Cloudflare account: followed by a https://dash.cloudflare.com/argotunnel?... link. Hand this URL to the user — they log in, pick the zone, authorise. cloudflared then downloads the cert, creates the tunnel, and creates the DNS CNAME itself. Step done when the user reports the authorisation; §6 confirms it.

6. Verify

ssh ha 'bash -lc "ha apps logs 9074a9fa_cloudflared"' | grep -iE "registered|route|error"
# want: "Added CNAME ha.<domain> …" + 4× "Registered tunnel connection"
curl -s -o /dev/null -w "%{http_code} %{time_total}s\n" https://ha.<domain>/
# want: 200
  • ⚠️ A precheck line UDP Connectivity … QUIC connection failed / degraded transport, will proceed using 'http2' is fine — some networks block outbound UDP 7844; http2 fallback works. Only a hard fail matters.
  • Nearby edge locations in the "Registered tunnel connection" lines (e.g. <iata>01) = good latency; nothing to configure.

7. Post-setup (tell the user)

  • Enable 2FA on HA accounts — the login page is now on the public internet. IP banning + the login-attempt threshold (§4) are the second line, not a substitute.
  • Companion app: external URL → https://ha.<domain>; internal URL → the LAN address, which keeps working (http://<lan-ip>:8123).
  • Take a full HA backup now (config just changed) and pull it off the box — scp ha:/backup/<file>.tar beats the web download. If the user versions /config, exclude .storage/ (auth tokens) and secrets.yaml.