Hexy Templates

Rust Desk Relay

Rust Desk is an open-source remote desktop, and alternative to TeamViewer.

Not yet tested productivity Based on TrueNAS app v1.0.15 (Rust Desk Relay 1.1.16)
Project website TrueNAS app source Script on GitHub Report a problem
  1. 1
    Copy the script below
  2. 2
    In HexOS, open Apps, find Rust Desk Relay and choose Custom Install
  3. 3
    Paste, then press Install — full guide with screenshots
rust-desk-relay.json
Download 
1{
12  "version": 5,
23  "script": {
4    "version": "0.1.0",
5    "changeLog": "Auto-generated draft from TrueNAS rust-desk-relay 1.0.15"
6  },
7  "requirements": {
38    "locations": ["ApplicationsPerformance"],
49    "specifications": ["2CORE"],
510    "permissions": ["READ_WRITE_LOCATIONS"],
611    "ports": [21117, 21119]
12  },
713  "ensure_directories_exists": [
14    {"path": "$LOCATION(ApplicationsPerformance)"},
15    {"path": "$LOCATION(ApplicationsPerformance)/rust-desk-relay"},
16    {
17      "path": "$LOCATION(ApplicationsPerformance)/rust-desk-relay/data",
18      "owner": {"user": "apps"},
19      "snapshot": {"id": "data"}
20    }
21  ],
22  "app_values": {
23    "storage": {
824      "data": "$HOST_PATH($LOCATION(ApplicationsPerformance)/rust-desk-relay/data)"
25    },
26    "network": {
927      "relay_port": {"bind_mode": "published", "port_number": 21117},
1028      "relay_web_clients_port": {
29        "bind_mode": "published",
30        "port_number": 21119
31      }
32    },
1133    "resources": {"limits": {"cpus": 2, "memory": "$MEMORY(10%, 4096)"}}
34  }
35}

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 rust-desk-relay 1.0.15”.

    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 21117 and 21119 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) › rust-desk-relay and App storage (fast) › rust-desk-relay › 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) › rust-desk-relay › data.

    Line 24

  9. Relay port: 21117

    Publishes the app's relay port as 21117.

    Line 27

  10. Relay web clients port: 21119

    Publishes the app's relay web clients port as 21119.

    Lines 28–31

  11. 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 33