Brenner-Bot
104 lines
4.3 KiB
Markdown
104 lines
4.3 KiB
Markdown
# Home Assistant Add-on Repository for Cloudflared
|
|
|
|
![Project Stage][project-stage-shield]
|
|
![Maintenance][maintenance-shield]
|
|
[![License][license-shield]](LICENSE.md)
|
|
|
|
## About
|
|
|
|
Home Assistant allows anyone to create add-on repositories to share their
|
|
add-ons for Home Assistant easily. This repository is one of those repositories,
|
|
providing extra Home Assistant add-ons for your installation.
|
|
|
|
The primary goal of this repository is to provide an add-on to use Cloudflared.
|
|
Additional add-ons might follow in the future.
|
|
|
|
## Installation
|
|
|
|
Adding this add-ons repository to your Home Assistant instance is
|
|
pretty straightforward. In the Home Assistant add-on store,
|
|
a possibility to add a repository is provided.
|
|
|
|
Use the following URL to add this repository:
|
|
|
|
```txt
|
|
https://github.com/brenner-tobias/ha-addons
|
|
```
|
|
|
|
## Add-ons provided by this repository
|
|
|
|
### ✓ [Cloudflared][addon-cloudflared]
|
|
|
|
![Latest Version][cloudflared-version-shield]
|
|
![Supports armhf Architecture][cloudflared-armhf-shield]
|
|
![Supports armv7 Architecture][cloudflared-armv7-shield]
|
|
![Supports aarch64 Architecture][cloudflared-aarch64-shield]
|
|
![Supports amd64 Architecture][cloudflared-amd64-shield]
|
|
![Supports i386 Architecture][cloudflared-i386-shield]
|
|
|
|
Use a Cloudflare Tunnel to remotely connect to Home Assistant without opening any ports
|
|
|
|
[:books: Cloudflared add-on documentation][addon-doc-cloudflared]
|
|
|
|
## Releases
|
|
|
|
Releases are based on [Semantic Versioning][semver], and use the format
|
|
of ``MAJOR.MINOR.PATCH``. In a nutshell, the version will be incremented
|
|
based on the following:
|
|
|
|
- ``MAJOR``: Incompatible or major changes.
|
|
- ``MINOR``: Backwards-compatible new features and enhancements.
|
|
- ``PATCH``: Backwards-compatible bugfixes and package updates.
|
|
|
|
## Support
|
|
|
|
Got questions?
|
|
|
|
Open an issue here on GitHub. Note, we use a separate
|
|
GitHub repository for each add-on. Please ensure you are creating the issue
|
|
on the correct GitHub repository matching the add-on.
|
|
|
|
- [Open an issue for the add-on: Cloudflared][cloudflared-issue]
|
|
|
|
For a general repository issue or add-on ideas [open an issue here][issue]
|
|
|
|
## License
|
|
|
|
MIT License
|
|
|
|
Copyright (c) 2022 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.
|
|
|
|
[addon-cloudflared]: https://github.com/brenner-tobias/addon-cloudflared/tree/v4.0.8
|
|
[addon-doc-cloudflared]: https://github.com/brenner-tobias/addon-cloudflared/blob/v4.0.8/README.md
|
|
[cloudflared-issue]: https://github.com/brenner-tobias/addon-cloudflared/issues
|
|
[cloudflared-version-shield]: https://img.shields.io/badge/version-v4.0.8-blue.svg
|
|
[cloudflared-aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg
|
|
[cloudflared-amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg
|
|
[cloudflared-armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg
|
|
[cloudflared-armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg
|
|
[cloudflared-i386-shield]: https://img.shields.io/badge/i386-yes-green.svg
|
|
[gitlabci-shield]: https://gitlab.com/brenner-tobias/ha-addons/badges/master/pipeline.svg
|
|
[gitlabci]: https://gitlab.com/brenner-tobias/ha-addons/pipelines
|
|
[issue]: https://github.com/brenner-tobias/ha-addons/issues
|
|
[license-shield]: https://img.shields.io/github/license/brenner-tobias/ha-addons.svg
|
|
[maintenance-shield]: https://img.shields.io/maintenance/yes/2022.svg
|
|
[project-stage-shield]: https://img.shields.io/badge/project%20stage-production%20ready-brightgreen.svg
|
|
[semver]: http://semver.org/spec/v2.0.0.html |