Tdarr Documentation

File: README.md Copy Chapter

Tdarr V2: Distributed Transcoding System

Audio/Video Library Analytics & Transcode/Remux Automation

• FFmpeg/HandBrake + video health checking (Windows, macOS, Linux & Docker)

[Download/Setup/Installation](https://docs.tdarr.io/docs/installation/windows-linux-macos)

About:

https://tdarr.io/

https://docs.tdarr.io/

Builds

Tdarr V2 is a cross-platform conditional based transcoding application for automating media library transcode/remux management in order to process your media files as required. For example, you can set rules for the required codecs, containers, languages etc that your media should have which helps keeps things organized and can increase compatability with your devices. A common use for Tdarr is to simply convert video files from h264 to h265 (hevc), saving 40%-50% in size.

The application is in the form of a click-to-run web-app, comprised of the following 2 components:

• Tdarr_Server - Central process which all Nodes connect with
• Tdarr_Node - Processes running on same/other devices which collect tasks from the Server

Put your spare hardware to use with Tdarr Nodes for Windows, Linux (including Linux arm/arm64) and macOS.

Designed to work alongside applications like Sonarr/Radarr and built with the aim of modularisation, parallelisation and scalability, each library you add has its own transcode settings, filters and schedule. Workers can be fired up and closed down as necessary, and are split into 4 types - Transcode CPU/GPU and Health Check CPU/GPU. Worker limits can be managed by the scheduler as well as manually. For a desktop application with similar functionality please see HBBatchBeast.

• Cross-platform Tdarr Nodes which work together with Tdarr Server to process your files
• GPU and CPU workers
• Use/create Tdarr Plugins for infinite control on how your files are processed:
  https://github.com/HaveAGitGat/Tdarr_Plugins
• Audio and video library management
• 7 day, 24 hour scheduler
• Folder watcher
• Worker stall detector
• Load balancing between libraries/drives
• Use HandBrake or FFmpeg
• Tested on a 1,000,000 file dummy library
• Search for files based on hundreds of properties
• Library stats
• Hardware transcoding container (install Nvidia plugin on unRAID/Nvidia runtime container on Ubuntu)

Stats Copy Chapter

Nodes Copy Chapter

Job reports Copy Chapter

Property explorer Copy Chapter

Worker verdict history Copy Chapter

Plugin stack system Copy Chapter

Property search Copy Chapter

Library schedule Copy Chapter

Tdarr is extremely modular/configurable and the main idea behind it is creating a plugin stack to clean up/standardise your files. For example, a typical plugin stack might look like this:

(1) Transcode non hevc files into hevc

(2) Remove subs

(3) Remove meta data (if title)

(4) Add aac stereo audio if none (eng preferred)

(5) Remove closed captions

In this example, plugins 1,2,3 and 5 are community plugins which are available for you to use immediately. Plugin 4 can be created in the plugin creator interface in Tdarr and will appear as a local plugin.

Each of the plugins are conditional, so are only used if needed. They are located in Tdarr/Documents and are written in JavaScript so if none of the plugins do what you want then you can modify/create new plugins if you have a bit of coding experience (or get the gist from having a look). Steps for doing so are in the README here:https://github.com/HaveAGitGat/Tdarr_Plugins . Ask for help in the Discord channel if need be.

Here is an illustration of how the plugin stack works:

For the term 'streams', here is an example of how a file appears in Tdarr search results:

That file has 3 streams - a video, audio and subtitle stream. Subtitles and closed captions are very different. Where is the closed caption data in this example? It's embedded inside the h264 video stream.

Extra streams and closed captions which you don't need can cause problems with direct playing and syncing files, so you might as well remove them (it's recommended to use something like Bazarr for subtitles). Even when playing files in programs such as VLC or Kodi, subtitles/closed captions can cause playback delays and make things stuttery for a few seconds when jumping around the video.

Extra streams can also take up a lot of space. Don't be surprised to see some files in your library with 15+ audio/commentary/subtitle tracks in a bunch of different languages. These can take up an extra GB+ per file.

The plugin creator is split into 'Filters' and 'Actions'. Filters encapsulate the actions, so the actions will only be carried out if the filter conditions are met.

Current filters:

Filter by codec

Filter by medium

Filter by age

Filter by resolution

Filter by size

Current actions:

Transcode - HandBrake basic options

Transcode - HandBrake/FFmpeg custom arguments

Transcode - Standardise audio stream codecs

Transcode - Add audio stream

Transcode - Keep one audio stream

Remux container

Some actions/plugins have built-in filters (specified in the plugin creator). This means they'll automatically detect if a file needs to be processed or not (such as the remove subtitles community plugin). Additional filters can be added.

Some of the actions have become quite complicated so take a bit more time. For example, the 'Keep one audio stream' has 16 different outcomes as it tries to determine the best audio stream to keep based on the codec, language and channel count you specify.

If you have a request for a new filter/action, then try and think of it generically so I can implement it in way that other people can configure and apply it to their (slightly) different circumstances. Request on GitHub,Reddit or Discord.

For example, to maximize direct play, a plugin stack like this can be used:

(1) If not in h264, transcode into h264 [h264 is a more universal video codec than others]

(2) If not in mp4, remux into mp4 [mp4 is the most universal container]

(3) Remove subs

(4) Remove closed captions

(5) Add aac stereo audio if none (eng preferred) [very universal audio codec/channel count]

(6) Remove meta-data if title meta detected [Stops annoying titles appearing in Plex]

File: LICENSE.md Copy Chapter

END USER LICENSE AGREEMENT (EULA) FOR TDARR

This End User License Agreement ("EULA") is a legal agreement between you ("User") and Tdarr for the use of the Tdarr software ("Software"). By downloading, installing, or using the Software, you agree to be bound by the terms of this EULA.

1. License Grant

1.1 Tdarr grants you a non-exclusive, non-transferable license to use the Software under the terms of this EULA.

1.2 The license is provided in three tiers:

• Personal Free: Free of charge.
• Personal Subscription: Subscription-based, with additional features.
• Business Subscription & Trial: Subscription-based, designed for business use with full features.

1.3 The Software is intended for personal and business use. Redistribution, reverse engineering, or any unauthorized use of the Software is prohibited without explicit permission from Tdarr.

2. User Responsibilities

2.1 Users are responsible for ensuring the integrity and security of their data when using the Software. Tdarr is not responsible for any data loss during processing.

2.2 Users must not reverse engineer, decompile, or disassemble the Software. Distribution of the Software without prior written permission from Tdarr is strictly prohibited.

3. Intellectual Property and Ownership

3.1 The Software, including all intellectual property rights therein, is and shall remain the property of Tdarr.

3.2 This EULA does not grant you any ownership interest in the Software, and you are granted only a limited right of use as outlined in this agreement.

4. Warranty and Liability

4.1 The Software is provided "as is" without any warranty of any kind, either express or implied.

4.2 Tdarr is not liable for any damages, including but not limited to, direct, indirect, incidental, or consequential damages, arising out of the use or inability to use the Software.

5. Termination

5.1 Tdarr may terminate this EULA at any time if the User breaches any term of this agreement.

5.2 Users may terminate this agreement at any time by ceasing to use the Software and deleting all copies from their systems.

5.3 Upon termination of the license, the User must immediately cease all use of the Software and destroy all copies in their possession.

6. Governing Law

This EULA shall be governed by and construed in accordance with the laws of the United Kingdom.

7. Miscellaneous

7.1 This EULA constitutes the entire agreement between the parties with respect to the use of the Software and supersedes all prior or contemporaneous understandings regarding such subject matter.

7.2 Tdarr reserves the right to modify this EULA at any time, with or without notice. Continued use of the Software following any such modification constitutes your acceptance of the modified EULA.

If you have any questions about this EULA, please contact Tdarr at [email protected].

File: package.json Copy Chapter

{
"name": "tdarr",
"version": "2.62.01",
"description": "",
"main": "index.js",
"scripts": {},
"repository": {
"type": "git",
"url": "git+https://github.com/HaveAGitGat/tdarr.git"
},
"author": "",
"license": "See LICENSE.md",
"bugs": {
"url": "https://github.com/HaveAGitGat/tdarr/issues"
},
"homepage": "https://github.com/HaveAGitGat/tdarr#readme",
"dependencies": {
"babel-eslint": "^10.1.0"
},
"devDependencies": {}
}

File: updater/README.md Copy Chapter

Tdarr v2 Preview

Updated instructions: https://tdarr.io/

1.99.11 Module Matrix

Descriptions:

Download the relevant Tdarr_Updater:

https://docs.tdarr.io/docs/installation/windows-linux-macos

Unzip it.

If on linux or mac it's best to run the packages from a terminal so you can see the output.

Run /Tdarr_Updater

4 Modules will be downloaded.

Run:

/Tdarr_Server/Tdarr_Server

You should be able to see 7 tests run in the logs:

[Info] Tdarr_Server - Binary test 1: handbrakePath working
    [INFO] Tdarr_Server - Binary test 2: ffmpegPath working
    [INFO] Tdarr_Server - Binary test 3: mkvpropeditPath working

    [INFO] Tdarr_Server - Scanner test 1: FFprobe working
    [INFO] Tdarr_Server - Scanner test 2: Exiftool working
    [INFO] Tdarr_Server - Scanner test 3: Mediainfo working
    [INFO] Tdarr_Server - Scanner test 4: CCExtractor working

If the handbrakePath or ffmpegPath aren't working, you need to set the paths in the config below. mkvpropeditPath is currently not use for anything.

Run:

/Tdarr_Node/Tdarr_Node

You should be able to see 3 tests run in the logs:

[Info] Tdarr_Node - Binary test 1: handbrakePath working
    [INFO] Tdarr_Node - Binary test 2: ffmpegPath working
    [INFO] Tdarr_Node - Binary test 3: mkvpropeditPath working

If the handbrakePath or ffmpegPath aren't working, you need to set the paths in the config below. mkvpropeditPath is currently not use for anything.

Close both down once init has finished.

Open /configs/Tdarr_Server_Config.json:

{
  "serverPort": "8266",
  "handbrakePath": "",
  "ffmpegPath": ""
}

Set the server port as desired.
Add handbrakePath and ffmpegPath, make sure to use double back slash or a single forward slash in the paths e.g.:

C:\\ffmpeg\\ffmpeg

C:/ffmpeg/ffmpeg

Open /configs/Tdarr_WebUI_Config.json:

{
   "webUIPort": 8265,
   "serverIP": "0.0.0.0",
   "serverPort": 8266
}

Set the webUIPort as desired. If running the webUI on the same machine as the server, leave serverIP as is else change it to the server machine IP. Set the serverPort
to the same as in the previous config.

Open /configs/Tdarr_Node_Config.json:

{
    "nodeID": "QUkJYfSSD",
    "nodeIP": "0.0.0.0",
    "nodePort": "8267",
    "serverIP": "0.0.0.0",
    "serverPort": "8266",
    "handbrakePath": "",
    "ffmpegPath": "",
    "pathTranslators": [
        {
        "server": "",
        "node": ""
        }
    ]
    }

If runnig the node and server on the same machine leave the IPs as-is else set the machine IPs.

Add handbrakePath and ffmpegPath. Set whichever nodePort you like. If running a node on a different machine to the server,
make sure to specify the serverIP address. Also make sure the node and server machines have the same library and cache paths. For example,
y:\Movies on the server should point to the same location as y:\Movies on the node machine. Else you can use the pathTranslators
in the config above, similar to Docker. e.g.:

{
  "server": "y:/Movies",
  "node": "z:/Stuff/Movies"
}

In the above config, when the server sends a file path to the node, the base path will be translated and vice versa.

Make sure ports are open (8266 for server and 8267 for a default node).

Run /Tdarr_Server/Tdarr_Server

Run /Tdarr_Node/Tdarr_Node

Run /Tdarr_WebUI/Tdarr_WebUI

Visit http://localhost:8265/ and the Tdarr UI should be visible. The connected node should appear on the 'Tdarr' tab.

For Tdarr Desktop, run /Tdarr_Desktop/Tdarr_Desktop which will by default start a server and a local node.

A new config /configs/Tdarr_Desktop_Config.json will be created:

{
  "Tdarr_Node": true,
  "Tdarr_Server": true,
  "Tdarr_WebUI": false,
  "serverIP": "0.0.0.0",
  "serverPort": 8266
}

Above you can specify which modules will run when you start Tdarr_Desktop

If all is working, you should be able to start up workers on different nodes on the 'Tdarr' tab if you have a library set up and some files scanned.

Logs for all modules stored in:

/logs/

Using docker, all server plugins, samples, database files etc are stored in '/app/server' so make sure to map that folder to your host.
The 'tdarr' container contains both Tdarr_Server and Tdarr_WebUI.

Note: The server and nodes must have the same library folders and cache mounted.

Docker run examples:

docker run -ti \
    -v /home/h/Desktop/server:/app/server \
    -v /home/h/Desktop/Transcode:/mount \
    --network host \
    -e "serverIP=0.0.0.0" \
    -e "serverPort=8266" \
    -e "webUIPort=8265" \
    -e "TZ=Europe/London" \
    -e PUID=1000 \
    -e PGID=1000 \
    haveagitgat/tdarr:1.99.11
    
    docker run -ti \
    -v /home/h/Desktop/Transcode:/mount \
    -e "serverIP=0.0.0.0" \
    -e "serverPort=8266" \
    --network host \
    -e "TZ=Europe/London" \
    -e PUID=1000 \
    -e PGID=1000 \
    haveagitgat/tdarr_node:1.99.11

Note: All the variables in the config files can be set through environment variables

Work in progress. Feedback welcome!

File: .github/ISSUE_TEMPLATE/bug_report.md Copy Chapter

name: Bug report
about: Create a report to help us improve
title: ''
labels: ''
assignees: ''

Please put plugin requests/bugs at: https://github.com/HaveAGitGat/Tdarr_Plugins

Describe the bug
A clear and concise description of what the bug is.

To Reproduce
Steps to reproduce the behavior:

Expected behavior
A clear and concise description of what you expected to happen.

Screenshots
If applicable, add screenshots to help explain your problem.

Please provide the following information:

• Config files [can be found in /app/configs/ when using Docker or in the /configs folder next to Tdarr_Updater if not using Docker]

• Job reports: https://docs.tdarr.io/docs/other/job-reports

• Log files [can be found in /app/logs/ when using Docker or in the /logs folder next to Tdarr_Updater if not using Docker]

-Worker error [can be found on the 'Tdarr' tab by pressing the 'i' button on a failed item in the staged file section or in the transcode error section at the bottom]

• OS: [e.g. Linux]
• Browser [e.g. chrome, safari]
• Version [e.g. 2.00.00]

Additional context
Add any other context about the problem here.

File: .github/ISSUE_TEMPLATE/config.yml Copy Chapter

blank_issues_enabled: false

File: .github/ISSUE_TEMPLATE/feature_request.md Copy Chapter

name: Feature request
about: Suggest an idea for this project
title: ''
labels: ''
assignees: ''

Please put plugin requests/bugs at: https://github.com/HaveAGitGat/Tdarr_Plugins

Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

Describe the solution you'd like
A clear and concise description of what you want to happen.

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
Add any other context or screenshots about the feature request here.

File: .github/workflows_/build_multi.yml Copy Chapter

name: build_multi

on:

pull_request:

types: [closed]

push:

branches: ["master"]

pull_request:
branches: ["**"]

jobs:
build_multi_node:
runs-on: ubuntu-20.04
name: build_multi_node
steps:
- uses: actions/checkout@v3
with:
ref: ${{ github.event.pull_request.head.sha }}
- name: Create Variables
id: vars
env:
_repo: ${{github.repository}}
_ref: ${{github.ref}}
run: |
echo "::set-output name=branch::$(echo ${_ref} | cut -d/ -f3)"
echo "::set-output name=username::$(echo ${_repo} | cut -d/ -f1 | tr '[:upper:]' '[:lower:]')"
echo "::set-output name=repo::$(echo ${_repo} | tr '[:upper:]' '[:lower:]')"

- name: Printing Variables
    run: |
      echo "${{ steps.vars.outputs.branch }} && ${{github.ref}}"
      echo "${{ steps.vars.outputs.username }} && ${{github.repository}}"
      echo ${{ steps.vars.outputs.repo }}

  - name: get-npm-version
    id: package-version
    uses: martinbeentjes/npm-get-version-action@master
  
  - name: Set up QEMU
    uses: docker/setup-qemu-action@v1
  - name: Set up Docker Buildx
    uses: docker/setup-buildx-action@v1
  - name: Login to DockerHub
    uses: docker/login-action@v1
    with:
      username: ${{ secrets.DOCKER_HUB_USERNAME }}
      password: ${{ secrets.DOCKER_HUB_ACCESS_TOKEN }}

  - name: Login to GitHub Container Registry
    uses: docker/login-action@v1
    with:
      registry: ghcr.io
      username: ${{ github.actor }}
      password: ${{ secrets.GH_TOKEN }}

  - name: Buildx
    run: |
      cd docker && make build-node USERNAME=${{ steps.vars.outputs.username }} REPO=_acc TAG=dev VERSION=${{ steps.package-version.outputs.current-version }}

build_multi_server:
runs-on: ubuntu-20.04
name: build_multi_server
steps:
- uses: actions/checkout@v3
with:
ref: ${{ github.event.pull_request.head.sha }}
- name: Create Variables
id: vars
env:
_repo: ${{github.repository}}
_ref: ${{github.ref}}
run: |
echo "::set-output name=branch::$(echo ${_ref} | cut -d/ -f3)"
echo "::set-output name=username::$(echo ${_repo} | cut -d/ -f1 | tr '[:upper:]' '[:lower:]')"
echo "::set-output name=repo::$(echo ${_repo} | tr '[:upper:]' '[:lower:]')"

- name: Printing Variables
    run: |
      echo "${{ steps.vars.outputs.branch }} && ${{github.ref}}"
      echo "${{ steps.vars.outputs.username }} && ${{github.repository}}"
      echo ${{ steps.vars.outputs.repo }}

  - name: get-npm-version
    id: package-version
    uses: martinbeentjes/npm-get-version-action@master
  
  - name: Set up QEMU
    uses: docker/setup-qemu-action@v1
  - name: Set up Docker Buildx
    uses: docker/setup-buildx-action@v1
  - name: Login to DockerHub
    uses: docker/login-action@v1
    with:
      username: ${{ secrets.DOCKER_HUB_USERNAME }}
      password: ${{ secrets.DOCKER_HUB_ACCESS_TOKEN }}

  - name: Login to GitHub Container Registry
    uses: docker/login-action@v1
    with:
      registry: ghcr.io
      username: ${{ github.actor }}
      password: ${{ secrets.GH_TOKEN }}

  - name: Buildx
    run: |
      cd docker && make build-server USERNAME=${{ steps.vars.outputs.username }} REPO=_acc TAG=dev VERSION=${{ steps.package-version.outputs.current-version }}