Hexy Templates

Zerobyte

Backup automation for self-hosters

Not yet tested storage Based on TrueNAS app v1.1.35 (Zerobyte v0.43.2)
Project website TrueNAS app source Script on GitHub Report a problem
  1. 1
    Copy the script below
  2. 2
    In HexOS, open Apps, find Zerobyte and choose Custom Install
  3. 3
    Paste, then press Install — full guide with screenshots
zerobyte.json
Download 
1{
12  "version": 5,
23  "script": {
4    "version": "0.1.0",
5    "changeLog": "Auto-generated draft from TrueNAS zerobyte 1.1.35"
6  },
7  "requirements": {
38    "locations": ["ApplicationsPerformance"],
49    "specifications": ["2CORE"],
510    "permissions": ["READ_WRITE_LOCATIONS"],
611    "ports": [30314]
12  },
713  "ensure_directories_exists": [
14    {"path": "$LOCATION(ApplicationsPerformance)"},
15    {"path": "$LOCATION(ApplicationsPerformance)/zerobyte"},
16    {
17      "path": "$LOCATION(ApplicationsPerformance)/zerobyte/config",
18      "snapshot": {"id": "config"}
19    }
20  ],
21  "app_values": {
22    "zerobyte": {
823      "base_url": "http://$SERVER_LAN_IP:30314",
924      "app_secret": "$RANDOM_STRING(32)"
25    },
26    "storage": {
1027      "config": "$HOST_PATH($LOCATION(ApplicationsPerformance)/zerobyte/config)"
28    },
29    "network": {
1130      "web_port": {"bind_mode": "published", "port_number": 30314}
31    },
1232    "resources": {"limits": {"cpus": 2, "memory": "$MEMORY(10%, 4096)"}}
33  }
34}

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 zerobyte 1.1.35”.

    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 port 30314 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) › zerobyte and App storage (fast) › zerobyte › config. Folders marked “snapshot” are included in HexOS snapshots, so you can roll them back.

    Lines 13–20

  8. Your server's address (base url)

    Automatically set to your server's address on your home network (http://your-server-ip:30314).

    Line 23

  9. Auto-generated app secret

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

    Line 24

  10. Where the app's settings is saved

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

    Line 27

  11. Web port: 30314

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

    Line 30

  12. 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 32