Netbird Client
Netbird Client
Get Started with Apps!
Get Started with Apps!
App Version:
0.64.5
(Changelog)
Keywords: vpn, netbird, wireguard
Train: Community
Home Page: https://netbird.io/
Keywords: vpn, netbird, wireguard
Train: Community
Home Page: https://netbird.io/
Netbird Client Details
Added: 2025-01-27
Last Updated: 2026-02-03
Added: 2025-01-27
Last Updated: 2026-02-03
Connect your devices into a secure WireGuard®-based overlay network with SSO, MFA and granular access controls.
Run as Context- Container [netbird-client] runs as root user and group.
Group: 0 / Host group is [root]
User: 0 / Host user is [root]
×
![Full Screenshot]()
Security Capabilities
- Netbird Client is able to perform network administration tasks
- Netbird Client is able to use raw and packet sockets
- Netbird Client is able to perform system administration operations
- Netbird Client is able to override resource limits
App Metadata (Raw File)
{
"1.0.7": {
"healthy": true,
"supported": true,
"healthy_error": null,
"location": "/__w/apps/apps/trains/community/netbird-client/1.0.7",
"last_update": "2026-02-03 19:25:00",
"required_features": [],
"human_version": "0.64.5_1.0.7",
"version": "1.0.7",
"app_metadata": {
"app_version": "0.64.5",
"capabilities": [
{
"description": "Netbird Client is able to perform network administration tasks",
"name": "NET_ADMIN"
},
{
"description": "Netbird Client is able to use raw and packet sockets",
"name": "NET_RAW"
},
{
"description": "Netbird Client is able to perform system administration operations",
"name": "SYS_ADMIN"
},
{
"description": "Netbird Client is able to override resource limits",
"name": "SYS_RESOURCE"
}
],
"categories": [
"networking"
],
"changelog_url": "https://github.com/netbirdio/netbird/releases",
"date_added": "2025-01-27",
"description": "Connect your devices into a secure WireGuard\u00ae-based overlay network with SSO, MFA and granular access controls.",
"home": "https://netbird.io/",
"host_mounts": [],
"icon": "https://media.sys.truenas.net/apps/netbird-client/icons/icon.svg",
"keywords": [
"vpn",
"netbird",
"wireguard"
],
"lib_version": "2.1.77",
"lib_version_hash": "1837f8e69ae1adc313330c3b1c2615e9b4d03c5459d657a5898bae78090f8195",
"maintainers": [
{
"email": "dev@truenas.com",
"name": "truenas",
"url": "https://www.truenas.com/"
}
],
"name": "netbird-client",
"run_as_context": [
{
"description": "Container [netbird-client] runs as root user and group.",
"gid": 0,
"group_name": "Host group is [root]",
"uid": 0,
"user_name": "Host user is [root]"
}
],
"screenshots": [],
"sources": [
"https://netbird.io/"
],
"title": "Netbird Client",
"train": "community",
"version": "1.0.7"
},
"schema": {
"groups": [
{
"name": "Netbird Client Configuration",
"description": "Configure Netbird Client"
},
{
"name": "Network Configuration",
"description": "Configure Network for Netbird Client"
},
{
"name": "Storage Configuration",
"description": "Configure Storage for Netbird Client"
},
{
"name": "Labels Configuration",
"description": "Configure Labels for Netbird Client"
},
{
"name": "Resources Configuration",
"description": "Configure Resources for Netbird Client"
}
],
"questions": [
{
"variable": "TZ",
"label": "Timezone",
"description": "Timezone",
"group": "Netbird Client Configuration",
"schema": {
"type": "string",
"default": "Etc/UTC",
"$ref": [
"definitions/timezone"
]
}
},
{
"variable": "netbird",
"label": "",
"group": "Netbird Client Configuration",
"schema": {
"type": "dict",
"attrs": [
{
"variable": "hostname",
"label": "Hostname",
"description": "The hostname for Netbird Client Node.</br>\nOnly lowercase letters, numbers, and hyphens are allowed.\n",
"schema": {
"type": "string",
"default": "truenas-scale",
"valid_chars": "^[a-z0-9-]+$",
"valid_chars_error": "Only lowercase letters, numbers, and hyphens are allowed.\n",
"required": true
}
},
{
"variable": "setup_key",
"label": "Setup Key",
"description": "The setup key for Netbird Client Node.</br>\nSee https://docs.netbird.io/manage/peers/register-machines-using-setup-keys for more information.\n",
"schema": {
"type": "string",
"default": "",
"required": true,
"private": true
}
},
{
"variable": "userspace",
"label": "Userspace",
"description": "Run Netbird Client in userspace.",
"schema": {
"type": "boolean",
"default": false
}
},
{
"variable": "management_url",
"label": "Management URL (Optional)",
"description": "The management URL for Netbird Client Node.</br>\nOnly needed if you use a self-hosted Netbird management server.\n",
"schema": {
"type": "string",
"default": ""
}
},
{
"variable": "additional_envs",
"label": "Additional Environment Variables",
"schema": {
"type": "list",
"default": [],
"items": [
{
"variable": "env",
"label": "Environment Variable",
"schema": {
"type": "dict",
"attrs": [
{
"variable": "name",
"label": "Name",
"schema": {
"type": "string",
"required": true
}
},
{
"variable": "value",
"label": "Value",
"schema": {
"type": "string"
}
}
]
}
}
]
}
}
]
}
},
{
"variable": "network",
"label": "",
"group": "Network Configuration",
"schema": {
"type": "dict",
"attrs": [
{
"variable": "host_network",
"label": "Host Network",
"description": "Bind to the host network.</br>\nNeeded in most cases in order to communicate with the host.\n",
"schema": {
"type": "boolean",
"default": true
}
}
]
}
},
{
"variable": "storage",
"label": "",
"group": "Storage Configuration",
"schema": {
"type": "dict",
"attrs": [
{
"variable": "state",
"label": "State Storage",
"schema": {
"type": "dict",
"attrs": [
{
"variable": "type",
"label": "Type",
"description": "ixVolume: Is dataset created automatically by the system.</br>\nHost Path: Is a path that already exists on the system.\n",
"schema": {
"type": "string",
"required": true,
"default": "ix_volume",
"enum": [
{
"value": "host_path",
"description": "Host Path (Path that already exists on the system)"
},
{
"value": "ix_volume",
"description": "ixVolume (Dataset created automatically by the system)"
}
]
}
},
{
"variable": "ix_volume_config",
"label": "ixVolume Configuration",
"description": "The configuration for the ixVolume dataset.",
"schema": {
"type": "dict",
"show_if": [
[
"type",
"=",
"ix_volume"
]
],
"$ref": [
"normalize/ix_volume"
],
"attrs": [
{
"variable": "acl_enable",
"label": "Enable ACL",
"description": "Enable ACL for the storage.",
"schema": {
"type": "boolean",
"default": false
}
},
{
"variable": "dataset_name",
"label": "Dataset Name",
"description": "The name of the dataset to use for storage.",
"schema": {
"type": "string",
"required": true,
"hidden": true,
"default": "state"
}
},
{
"variable": "acl_entries",
"label": "ACL Configuration",
"schema": {
"type": "dict",
"show_if": [
[
"acl_enable",
"=",
true
]
],
"attrs": []
}
}
]
}
},
{
"variable": "host_path_config",
"label": "Host Path Configuration",
"schema": {
"type": "dict",
"show_if": [
[
"type",
"=",
"host_path"
]
],
"attrs": [
{
"variable": "acl_enable",
"label": "Enable ACL",
"description": "Enable ACL for the storage.",
"schema": {
"type": "boolean",
"default": false
}
},
{
"variable": "acl",
"label": "ACL Configuration",
"schema": {
"type": "dict",
"show_if": [
[
"acl_enable",
"=",
true
]
],
"attrs": [],
"$ref": [
"normalize/acl"
]
}
},
{
"variable": "path",
"label": "Host Path",
"description": "The host path to use for storage.",
"schema": {
"type": "hostpath",
"show_if": [
[
"acl_enable",
"=",
false
]
],
"required": true
}
}
]
}
}
]
}
},
{
"variable": "additional_storage",
"label": "Additional Storage",
"schema": {
"type": "list",
"default": [],
"items": [
{
"variable": "storageEntry",
"label": "Storage Entry",
"schema": {
"type": "dict",
"attrs": [
{
"variable": "type",
"label": "Type",
"description": "ixVolume: Is dataset created automatically by the system.</br>\nHost Path: Is a path that already exists on the system.</br>\nSMB Share: Is a SMB share that is mounted to as a volume.</br>\nNFS Share: Is a NFS share that is mounted to as a volume.\n",
"schema": {
"type": "string",
"required": true,
"default": "ix_volume",
"enum": [
{
"value": "host_path",
"description": "Host Path (Path that already exists on the system)"
},
{
"value": "ix_volume",
"description": "ixVolume (Dataset created automatically by the system)"
},
{
"value": "cifs",
"description": "SMB/CIFS Share (Mounts a volume to a SMB share)"
},
{
"value": "nfs",
"description": "NFS Share (Mounts a volume to a NFS share)"
}
]
}
},
{
"variable": "read_only",
"label": "Read Only",
"description": "Mount the volume as read only.",
"schema": {
"type": "boolean",
"default": false
}
},
{
"variable": "mount_path",
"label": "Mount Path",
"description": "The path inside the container to mount the storage.",
"schema": {
"type": "path",
"required": true
}
},
{
"variable": "host_path_config",
"label": "Host Path Configuration",
"schema": {
"type": "dict",
"show_if": [
[
"type",
"=",
"host_path"
]
],
"attrs": [
{
"variable": "acl_enable",
"label": "Enable ACL",
"description": "Enable ACL for the storage.",
"schema": {
"type": "boolean",
"default": false
}
},
{
"variable": "acl",
"label": "ACL Configuration",
"schema": {
"type": "dict",
"show_if": [
[
"acl_enable",
"=",
true
]
],
"attrs": [],
"$ref": [
"normalize/acl"
]
}
},
{
"variable": "path",
"label": "Host Path",
"description": "The host path to use for storage.",
"schema": {
"type": "hostpath",
"show_if": [
[
"acl_enable",
"=",
false
]
],
"required": true
}
}
]
}
},
{
"variable": "ix_volume_config",
"label": "ixVolume Configuration",
"description": "The configuration for the ixVolume dataset.",
"schema": {
"type": "dict",
"show_if": [
[
"type",
"=",
"ix_volume"
]
],
"$ref": [
"normalize/ix_volume"
],
"attrs": [
{
"variable": "acl_enable",
"label": "Enable ACL",
"description": "Enable ACL for the storage.",
"schema": {
"type": "boolean",
"default": false
}
},
{
"variable": "dataset_name",
"label": "Dataset Name",
"description": "The name of the dataset to use for storage.",
"schema": {
"type": "string",
"required": true,
"default": "storage_entry"
}
},
{
"variable": "acl_entries",
"label": "ACL Configuration",
"schema": {
"type": "dict",
"show_if": [
[
"acl_enable",
"=",
true
]
],
"attrs": []
}
}
]
}
},
{
"variable": "cifs_config",
"label": "SMB Configuration",
"description": "The configuration for the SMB dataset.",
"schema": {
"type": "dict",
"show_if": [
[
"type",
"=",
"cifs"
]
],
"attrs": [
{
"variable": "server",
"label": "Server",
"description": "The server to mount the SMB share.",
"schema": {
"type": "string",
"required": true
}
},
{
"variable": "path",
"label": "Path",
"description": "The path to mount the SMB share.",
"schema": {
"type": "string",
"required": true
}
},
{
"variable": "username",
"label": "Username",
"description": "The username to use for the SMB share.",
"schema": {
"type": "string",
"required": true
}
},
{
"variable": "password",
"label": "Password",
"description": "The password to use for the SMB share.",
"schema": {
"type": "string",
"required": true,
"private": true
}
},
{
"variable": "domain",
"label": "Domain",
"description": "The domain to use for the SMB share.",
"schema": {
"type": "string"
}
}
]
}
},
{
"variable": "nfs_config",
"label": "NFS Configuration",
"description": "The configuration for the NFS dataset.",
"schema": {
"type": "dict",
"show_if": [
[
"type",
"=",
"nfs"
]
],
"attrs": [
{
"variable": "server",
"label": "Server",
"description": "The server to mount the NFS share.",
"schema": {
"type": "string",
"required": true
}
},
{
"variable": "path",
"label": "Path",
"description": "The path to mount the NFS share.",
"schema": {
"type": "string",
"required": true
}
}
]
}
}
]
}
}
]
}
}
]
}
},
{
"variable": "labels",
"label": "",
"group": "Labels Configuration",
"schema": {
"type": "list",
"default": [],
"items": [
{
"variable": "label",
"label": "Label",
"schema": {
"type": "dict",
"attrs": [
{
"variable": "key",
"label": "Key",
"schema": {
"type": "string",
"required": true
}
},
{
"variable": "value",
"label": "Value",
"schema": {
"type": "string",
"required": true
}
},
{
"variable": "containers",
"label": "Containers",
"description": "Containers where the label should be applied",
"schema": {
"type": "list",
"items": [
{
"variable": "container",
"label": "Container",
"schema": {
"type": "string",
"required": true,
"enum": [
{
"value": "netbird-client",
"description": "netbird-client"
}
]
}
}
]
}
}
]
}
}
]
}
},
{
"variable": "resources",
"label": "",
"group": "Resources Configuration",
"schema": {
"type": "dict",
"attrs": [
{
"variable": "limits",
"label": "Limits",
"schema": {
"type": "dict",
"attrs": [
{
"variable": "cpus",
"label": "CPUs",
"description": "CPUs limit for Netbird Client.",
"schema": {
"type": "int",
"default": 2,
"required": true
}
},
{
"variable": "memory",
"label": "Memory (in MB)",
"description": "Memory limit for Netbird Client.",
"schema": {
"type": "int",
"default": 4096,
"required": true
}
}
]
}
}
]
}
}
]
},
"readme": "<h1>Netbird Client</h1> <p><a href=\"https://netbird.io/\">Netbird Client</a> - Connect your devices into a secure WireGuard\u00ae-based overlay network with SSO, MFA and granular access controls.</p>",
"changelog": null,
"chart_metadata": {
"app_version": "0.64.5",
"capabilities": [
{
"description": "Netbird Client is able to perform network administration tasks",
"name": "NET_ADMIN"
},
{
"description": "Netbird Client is able to use raw and packet sockets",
"name": "NET_RAW"
},
{
"description": "Netbird Client is able to perform system administration operations",
"name": "SYS_ADMIN"
},
{
"description": "Netbird Client is able to override resource limits",
"name": "SYS_RESOURCE"
}
],
"categories": [
"networking"
],
"changelog_url": "https://github.com/netbirdio/netbird/releases",
"date_added": "2025-01-27",
"description": "Connect your devices into a secure WireGuard\u00ae-based overlay network with SSO, MFA and granular access controls.",
"home": "https://netbird.io/",
"host_mounts": [],
"icon": "https://media.sys.truenas.net/apps/netbird-client/icons/icon.svg",
"keywords": [
"vpn",
"netbird",
"wireguard"
],
"lib_version": "2.1.77",
"lib_version_hash": "1837f8e69ae1adc313330c3b1c2615e9b4d03c5459d657a5898bae78090f8195",
"maintainers": [
{
"email": "dev@truenas.com",
"name": "truenas",
"url": "https://www.truenas.com/"
}
],
"name": "netbird-client",
"run_as_context": [
{
"description": "Container [netbird-client] runs as root user and group.",
"gid": 0,
"group_name": "Host group is [root]",
"uid": 0,
"user_name": "Host user is [root]"
}
],
"screenshots": [],
"sources": [
"https://netbird.io/"
],
"title": "Netbird Client",
"train": "community",
"version": "1.0.7"
}
}
}Support, maintenance, and documentation for applications within the Community catalog is handled by the TrueNAS community. The TrueNAS Applications Market hosts but does not validate or maintain any linked resources associated with this app.
There currently aren’t any resources available for this application!
Please help the TrueNAS community add resources here or discuss this application in the TrueNAS Community forum.