https://github.com/brenner-tobias/addon-cloudflared
Connect remotely to your Home Assistant instance without opening any ports using Cloudflared.
https://github.com/brenner-tobias/addon-cloudflared
addon homeassistant
Last synced: 5 months ago
JSON representation
Connect remotely to your Home Assistant instance without opening any ports using Cloudflared.
- Host: GitHub
- URL: https://github.com/brenner-tobias/addon-cloudflared
- Owner: brenner-tobias
- License: mit
- Created: 2021-11-28T12:52:22.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2025-05-02T12:12:57.000Z (5 months ago)
- Last Synced: 2025-05-02T12:47:31.930Z (5 months ago)
- Topics: addon, homeassistant
- Language: Shell
- Homepage:
- Size: 3.15 MB
- Stars: 1,069
- Watchers: 9
- Forks: 62
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# Home Assistant Add-on: Cloudflared
[![GitHub Release][releases-shield]][releases]
![Project Stage][project-stage-shield]
[![License][license-shield]](LICENSE.md)
![Supports aarch64 Architecture][aarch64-shield]
![Supports amd64 Architecture][amd64-shield]
![Supports armhf Architecture][armhf-shield]
![Supports armv7 Architecture][armv7-shield]
![Supports i386 Architecture][i386-shield]
[![Github Actions][github-actions-shield]][github-actions]
![Project Maintenance][maintenance-shield]
[![GitHub Activity][commits-shield]][commits]
![Reported Installations][installations-shield-stable]
Connect remotely to your Home Assistant and other services, without opening ports
using Cloudflare Tunnel.
## About
Cloudflared connects your Home Assistant Instance via a secure tunnel to a domain
or subdomain at Cloudflare. This allows you to expose your Home Assistant
instance and other services to the Internet without opening ports on your router.
Additionally, you can utilize Cloudflare Zero Trust to further secure your
connection.
**To use this add-on, you have to own a domain name (e.g. example.com) that is
using Cloudflare for its DNS entries. You can find more information about that
in our [Wiki][wiki].**
**Please be aware that domains from _Freenom_ do not work anymore, so
you have to chose / migrate to another registrar.**
[:books: Read the full add-on documentation][docs]
## Disclaimer
Please make sure you comply with the
[Cloudflare Self-Serve Subscription Agreement][cloudflare-sssa] when using this
add-on.
## Installation
To install this add-on, manually add my HA-Addons repository to Home Assistant
using [this GitHub repository][ha-addons] or by clicking the button below.
[![Add Repository to HA][my-ha-badge]][my-ha-url]
## Support
Got questions?
Feel free to [open an issue here][issue] on GitHub.
## Authors & contributors
The original setup of this repository is by [Tobias Brenner][tobias].
For a full list of all authors and contributors,
check [the contributor's page][contributors].
## License
MIT License
Copyright (c) 2025 Tobias Brenner
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
[aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg
[amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg
[armhf-shield]: https://img.shields.io/badge/armhf-no-red.svg
[armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg
[cloudflare-sssa]: https://www.cloudflare.com/terms/
[commits-shield]: https://img.shields.io/github/commit-activity/y/brenner-tobias/addon-cloudflared.svg
[commits]: https://github.com/brenner-tobias/addon-cloudflared/commits/main
[contributors]: https://github.com/brenner-tobias/addon-cloudflared/graphs/contributors
[docs]: cloudflared/DOCS.md
[domainarticle]: https://www.linkedin.com/pulse/what-do-domain-name-how-get-one-free-tobias-brenner?trk=public_post-content_share-article
[github-actions-shield]: https://github.com/brenner-tobias/addon-cloudflared/workflows/CI/badge.svg
[github-actions]: https://github.com/brenner-tobias/addon-cloudflared//actions
[ha-addons]: https://github.com/brenner-tobias/ha-addons
[i386-shield]: https://img.shields.io/badge/i386-no-red.svg
[issue]: https://github.com/brenner-tobias/addon-cloudflared/issues
[license-shield]: https://img.shields.io/github/license/brenner-tobias/addon-cloudflared
[maintenance-shield]: https://img.shields.io/maintenance/yes/2025.svg
[project-stage-shield]: https://img.shields.io/badge/project%20stage-production%20ready-brightgreen.svg
[releases-shield]: https://img.shields.io/github/v/release/brenner-tobias/addon-cloudflared?include_prereleases
[releases]: https://github.com/brenner-tobias/addon-cloudflared/releases
[tobias]: https://github.com/brenner-tobias
[my-ha-badge]: https://my.home-assistant.io/badges/supervisor_add_addon_repository.svg
[my-ha-url]: https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2Fbrenner-tobias%2Fha-addons
[wiki]: https://github.com/brenner-tobias/addon-cloudflared/wiki/How-tos
[installations-shield-stable]: https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fanalytics.home-assistant.io%2Faddons.json&query=%24%5B%229074a9fa_cloudflared%22%5D.total&label=Reported%20Installations&link=https%3A%2F%2Fanalytics.home-assistant.io/add-ons