{"id":24744343,"url":"https://github.com/szymczag/homeassistant-cloudflared","last_synced_at":"2026-04-13T17:33:11.117Z","repository":{"id":274419780,"uuid":"916469043","full_name":"szymczag/homeassistant-cloudflared","owner":"szymczag","description":"☁️ 🔒 Securely expose your Home Assistant instance via Cloudflare Tunnel—no port forwarding, no extra SSL configurations!","archived":false,"fork":false,"pushed_at":"2025-01-27T07:03:10.000Z","size":33,"stargazers_count":2,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-06-27T15:06:14.035Z","etag":null,"topics":["cloudflare","homeassistant"],"latest_commit_sha":null,"homepage":"","language":"Dockerfile","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/szymczag.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2025-01-14T06:45:08.000Z","updated_at":"2025-06-25T14:02:04.000Z","dependencies_parsed_at":"2025-01-27T08:29:43.196Z","dependency_job_id":null,"html_url":"https://github.com/szymczag/homeassistant-cloudflared","commit_stats":null,"previous_names":["szymczag/homeassistant-cloudflared"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/szymczag/homeassistant-cloudflared","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/szymczag%2Fhomeassistant-cloudflared","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/szymczag%2Fhomeassistant-cloudflared/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/szymczag%2Fhomeassistant-cloudflared/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/szymczag%2Fhomeassistant-cloudflared/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/szymczag","download_url":"https://codeload.github.com/szymczag/homeassistant-cloudflared/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/szymczag%2Fhomeassistant-cloudflared/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262279119,"owners_count":23286549,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cloudflare","homeassistant"],"created_at":"2025-01-28T02:18:02.065Z","updated_at":"2026-04-13T17:33:06.094Z","avatar_url":"https://github.com/szymczag.png","language":"Dockerfile","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Cloudflared Tunnel for Home Assistant :cloud: :lock:\n\n[![Release][release-badge]][release-link]\n[![License: MIT][license-badge]][license-link]\n[![Changelog][changelog-badge]][changelog-link]\n[![CI/CD Status](https://github.com/szymczag/homeassistant-cloudflared/actions/workflows/ci.yml/badge.svg)](https://github.com/szymczag/homeassisant-cloudflared/actions)\n\nSecurely expose your Home Assistant instance via **Cloudflare Tunnel**—no port forwarding, no extra SSL configurations! This add-on handles the Cloudflare connector automatically once you provide an ephemeral tunnel token from [Cloudflare Zero Trust](https://dash.teams.cloudflare.com/).\n\n---\n\n## Features :rocket:\n- **Secure** end-to-end tunnel to your Home Assistant.\n- **Ephemeral tokens**: no need to manage separate credential files.\n- Minimal configuration required: just supply your **tunnel token** from Cloudflare.\n\n---\n\n## Installation :wrench:\n\n1. **Add this repository** to your Home Assistant Supervisor.  \n   - In Home Assistant, go to **Settings → Add-ons → Add-on Store**.  \n   - Click the **3-dot menu** in the top right → **Repositories** → paste:  \n     ```\n     https://github.com/szymczag/homeassistant-cloudflared\n     ```\n   - Click **Add**.  \n2. **Install the add-on**:  \n   - Search for “**Cloudflared Tunnel for Home Assistant**” in the Add-on Store and install.  \n3. **Configure**:  \n   - Go to the add-on’s **Configuration** tab.  \n   - Paste your **Cloudflare Tunnel Token** (see below).  \n4. **Start** the add-on.  \n\n---\n\n## How to Get a Cloudflare Tunnel Token :clipboard:\n\n1. Go to [Cloudflare Zero Trust](https://dash.teams.cloudflare.com/) and create a new tunnel (e.g., `ha-tunnel`).  \n2. **Add a public hostname** (e.g. `ha.example.com`) pointing to `http://homeassistant:8123` (or your local IP).  \n3. In the Cloudflare tunnel page, click **Install Connector** (or similar).  \n4. Copy only the token portion from the `cloudflared tunnel run --token \u003cTOKEN\u003e` command.  \n5. In Home Assistant, paste it into the **Cloudflare Tunnel Token** field.  \n\nOnce started, your add-on should connect to Cloudflare.  \nYou can access Home Assistant externally via `https://ha.example.com` (or whatever custom domain you set up).\n\n---\n\n## Configuration Changes Required in configuration.yaml :wrench:\nTo ensure proper operation with Cloudflare Tunnel, you must add the following settings to your Home Assistant `configuration.yaml` file:\n```\nhttp:\n  ip_ban_enabled: true\n  trusted_proxies:\n    - 172.30.33.0/24\n  cors_allowed_origins:\n    - https://your-local-ha-url\n    - https://your-cloudflare-url\n```\nReplace `https://your-local-ha-url` with your local Home Assistant URL (e.g., `https://homeassistant.local:8123`) and `https://your-cloudflare-url` with your Cloudflare Tunnel URL (e.g., `https://ha.example.com`). Check the `trusted_proxies` IP range if it matches your Home Assistant Supervisor network.\n\n### Explanation of Each Setting:\n- `ip_ban_enabled: true` → Enables automatic banning of malicious IP addresses.\n- `trusted_proxies` → Allows Cloudflare Tunnel (running in the Home Assistant add-on environment) to act as a trusted reverse proxy.\n- `cors_allowed_origins` → Specifies the URLs that are allowed to interact with Home Assistant through the browser.\n\n\n## Changelog :scroll:\nCheck out our [CHANGELOG.md](CHANGELOG.md) for details on each release.  \n(Or view all releases and tags on the [GitHub Releases][release-link].)\n\n---\n\n## Contributing :handshake:\n- **Issues**: Please open a [GitHub Issue](https://github.com/szymczag/homeassistant-cloudflared/issues) for bug reports or feature requests.  \n- **Pull Requests**: Fork the repository and open a PR with a clear description of changes. I welcome contributions, but they must be reviewed before merging.\n\nBefore that, please test it locally and ensure it works as expected.\n```\ndocker build -t cloudflared-test .\ndocker run --rm -e CLOUDFLARE_TUNNEL_TOKEN=\"xxx\" cloudflared-test\n```\nand then:\n```\nha addons validate .\n```\n\n---\n\n## License\nThis project is licensed under the [MIT][license-link].  \nSee the [LICENSE](LICENSE) file for details.\n\n---\n\n## Author :writing_hand:\n**@szymczag**  \n- GitHub: [github.com/szymczag](https://github.com/szymczag/homeassistant-cloudflared)\n\n---\n\n## Continuous Integration (CI/CD)\nThis add-on uses GitHub Actions to automatically validate every commit and pull request.\nThe CI/CD pipeline ensures that:\n\n- `config.json` is present and has valid JSON syntax.\n- The `Dockerfile` passes linting (`hadolint`).\n- The add-on builds correctly.\n- A test run of the container succeeds.\n\n[release-badge]: https://img.shields.io/github/v/release/szymczag/homeassistant-cloudflared.svg?logo=github\n[release-link]: https://github.com/szymczag/homeassistant-cloudflared/releases\n\n[license-badge]: https://img.shields.io/github/license/szymczag/homeassistant-cloudflared?color=blue\n[license-link]: https://github.com/szymczag/homeassistant-cloudflared/blob/main/LICENSE\n\n[changelog-badge]: https://img.shields.io/badge/changelog-click%20here-blue\n[changelog-link]: https://github.com/szymczag/homeassistant-cloudflared/blob/main/CHANGELOG.md\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fszymczag%2Fhomeassistant-cloudflared","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fszymczag%2Fhomeassistant-cloudflared","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fszymczag%2Fhomeassistant-cloudflared/lists"}