Hexy Templates

Tdarr

Tdarr is a Distributed Transcoding System

Not yet tested media Based on TrueNAS app v1.3.45 (Tdarr 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 and choose Custom Install
  3. 3
    Paste, then press Install — full guide with screenshots
tdarr.json
Download 
1{
12  "version": 5,
23  "script": {
4    "version": "0.1.0",
5    "changeLog": "Auto-generated draft from TrueNAS tdarr 1.3.45"
6  },
7  "requirements": {
38    "locations": [
9      "ApplicationsPerformance",
10      "ApplicationsCapacity",
11      "Media"
12    ],
413    "specifications": ["2CORE"],
514    "permissions": ["READ_WRITE_LOCATIONS"],
615    "ports": [30088, 30029]
16  },
717  "ensure_directories_exists": [
18    {"path": "$LOCATION(ApplicationsPerformance)"},
19    {"path": "$LOCATION(ApplicationsPerformance)/tdarr"},
20    {"path": "$LOCATION(ApplicationsCapacity)"},
21    {"path": "$LOCATION(ApplicationsCapacity)/tdarr"},
22    {"path": "$LOCATION(Media)", "network_share": true},
23    {
24      "path": "$LOCATION(ApplicationsPerformance)/tdarr/server",
25      "snapshot": {"id": "server"}
26    },
27    {
28      "path": "$LOCATION(ApplicationsPerformance)/tdarr/configs",
29      "snapshot": {"id": "configs"}
30    },
31    {"path": "$LOCATION(ApplicationsCapacity)/tdarr/logs"},
32    {"path": "$LOCATION(ApplicationsCapacity)/tdarr/transcodes"}
33  ],
34  "app_values": {
35    "storage": {
836      "server": "$HOST_PATH($LOCATION(ApplicationsPerformance)/tdarr/server)",
937      "configs": "$HOST_PATH($LOCATION(ApplicationsPerformance)/tdarr/configs)",
1038      "logs": "$HOST_PATH($LOCATION(ApplicationsCapacity)/tdarr/logs)",
1139      "transcodes": "$HOST_PATH($LOCATION(ApplicationsCapacity)/tdarr/transcodes)",
1240      "additional_storage": [
41        "$MOUNTED_HOST_PATH($LOCATION(Media), /media)"
42      ]
43    },
44    "network": {
1345      "web_port": {"bind_mode": "published", "port_number": 30088},
1446      "server_port": {"bind_mode": "published", "port_number": 30029}
47    },
48    "resources": {
1549      "limits": {"cpus": 2, "memory": "$MEMORY(10%, 4096)"},
1650      "gpus": "$GPU_CONFIG()"
51    }
52  }
53}

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 1.3.45”.

    Lines 3–6

  3. 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 8–12

  4. Minimum hardware

    Recommended minimum: 2 CPU cores.

    Line 13

  5. Permission to use your folders

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

    Line 14

  6. Network ports

    The app needs ports 30088 and 30029 to be free on your server. A port is like an apartment number for your server's address.

    Line 15

  7. Folders created on install

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

    Lines 17–33

  8. Where the app's “server” files is saved

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

    Line 36

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

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

    Line 37

  10. Where the app's log files is saved

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

    Line 38

  11. Where temporary video conversion files is saved

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

    Line 39

  12. Your shared folders

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

    Lines 40–42

  13. Web port: 30088

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

    Line 45

  14. Server port: 30029

    Publishes the app's server port as 30029.

    Line 46

  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 49

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