Hexy Templates

Restic REST Server

Rest Server is a high performance HTTP server that implements restic's REST backend API.

Not yet tested backup Based on TrueNAS app v1.1.11 (Restic REST Server 0.14.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 Restic REST Server and choose Custom Install
  3. 3
    Paste, then press Install — full guide with screenshots
restic-rest-server.json
Download 
1{
12  "version": 5,
23  "script": {
4    "version": "0.1.0",
5    "changeLog": "Auto-generated draft from TrueNAS restic-rest-server 1.1.6"
6  },
7  "requirements": {
38    "locations": ["ApplicationsPerformance"],
49    "specifications": ["2CORE"],
510    "permissions": ["READ_WRITE_LOCATIONS"],
611    "ports": [30248]
12  },
713  "ensure_directories_exists": [
14    {"path": "$LOCATION(ApplicationsPerformance)"},
15    {"path": "$LOCATION(ApplicationsPerformance)/restic-rest-server"},
16    {
17      "path": "$LOCATION(ApplicationsPerformance)/restic-rest-server/data",
18      "owner": {"user": "apps"},
19      "snapshot": {"id": "data"}
20    }
21  ],
22  "app_values": {
23    "storage": {
824      "data": "$HOST_PATH($LOCATION(ApplicationsPerformance)/restic-rest-server/data)"
25    },
26    "network": {
927      "web_port": {"bind_mode": "published", "port_number": 30248}
28    },
1029    "resources": {"limits": {"cpus": 2, "memory": "$MEMORY(10%, 4096)"}}
30  }
31}

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 restic-rest-server 1.1.6”.

    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 30248 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) › restic-rest-server and App storage (fast) › restic-rest-server › data. 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–21

  8. Where the app's main data is saved

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

    Line 24

  9. Web port: 30248

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

    Line 27

  10. 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 29