Hexy Templates

Netboot.xyz

netboot.xyz lets you PXE boot various operating system installers or utilities from a single tool over the network.

Not yet tested networking Based on TrueNAS app v1.3.9 (Netboot.xyz 0.7.6-nbxyz24)
Project website TrueNAS app source Script on GitHub Report a problem
  1. 1
    Copy the script below
  2. 2
    In HexOS, open Apps, find Netboot.xyz and choose Custom Install
  3. 3
    Paste, then press Install — full guide with screenshots
netbootxyz.json
Download 
1{
12  "version": 5,
23  "script": {
4    "version": "0.1.0",
5    "changeLog": "Auto-generated draft from TrueNAS netbootxyz 1.3.9"
6  },
7  "requirements": {
38    "locations": ["ApplicationsPerformance"],
49    "specifications": ["2CORE"],
510    "permissions": ["READ_WRITE_LOCATIONS"],
611    "ports": [31009, 31010, 31011]
12  },
713  "ensure_directories_exists": [
14    {"path": "$LOCATION(ApplicationsPerformance)"},
15    {"path": "$LOCATION(ApplicationsPerformance)/netbootxyz"},
16    {
17      "path": "$LOCATION(ApplicationsPerformance)/netbootxyz/config",
18      "snapshot": {"id": "config"}
19    },
20    {
21      "path": "$LOCATION(ApplicationsPerformance)/netbootxyz/assets",
22      "snapshot": {"id": "assets"}
23    }
24  ],
25  "app_values": {
26    "storage": {
827      "config": "$HOST_PATH($LOCATION(ApplicationsPerformance)/netbootxyz/config)",
928      "assets": "$HOST_PATH($LOCATION(ApplicationsPerformance)/netbootxyz/assets)"
29    },
30    "network": {
1031      "tftp_port": {"bind_mode": "published", "port_number": 31009},
1132      "web_http_port": {"bind_mode": "published", "port_number": 31010},
1233      "web_assets_port": {
34        "bind_mode": "published",
35        "port_number": 31011
36      }
37    },
1338    "resources": {"limits": {"cpus": 2, "memory": "$MEMORY(10%, 4096)"}}
39  }
40}

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 netbootxyz 1.3.9”.

    Lines 3–6

  3. 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 8

  4. Minimum hardware

    Recommended minimum: 2 CPU cores.

    Line 9

  5. Permission to use your folders

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

    Line 10

  6. Network ports

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

    Line 11

  7. Folders created on install

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

    Lines 13–24

  8. Where the app's settings is saved

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

    Line 27

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

    Where the app's “assets” files is saved on your server: App storage (fast) › netbootxyz › assets.

    Line 28

  10. Tftp port: 31009

    Publishes the app's tftp port as 31009.

    Line 31

  11. Web http port: 31010

    Publishes the app's web http port as 31010.

    Line 32

  12. Web assets port: 31011

    Publishes the app's web assets port as 31011.

    Lines 33–36

  13. 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 38