Hexy Templates

Tdarr Node

Tdarr Node is a Distributed Transcoding System

Not yet tested media Based on TrueNAS app v1.1.44 (Tdarr Node 2.94.01)
Project website TrueNAS app source Script on GitHub Report a problem
  1. 1
    Copy the script below
  2. 2
    In HexOS, open Apps, find Tdarr Node and choose Custom Install
  3. 3
    Paste, then press Install — full guide with screenshots
tdarr-node.json
Download 
1{
12  "version": 5,
23  "script": {
4    "version": "0.1.0",
5    "changeLog": "Auto-generated draft from TrueNAS tdarr-node 1.1.44"
6  },
37  "installation_questions": [
8    {
9      "question": "Server port",
10      "type": "number",
11      "key": "server_port",
12      "required": true
13    }
14  ],
15  "requirements": {
416    "locations": [
17      "ApplicationsPerformance",
18      "ApplicationsCapacity",
19      "Media"
20    ],
521    "specifications": ["2CORE"],
622    "permissions": ["READ_WRITE_LOCATIONS"]
23  },
724  "ensure_directories_exists": [
25    {"path": "$LOCATION(ApplicationsPerformance)"},
26    {"path": "$LOCATION(ApplicationsPerformance)/tdarr-node"},
27    {"path": "$LOCATION(ApplicationsCapacity)"},
28    {"path": "$LOCATION(ApplicationsCapacity)/tdarr-node"},
29    {"path": "$LOCATION(Media)", "network_share": true},
30    {
31      "path": "$LOCATION(ApplicationsPerformance)/tdarr-node/configs",
32      "snapshot": {"id": "configs"}
33    },
34    {"path": "$LOCATION(ApplicationsCapacity)/tdarr-node/logs"},
35    {"path": "$LOCATION(ApplicationsCapacity)/tdarr-node/transcodes"}
36  ],
37  "app_values": {
38    "tdarr": {
839      "server_ip": "$SERVER_LAN_IP",
940      "server_port": "$QUESTION(server_port)"
41    },
42    "storage": {
1043      "configs": "$HOST_PATH($LOCATION(ApplicationsPerformance)/tdarr-node/configs)",
1144      "logs": "$HOST_PATH($LOCATION(ApplicationsCapacity)/tdarr-node/logs)",
1245      "transcodes": "$HOST_PATH($LOCATION(ApplicationsCapacity)/tdarr-node/transcodes)",
1346      "additional_storage": [
47        "$MOUNTED_HOST_PATH($LOCATION(Media), /media)"
48      ]
49    },
50    "resources": {
1451      "limits": {"cpus": 2, "memory": "$MEMORY(10%, 4096)"},
1552      "gpus": "$GPU_CONFIG()"
53    }
54  }
55}

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 tdarr-node 1.1.44”.

    Lines 3–6

  3. Questions you'll be asked

    Before installing, HexOS will ask you for: Server port. Your answers are slotted into the settings further down wherever you see $QUESTION(...).

    Lines 7–14

  4. Storage locations it needs

    The app uses these HexOS storage locations: App storage (fast), App storage (large) and Media. If one isn't set up yet, HexOS will ask you to pick a place for it.

    Lines 16–20

  5. Minimum hardware

    Recommended minimum: 2 CPU cores.

    Line 21

  6. Permission to use your folders

    Allows the app to read and write files inside the storage locations listed above — and nowhere else.

    Line 22

  7. Folders created on install

    Creates the folders the app needs before it starts: App storage (fast) › tdarr-node, App storage (large) › tdarr-node, App storage (fast) › tdarr-node › configs, App storage (large) › tdarr-node › logs and App storage (large) › tdarr-node › transcodes. Folders marked “snapshot” are included in HexOS snapshots, so you can roll them back.

    Lines 24–36

  8. Your server's address (server ip)

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

    Line 39

  9. Your answer: server port

    Filled in with what you typed for “server port” when you installed.

    Line 40

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

    Where the app's “configs” files is saved on your server: App storage (fast) › tdarr-node › configs.

    Line 43

  11. Where the app's log files is saved

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

    Line 44

  12. Where temporary video conversion files is saved

    Where temporary video conversion files is saved on your server: App storage (large) › tdarr-node › transcodes.

    Line 45

  13. Your shared folders

    Gives the app access to your existing files: Media appears inside the app as /media.

    Lines 46–48

  14. 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 51

  15. Graphics card access

    If your server has a supported graphics card, HexOS shares it with the app (useful for video conversion or AI features).

    Line 52