Hexy Templates

BorgWarehouse

A fast and modern WebUI for a BorgBackup's central repository server.

Not yet tested backup Based on TrueNAS app v1.1.17 (BorgWarehouse v3.6.3)
Project website TrueNAS app source Script on GitHub Report a problem
  1. 1
    Copy the script below
  2. 2
    In HexOS, open Apps, find BorgWarehouse and choose Custom Install
  3. 3
    Paste, then press Install — full guide with screenshots
borgwarehouse.json
Download 
1{
12  "version": 5,
23  "script": {
4    "version": "0.1.0",
5    "changeLog": "Auto-generated draft from TrueNAS borgwarehouse 1.1.17"
6  },
7  "requirements": {
38    "locations": ["ApplicationsPerformance", "ApplicationsCapacity"],
49    "specifications": ["2CORE"],
510    "permissions": ["READ_WRITE_LOCATIONS"],
611    "ports": [30406, 30407]
12  },
713  "ensure_directories_exists": [
14    {"path": "$LOCATION(ApplicationsPerformance)"},
15    {"path": "$LOCATION(ApplicationsPerformance)/borgwarehouse"},
16    {"path": "$LOCATION(ApplicationsCapacity)"},
17    {"path": "$LOCATION(ApplicationsCapacity)/borgwarehouse"},
18    {
19      "path": "$LOCATION(ApplicationsPerformance)/borgwarehouse/config",
20      "snapshot": {"id": "config"}
21    },
22    {
23      "path": "$LOCATION(ApplicationsPerformance)/borgwarehouse/ssh",
24      "snapshot": {"id": "ssh"}
25    },
26    {
27      "path": "$LOCATION(ApplicationsPerformance)/borgwarehouse/ssh_host",
28      "snapshot": {"id": "ssh_host"}
29    },
30    {
31      "path": "$LOCATION(ApplicationsPerformance)/borgwarehouse/borg_repository",
32      "snapshot": {"id": "borg_repository"}
33    },
34    {"path": "$LOCATION(ApplicationsCapacity)/borgwarehouse/logs"},
35    {"path": "$LOCATION(ApplicationsCapacity)/borgwarehouse/tmp"}
36  ],
37  "app_values": {
38    "storage": {
839      "config": "$HOST_PATH($LOCATION(ApplicationsPerformance)/borgwarehouse/config)",
940      "ssh": "$HOST_PATH($LOCATION(ApplicationsPerformance)/borgwarehouse/ssh)",
1041      "ssh_host": "$HOST_PATH($LOCATION(ApplicationsPerformance)/borgwarehouse/ssh_host)",
1142      "borg_repository": "$HOST_PATH($LOCATION(ApplicationsPerformance)/borgwarehouse/borg_repository)",
1243      "logs": "$HOST_PATH($LOCATION(ApplicationsCapacity)/borgwarehouse/logs)",
1344      "tmp": "$HOST_PATH($LOCATION(ApplicationsCapacity)/borgwarehouse/tmp)"
45    },
46    "network": {
1447      "web_port": {"bind_mode": "published", "port_number": 30406},
1548      "ssh_port": {"bind_mode": "published", "port_number": 30407}
49    },
1650    "resources": {"limits": {"cpus": 2, "memory": "$MEMORY(10%, 4096)"}}
51  }
52}

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 borgwarehouse 1.1.17”.

    Lines 3–6

  3. Storage locations it needs

    The app uses these HexOS storage locations: App storage (fast) and App storage (large). 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 30406 and 30407 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) › borgwarehouse, App storage (large) › borgwarehouse, App storage (fast) › borgwarehouse › config, App storage (fast) › borgwarehouse › ssh, App storage (fast) › borgwarehouse › ssh_host, App storage (fast) › borgwarehouse › borg_repository, App storage (large) › borgwarehouse › logs and App storage (large) › borgwarehouse › tmp. Folders marked “snapshot” are included in HexOS snapshots, so you can roll them back.

    Lines 13–36

  8. Where the app's settings is saved

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

    Line 39

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

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

    Line 40

  10. Where the app's “ssh host” files is saved

    Where the app's “ssh host” files is saved on your server: App storage (fast) › borgwarehouse › ssh_host.

    Line 41

  11. Where the app's “borg repository” files is saved

    Where the app's “borg repository” files is saved on your server: App storage (fast) › borgwarehouse › borg_repository.

    Line 42

  12. Where the app's log files is saved

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

    Line 43

  13. Where the app's “tmp” files is saved

    Where the app's “tmp” files is saved on your server: App storage (large) › borgwarehouse › tmp.

    Line 44

  14. Web port: 30406

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

    Line 47

  15. Ssh port: 30407

    Publishes the app's ssh port as 30407.

    Line 48

  16. 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 50