Hexy Templates

UrBackup

UrBackup is an easy to setup Open Source client/server backup system, that through a combination of image and file backups accomplishes both data safety and a fast restoration time.

Not yet tested backup Based on TrueNAS app v1.1.7 (UrBackup 2.5.x)
Project website TrueNAS app source Script on GitHub Report a problem
  1. 1
    Copy the script below
  2. 2
    In HexOS, open Apps, find UrBackup and choose Custom Install
  3. 3
    Paste, then press Install — full guide with screenshots
urbackup.json
Download 
1{
12  "version": 5,
23  "script": {
4    "version": "0.1.0",
5    "changeLog": "Auto-generated draft from TrueNAS urbackup 1.1.7"
6  },
7  "requirements": {
38    "locations": ["ApplicationsCapacity", "ApplicationsPerformance"],
49    "specifications": ["2CORE"],
510    "permissions": ["READ_WRITE_LOCATIONS"],
611    "ports": [55414, 55413, 55415, 35623]
12  },
713  "ensure_directories_exists": [
14    {"path": "$LOCATION(ApplicationsCapacity)"},
15    {"path": "$LOCATION(ApplicationsCapacity)/urbackup"},
16    {"path": "$LOCATION(ApplicationsPerformance)"},
17    {"path": "$LOCATION(ApplicationsPerformance)/urbackup"},
18    {"path": "$LOCATION(ApplicationsCapacity)/urbackup/backups"},
19    {
20      "path": "$LOCATION(ApplicationsPerformance)/urbackup/database",
21      "owner": {"user": "netdata", "group": "docker"},
22      "snapshot": {"id": "database"}
23    },
24    {"path": "$LOCATION(ApplicationsCapacity)/urbackup/logs"}
25  ],
26  "app_values": {
27    "storage": {
828      "backups": "$HOST_PATH($LOCATION(ApplicationsCapacity)/urbackup/backups)",
929      "database": "$HOST_PATH($LOCATION(ApplicationsPerformance)/urbackup/database)",
1030      "logs": "$HOST_PATH($LOCATION(ApplicationsCapacity)/urbackup/logs)"
31    },
32    "network": {
1133      "web_port": {"bind_mode": "published", "port_number": 55414},
1234      "backup_port_1": {"bind_mode": "published", "port_number": 55413},
1335      "backup_port_2": {"bind_mode": "published", "port_number": 55415},
1436      "backup_port_3": {"bind_mode": "published", "port_number": 35623}
37    },
1538    "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 urbackup 1.1.7”.

    Lines 3–6

  3. Storage locations it needs

    The app uses these HexOS storage locations: App storage (large) and 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 55414, 55413, 55415 and 35623 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 (large) › urbackup, App storage (fast) › urbackup, App storage (large) › urbackup › backups, App storage (fast) › urbackup › database and App storage (large) › urbackup › logs. Some folders are handed to a specific system user so the app is allowed to write to them. Folders marked “snapshot” are included in HexOS snapshots, so you can roll them back.

    Lines 13–25

  8. Where backups the app makes is saved

    Where backups the app makes is saved on your server: App storage (large) › urbackup › backups.

    Line 28

  9. Where the app's database is saved

    Where the app's database is saved on your server: App storage (fast) › urbackup › database.

    Line 29

  10. Where the app's log files is saved

    Where the app's log files is saved on your server: App storage (large) › urbackup › logs.

    Line 30

  11. Web port: 55414

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

    Line 33

  12. Backup 1 port: 55413

    Publishes the app's backup 1 port as 55413.

    Line 34

  13. Backup 2 port: 55415

    Publishes the app's backup 2 port as 55415.

    Line 35

  14. Backup 3 port: 35623

    Publishes the app's backup 3 port as 35623.

    Line 36

  15. 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