Added Cloudflared Add-On

2021-11-28 14:16:00 +01:00
parent 6c1ad366ae
commit 3da60c72cc
7 changed files with 239 additions and 2 deletions
@@ -0,0 +1,82 @@
+# 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]
+
+Connect remotely to your Home Assistant instance without opening any ports using
+Cloudflared.
+
+## About
+
+Cloudflared connects your Home Assistant Instance via a secure tunnel to a domain
+or subdomain at Cloudflare. Doing that, you can expose your Home Assitant to the
+Internet without opening ports in your router. Additionally, you can utilize
+Cloudflare Teams, their Zero Trust platform to further secure your Home Assistant
+connection.
+
+**To use this add-on you have to own a domain name (e.g. example.com) and use the
+DNS servers of cloudflare. If you do not have a domain name, you can register a
+free one at [freenom][freenom]**
+
+[:books: Read the full add-on documentation][docs]
+
+## Support
+
+Got questions?
+
+Feel free to [open an issue here][issue] on GitHub.
+
+## Author
+
+[Tobias Brenner][tobias]
+
+## License
+
+MIT License
+
+Copyright (c) 2021 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-yes-green.svg
+[armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg
+[docs]: cloudflared/DOCS.md
+[freenom]: https://freenom.com
+[github-actions-shield]: https://github.com/brenner-tobias/addon-cloudflared/workflows/CI/badge.svg
+[github-actions]: https://github.com/brenner-tobias/addon-cloudflared//actions
+[i386-shield]: https://img.shields.io/badge/i386-yes-green.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/2021.svg
+[project-stage-shield]: https://img.shields.io/badge/project%20stage-experimental-yellow.svg
+[releases-shield]: https://img.shields.io/github/release/brenner-tobias/addon-cloudflared
+[releases]: https://github.com/brenner-tobias/addon-cloudflared/releases
+[tobias]: https://github.com/brenner-tobias