NetBird

WireGuard peer-to-peer overlay with management and signal servers and a relay fallback for blocked peers.

Provider: default
Kind: VPN gateway
Category: Edge
Official docs: https://docs.netbird.io/about-netbird/how-netbird-works

Properties · 5 set by this component

property	type	values	required	kind default	this component
activeActive	boolean	—	no	false	▸ false
bgp	boolean	—	no	false	▸ false
hosting · component property	enum	cloud \| self-hosted	no	cloud	inherited
idpIntegration · component property	boolean	—	no	false	inherited
managed	boolean	—	no	false	▸ true
peerType	enum	site-to-site \| point-to-site \| cloud-to-cloud	no	—	▸ point-to-site
relayFallback · component property	boolean	—	no	true	inherited
routingPeer · component property	boolean	—	no	false	inherited
throughputMbps	integer	—	no	—	inherited
tunnelType	enum	ipsec \| ssl \| wireguard	no	—	▸ wireguard

Rules that apply · 0

Every rule whose selector covers this component's kind or its category. Whether a rule fires depends on the design: its properties, its edges and its groups.

No rule reads this kind yet. That is a gap, not a guarantee.

Use it in a design

nodes:
  - { id: "netbird", component: "netbird" }

Other VPN gateway products · 18

VPN Gatewayalibaba-vpn-gatewayalibabacloudvpn-gateway AWS Client VPNaws-client-vpnawsvpn-gateway AWS Site-to-Site VPNaws-site-to-site-vpnawsvpn-gateway Azure VPN Gatewayazure-vpn-gatewayazurevpn-gateway OpenVPNopenvpnvpn-gateway strongSwanstrongswanvpn-gateway Submarinersubmarinervpn-gateway Tailscaletailscalevpn-gateway Generic VPN gatewayvpn-gatewayvpn-gateway WireGuardwireguardvpn-gateway ZeroTierzerotiervpn-gateway Cloud VPNgoogle-cloud-vpngcpvpn-gateway IBM Cloud VPN for VPCibm-vpn-gatewayibmvpn-gateway Client VPN for VPCibm-vpn-serveribmvpn-gateway Site-to-Site VPNoci-site-to-site-vpnocivpn-gateway Neutron VPNaaSopenstack-neutron-vpnaasopenstackvpn-gateway Client Gatewayoutscale-client-gatewayoutscalevpn-gateway Virtual Gatewayoutscale-virtual-gatewayoutscalevpn-gateway

Source

1# yaml-language-server: $schema=../../schema/component.schema.json
2# NetBird: WireGuard peer-to-peer overlay coordinated by management and signal servers
3# with a Coturn relay fallback for peers that cannot connect directly. "How NetBird works"
4# states the private key never leaves the machine, so relayed traffic stays encrypted.
5schemaVersion: "1"
6type: "component"
7id: "netbird"
8kind: "vpn-gateway"
9provider: "default"
10docs: "https://docs.netbird.io/about-netbird/how-netbird-works"
11defaults:
12  managed: true
13  tunnelType: "wireguard"
14  peerType: "point-to-site"
15  bgp: false
16  activeActive: false
17properties:
18  hosting:
19    type: "enum"
20    values: ["cloud", "self-hosted"]
21    default: "cloud"
22  relayFallback:
23    type: "boolean"
24    default: true
25  idpIntegration:
26    type: "boolean"
27    default: false
28  routingPeer:
29    type: "boolean"
30    default: false

The same page as markdown, for an agent: /catalogue/components/netbird.md