Skip to content

Latest commit

 

History

History
156 lines (108 loc) · 6.83 KB

DOCS.md

File metadata and controls

156 lines (108 loc) · 6.83 KB
Raw

Home Assistant Community Add-on: NetBird

NetBird is an open-source VPN management platform built on top of WireGuard® making it easy to create secure private networks for your organization or home.

It requires zero configuration effort leaving behind the hassle of opening ports, complex firewall rules, VPN gateways, and so forth.

NetBird uses NAT traversal techniques to automatically create an overlay peer-to-peer network connecting machines regardless of location (home, office, data center, container, cloud, or edge environments and now HASSIO with this add-on), unifying virtual private network management experience.

Installation

The installation of this add-on is pretty straightforward and not different in comparison to installing any other Home Assistant add-on.

  1. Add my Hass.io add-ons repository (https://github.com/netbirdio/addon-netbird) to your Hass.io instance.

  2. Click the Home Assistant My button below to open the add-on on your Home Assistant instance.

    Open this add-on in your Home Assistant instance.

  3. Install the "NetBird" add-on.

  4. If you are using the central NetBird instance you can either use the URL generated in the log or you can use a setup_key. If hosting your own then you'll want to set admin_url & management_url and again only need to set up the setup_key if you don't want to login via the log generated URL.

  5. If you would like to change the auto generated hostname (which is the docker container id in case of hassio) set the hostname.

  6. Start the "NetBird" add-on.

  7. Feels free to check the logs for NetBird to make sure its booted correctly.

  8. This client will show up in your NetBird dashboard.

Configuration

You'll see the config file at /config/netbird/config.json after first boot.

Option: log_level

The log_level option controls the level of log output by the addon and can be changed to be more or less verbose, which might be useful when you are dealing with an unknown issue. Possible values are:

  • trace: Show every detail, like all called internal functions.
  • debug: Shows detailed debug information.
  • info: Normal (usually) interesting events.
  • notice: Normal but significant events.
  • warning: Exceptional occurrences that are not errors.
  • error: Runtime errors that do not require immediate action.
  • fatal: Something went terribly wrong. Add-on becomes unusable.

Please note that each level automatically includes log messages from a more severe level, e.g., debug also shows info messages. By default, the log_level is set to info, which is the recommended setting unless you are troubleshooting.

Option: admin_url

Admin Panel URL [http|https]://[host]:[port] (default "https://app.netbird.io")

Tells NetBird the URL through which you administrate your NetBird clients. You'll find that the log generates a login URL you can use instead of configuring a setup_key. (If you're not already connected to a NetBird instance.)

Option: management_url

Management Service URL [http|https]://[host]:[port] (default "https://api.wiretrustee.com:33073")

The client will use this URL to communicate with your NetBird instance api.

Option: setup_key

Setup key obtained from the Management Service Dashboard (used to register peer)

This token is like a password for connecting your client to NetBird, you can leave this option empty if you would prefer to login via a URL generated in the log with the admin_url.

Option: hostname

Hostname in the NetBird network (used to during registration)

This hostname will be used in the Peers to identify your machine.

Option: env_vars

Extra environment variables

Extra environment variables to pass to the NetBird client This is a list of environment variables that will be passed to the NetBird client. You can use this to configure the client further.

Changelog & Releases

This repository keeps a change log using GitHub's releases functionality.

Releases are based on Semantic Versioning, 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?

You have several options to get them answered:

You could also open an issue here GitHub.

Authors & contributors

The original setup of this repository was by Levente Farkas.

For a full list of all authors and contributors, check the contributor's page.

License

MIT License

Copyright (c) 2019-2022 Franck Nijhof Copyright (c) 2022-2023 Daniel Burgess Copyright (c) 2023-2023 Levente Farkas

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.