Hexy Templates

NetBird Client

Connect your devices into a secure WireGuard®-based overlay network with SSO, MFA and granular access controls.

Not yet tested networking Based on TrueNAS app v1.1.52 (NetBird Client 0.80.0)
Project website TrueNAS app source Script on GitHub Report a problem
  1. 1
    Copy the script below
  2. 2
    In HexOS, open Apps, find NetBird Client and choose Custom Install
  3. 3
    Paste, then press Install — full guide with screenshots
netbird-client.json
Download 
1{
12  "version": 5,
23  "script": {
4    "version": "0.1.0",
5    "changeLog": "Auto-generated draft from TrueNAS netbird-client 1.1.52"
6  },
37  "installation_questions": [
8    {
9      "question": "Setup key",
10      "type": "password",
11      "key": "setup_key",
12      "required": true
13    }
14  ],
15  "requirements": {
416    "locations": ["ApplicationsPerformance"],
517    "specifications": ["2CORE"],
618    "permissions": ["READ_WRITE_LOCATIONS"]
19  },
720  "ensure_directories_exists": [
21    {"path": "$LOCATION(ApplicationsPerformance)"},
22    {"path": "$LOCATION(ApplicationsPerformance)/netbird-client"},
23    {
24      "path": "$LOCATION(ApplicationsPerformance)/netbird-client/state",
25      "snapshot": {"id": "state"}
26    }
27  ],
28  "app_values": {
829    "netbird": {"setup_key": "$QUESTION(setup_key)"},
30    "storage": {
931      "state": "$HOST_PATH($LOCATION(ApplicationsPerformance)/netbird-client/state)"
32    },
1033    "resources": {"limits": {"cpus": 2, "memory": "$MEMORY(10%, 4096)"}}
34  }
35}

What this script does

Hover or tap a box to see the lines it explains.

  1. Script format

    Tells HexOS this is a version 5 install script, so it knows how to read the rest.

    Line 2

  2. Script revision

    This copy of the script is revision 0.1.0. Latest change: “Auto-generated draft from TrueNAS netbird-client 1.1.52”.

    Lines 3–6

  3. Questions you'll be asked

    Before installing, HexOS will ask you for: Setup key. Your answers are slotted into the settings further down wherever you see $QUESTION(...).

    Lines 7–14

  4. Storage locations it needs

    The app uses these HexOS storage locations: App storage (fast). If one isn't set up yet, HexOS will ask you to pick a place for it.

    Line 16

  5. Minimum hardware

    Recommended minimum: 2 CPU cores.

    Line 17

  6. Permission to use your folders

    Allows the app to read and write files inside the storage locations listed above — and nowhere else.

    Line 18

  7. Folders created on install

    Creates the folders the app needs before it starts: App storage (fast) › netbird-client and App storage (fast) › netbird-client › state. Folders marked “snapshot” are included in HexOS snapshots, so you can roll them back.

    Lines 20–27

  8. Your answer: setup key

    Filled in with what you typed for “setup key” when you installed.

    Line 29

  9. Where the app's “state” files is saved

    Where the app's “state” files is saved on your server: App storage (fast) › netbird-client › state.

    Line 31

  10. Resource limits

    Caps how much of your server the app can use: 2 CPU cores and 10% of your server's memory, but never more than 4 GB. This keeps one busy app from slowing everything else down.

    Line 33