Plex Remote Transcoder

A distributed transcoding backend for Plex.

Please help by reporting bugs, pull-requests or feature requests!

For those interested in testing this out quickly, there is a step by step guide for getting this working on two Ubuntu machines. You can find the guide here.

Addtionally, for proposed features and some current limitations, check out this page.

Supported Versions

NOTE Upgrading Plex Media Server often breaks things and it takes us some time to figure out what needs to be fixed. It is suggested that you avoid upgrading your Plex server before checking here first.

The latest confirmed working version of Plex Media Server is:

 1.3.4.3285

If you try a newer version and encounter an issue, please report it.

Currently Testing Version

The most recently tested version is Plex Media Server version 1.7.5.4035-313f93718. I'm not marking this as supported yet until more people have confirmed that it is working correctly.

IMPORTANT With this version you will need to ensure that the slaves are allowed to connect to the master without auth in order to everything to work correctly. To do this, go to the server settings via your browser, navigate to the 'Network' tab (make sure "Show Advanced" is on). Scroll down to "List of IP addresses and networks that are allowed without auth". In that box, put in your slave addresses or network.

Upgrading Plex Media Server

Users have reported that the following steps need to be taken in order to get PRT working with the newer versions of Plex Media Server:

Remove the codec directory: rm -rf '/var/lib/plexmediaserver/Library/Application Support/Plex Media Server/Codecs/5a2d9a2-1127-linux-ubuntu-x86_64')
Remove the previous encoder: rm -rf /usr/lib/plexmediaserver/plex_transcoder
Install Plex: dpkg -i plexmediaserver_1.2.3.2914-1ff0f18_amd64.deb

Releases

For versions of Plex Media Server below version 1.1.0. use release 0.3.5.

For versions of Plex Media Server below version 1.0, use release 0.2.2.

For the newest version of Plex Media Server, use the main branch or the newest release.

Contributing

Bug fixes/reports and feature requests are welcome! Either submit a pull request or create a new issue. There is also a discussion board.

How Does it Work?

There have been quite a few projects attempting to load balance a Plex server, most of which involve proxying HTTP requests between multiple Plex Media Server (PMS) installations. This project takes a different, and arguably easier approach that simply involves running the Plex New Transcoder on a remote host. In this setup there is only ever one PMS installation (the master node), but there can be any number of transcode hosts (slave nodes). Since transcoding is typically the most processor intensive aspect of PMS, it makes sense to be able to distribute this workload among all available computing resources.

The way this works is by replacing the default Plex New Transcoder binary on the master PMS with a wrapper. This wrapper allows us to intercept the transcode request on the master node and send it to a transcode slave node. The transcode slave invokes the true Plex New Transcoder binary, does the (trans|en)coding and saves the video segments to a network mounted shared filesystem on the master. The master then sends these segments to the client and the video is played back just like normal.

How is the Useful?

That depends. It may not be if you have a powerful PMS and/or very few simultaneous users/devices. If however you often see your main server being ground to halt because of the transcoder and you have access to additional computational capacity, this might be useful to you.

This approach also makes it possible, in theory, to take advantage of scalable computing via services like Amazon's ECS and Google's Compute Engine. By default you could have a dedicated, cheap instance (like ECS's t2.micro) running PMS, then when a user requests a stream, a larger ECS instance could be spawned to do the encoding. When the user is done watching, the extra ECS instance can be turned off, thereby saving you money.

Help

Right now, things are pretty rough. Trying to figure out why something isn't working is difficult, but we're working on making this easier. Also, installation isn't easy and there are lots of places to make mistakes, we're working on that too.

Configuration

The configuration file is located in a file named ~/.prt.conf. It should be a valid JSON file and is created for you the first time you run prt install. Below is a list of some configuration options that can currently only be set by manually editing this file.

servers_script

This option can be used to specify the path to an executable that will return a list of currently available transcode slave node. It is called before every transcode request and should return a list of transcode nodes in the following format:

hostname-1 22 plex
hostname-2 22 plex

where each line is a new host, consisting of three entries: the hostname or IP address, SSH port and SSH username.

path_script

This option can be used to specify the path to an executable that accepts a single argument at the command line and returns a single line to stdout. The single input parameter is the full path to the requested item to transcode. If the path is to be modified or changed, then the new path should be written back to stdout. A simple example in Python that simply returns the same path is given below.

#!/usr/bin/env python
import sys

if len(sys.argv) > 1:
    path = sys.argv[1]
    sys.stdout.write(path)

logging

TODO: Document this.

Contributors

Weston Nielson (Owner) - wnielson@github
Andy Livingstone - liviynz@github

Donations

Some people have ask about how to dontate, so if you want to buy me a beer here are some links. Cheers!

wnielson / Plex-Remote-Transcoder

readme