Netmaker add-on: pull prebuilt image from Gitea registry
Home Assistant add-on that joins the instance to a Netmaker network via netclient. Distributed as a repository add-on using a prebuilt arm64 image (gitea.savant.io/homeassistant/netmaker) to avoid local buildx. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This commit is contained in:
46
README.md
Normal file
46
README.md
Normal file
@ -0,0 +1,46 @@
|
||||
# Home Assistant Community App: Netmaker
|
||||
|
||||
![Project Stage][project-stage-shield]
|
||||
|
||||
![Supports aarch64 Architecture][aarch64-shield]
|
||||
![Supports amd64 Architecture][amd64-shield]
|
||||
|
||||
Join your Home Assistant instance to a Netmaker WireGuard network.
|
||||
|
||||
## About
|
||||
|
||||
[Netmaker][netmaker] is a platform for creating and managing fast, secure
|
||||
WireGuard networks. This app joins your Home Assistant instance to a Netmaker
|
||||
network using the Netmaker client, `netclient`.
|
||||
|
||||
You provide an enrollment token generated in your Netmaker dashboard, and the
|
||||
app registers your device and keeps the connection running in the background.
|
||||
The host's WireGuard identity is persisted to the app's `/data` volume, so your
|
||||
device remains the same node across restarts and updates.
|
||||
|
||||
## Installation
|
||||
|
||||
The installation of this app is straightforward and not different in comparison
|
||||
to installing any other Home Assistant app.
|
||||
|
||||
1. Install this app.
|
||||
1. Generate an enrollment token in your Netmaker dashboard (**Enrollment Keys**).
|
||||
1. Set the token in the app's `enrollment_token` configuration option.
|
||||
1. Start the "Netmaker" app.
|
||||
1. Check the logs of the app to confirm it joined the network.
|
||||
|
||||
See the [documentation][docs] for full configuration details.
|
||||
|
||||
## Support
|
||||
|
||||
This add-on is a community port and is not affiliated with Netmaker.
|
||||
|
||||
## License
|
||||
|
||||
MIT License — see [LICENSE.md](LICENSE.md).
|
||||
|
||||
[aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg
|
||||
[amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg
|
||||
[docs]: netmaker/DOCS.md
|
||||
[netmaker]: https://www.netmaker.io/
|
||||
[project-stage-shield]: https://img.shields.io/badge/project%20stage-experimental-yellow.svg
|
||||
Reference in New Issue
Block a user