Hexy Templates

NetBird Server

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.0.54 (NetBird Server 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 Server and choose Custom Install
  3. 3
    Paste, then press Install — full guide with screenshots
netbird-server.json
Download 
1{
12  "version": 5,
23  "script": {
4    "version": "0.1.0",
5    "changeLog": "Auto-generated draft from TrueNAS netbird-server 1.0.54"
6  },
37  "installation_questions": [
8    {
9      "question": "Netbird address",
10      "type": "text",
11      "key": "netbird_address",
12      "required": true
13    }
14  ],
15  "requirements": {
416    "locations": ["ApplicationsPerformance"],
517    "specifications": ["2CORE"],
618    "permissions": ["READ_WRITE_LOCATIONS"],
719    "ports": [30415, 30416, 30417]
20  },
821  "ensure_directories_exists": [
22    {"path": "$LOCATION(ApplicationsPerformance)"},
23    {"path": "$LOCATION(ApplicationsPerformance)/netbird-server"},
24    {
25      "path": "$LOCATION(ApplicationsPerformance)/netbird-server/data",
26      "snapshot": {"id": "data"}
27    },
28    {
29      "path": "$LOCATION(ApplicationsPerformance)/netbird-server/config",
30      "snapshot": {"id": "config"}
31    }
32  ],
33  "app_values": {
34    "netbird": {
935      "netbird_address": "$QUESTION(netbird_address)",
1036      "store_encryption_key": "$RANDOM_STRING(32)",
1137      "auth_secret": "$RANDOM_STRING(32)"
38    },
39    "storage": {
1240      "data": "$HOST_PATH($LOCATION(ApplicationsPerformance)/netbird-server/data)",
1341      "config": "$HOST_PATH($LOCATION(ApplicationsPerformance)/netbird-server/config)"
42    },
43    "network": {
1444      "web_port": {"bind_mode": "published", "port_number": 30415},
1545      "mgmt_port": {"bind_mode": "published", "port_number": 30416},
1646      "stun_port": {"bind_mode": "published", "port_number": 30417}
47    },
1748    "resources": {"limits": {"cpus": 2, "memory": "$MEMORY(10%, 4096)"}}
49  }
50}

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-server 1.0.54”.

    Lines 3–6

  3. Questions you'll be asked

    Before installing, HexOS will ask you for: Netbird address. 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. Network ports

    The app needs ports 30415, 30416 and 30417 to be free on your server. A port is like an apartment number for your server's address.

    Line 19

  8. Folders created on install

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

    Lines 21–32

  9. Your answer: netbird address

    Filled in with what you typed for “netbird address” when you installed.

    Line 35

  10. Auto-generated store encryption key

    HexOS makes up a long random store encryption key during install. It's only used inside NetBird Server, so you never need to know it.

    Line 36

  11. Auto-generated auth secret

    HexOS makes up a long random auth secret during install. It's only used inside NetBird Server, so you never need to know it.

    Line 37

  12. Where the app's main data is saved

    Where the app's main data is saved on your server: App storage (fast) › netbird-server › data.

    Line 40

  13. Where the app's settings is saved

    Where the app's settings is saved on your server: App storage (fast) › netbird-server › config.

    Line 41

  14. Web port: 30415

    The app's web page is published on port 30415. You don't need to remember it — clicking the app's card in HexOS takes you there.

    Line 44

  15. Mgmt port: 30416

    Publishes the app's mgmt port as 30416.

    Line 45

  16. Stun port: 30417

    Publishes the app's stun port as 30417.

    Line 46

  17. 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 48