General
Images

linuxserver/plex

GitHub Release MicroBadger Layers MicroBadger Size Docker Pulls Docker Stars Build Status

Plex organizes video, music and photos from personal media libraries and streams them to smart TVs, streaming boxes and mobile devices. This container is packaged as a standalone Plex Media Server. has always been a top priority. Straightforward design and bulk actions mean getting things done faster.

Supported Architectures

Our images support multiple architectures such as x86-64, arm64 and armhf. We utilise the docker manifest for multi-platform awareness. More information is available from docker here and our announcement here.

Simply pulling linuxserver/plex should retrieve the correct image for your arch, but you can also pull specific arch images via tags.

The architectures supported by this image are:

Architecture

Tag

x86-64

amd64-latest

arm64

arm64v8-latest

armhf

arm32v7-latest

Usage

Here are some example snippets to help you get started creating a container from this image.

docker

docker create \
--name=plex \
--net=host \
-e PUID=1000 \
-e PGID=1000 \
-e VERSION=docker \
-e UMASK_SET=022 `#optional` \
-v </path/to/library>:/config \
-v <path/to/tvseries>:/tv \
-v </path/to/movies>:/movies \
-v </path for transcoding>:/transcode \
--restart unless-stopped \
linuxserver/plex

docker-compose

Compatible with docker-compose v2 schemas.

---
version: "2"
services:
plex:
image: linuxserver/plex
container_name: plex
network_mode: host
environment:
- PUID=1000
- PGID=1000
- VERSION=docker
- UMASK_SET=022 #optional
volumes:
- </path/to/library>:/config
- <path/to/tvseries>:/tv
- </path/to/movies>:/movies
- </path for transcoding>:/transcode
restart: unless-stopped

Parameters

Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate <external>:<internal> respectively. For example, -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080 outside the container.

Ports (-p)

Parameter

Function

Networking (--net)

Parameter

Function

--net=host

Use Host Networking

Environment Variables (-e)

Env

Function

PUID=1000

for UserID - see below for explanation

PGID=1000

for GroupID - see below for explanation

VERSION=docker

Set whether to update plex or not - see Application Setup section.

UMASK_SET=022

control permissions of files and directories created by Plex

Volume Mappings (-v)

Volume

Function

/config

Plex library location. This can grow very large, 50gb+ is likely for a large collection.

/tv

Media goes here. Add as many as needed e.g. /movies, /tv, etc.

/movies

Media goes here. Add as many as needed e.g. /movies, /tv, etc.

/transcode

Path for transcoding folder, optional.

Optional Parameters

Special note - If you'd like to run Plex without requiring --net=host (NOT recommended) then you will need the following ports in your docker create command:

-p 32400:32400 \
-p 32400:32400/udp \
-p 32469:32469 \
-p 32469:32469/udp \
-p 5353:5353/udp \
-p 1900:1900/udp

The application accepts a series of environment variables to further customize itself on boot:

Parameter

Function

-v /transcode

Path for transcoding folder

--device=/dev/dri:/dev/dri

Add this option to your run command if you plan on using Quicksync hardware acceleration - see Application Setup section.

User / Group Identifiers

When using volumes (-v flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user PUID and group PGID.

Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.

In this instance PUID=1000 and PGID=1000, to find yours use id user as below:

$ id username
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)

Application Setup

Webui can be found at <your-ip>:32400/web

Note about updates, if there is no value set for the VERSION variable, then no updates will take place.

For new users, no updates will take place on the first run of the container as there is no preferences file to read your token from, to update restart the Docker container after logging in through the webui

Valid settings for VERSION are:-

IMPORTANT NOTE:- YOU CANNOT UPDATE TO A PLEXPASS ONLY (BETA) VERSION IF YOU ARE NOT LOGGED IN WITH A PLEXPASS ACCOUNT

  • docker: Let Docker handle the Plex Version, we keep our Dockerhub Endpoint up to date with the latest public builds. This is the same as leaving this setting out of your create command.

  • latest: will update plex to the latest version available that you are entitled to.

  • public: will update plexpass users to the latest public version, useful for plexpass users that don't want to be on the bleeding edge but still want the latest public updates.

  • <specific-version>: will select a specific version (eg 0.9.12.4.1192-9a47d21) of plex to install, note you cannot use this to access plexpass versions if you do not have plexpass.

Hardware acceleration users for Intel Quicksync will need to mount their /dev/dri video device inside of the container by passing the following command when running or creating the container:

--device=/dev/dri:/dev/dri

We will automatically ensure the abc user inside of the container has the proper permissions to access this device.

Hardware acceleration users for Nvidia will need to install the container runtime provided by Nvidia on their host, instructions can be found here:

https://github.com/NVIDIA/nvidia-docker

We automatically add the necessary environment variable that will utilise all the features available on a GPU on the host. Once nvidia-docker is installed on your host you will need to re/create the docker container with the nvidia container runtime --runtime=nvidia and add an environment variable -e NVIDIA_VISIBLE_DEVICES=all (can also be set to a specific gpu's UUID, this can be discovered by running nvidia-smi --query-gpu=gpu_name,gpu_uuid --format=csv ). NVIDIA automatically mounts the GPU and drivers from your host into the plex docker.

Support Info

  • Shell access whilst the container is running:

    • docker exec -it plex /bin/bash

  • To monitor the logs of the container in realtime:

    • docker logs -f plex

  • Container version number

    • docker inspect -f '{{ index .Config.Labels "build_version" }}' plex

  • Image version number

    • docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/plex

Versions

  • 06.08.19: - Add variable for setting UMASK.

  • 10.07.19: - Fix permissions for tuner (/dev/dvb) devices.

  • 20.05.19: - Bugfix do not allow Root group for Intel QuickSync ownership rules.

  • 23.03.19: - Switching to new Base images, shift to arm32v7 tag.

  • 22.03.19: - Fix update logic for VERSION=public.

  • 14.03.19: - Switch to new api endpoints, enable beta (plex pass) updates for armhf and aarch64.

  • 15.02.19: - Clean up plex pid after unclean stop.

  • 11.02.19: - Fix nvidia variables, add device variables.

  • 16.01.19: - Add pipeline logic, multi arch, and HW transcoding configuration; remove avahi service.

  • 07.09.18: - Rebase to ubuntu bionic, add udev package.

  • 09.12.17: - Fix continuation lines.

  • 12.07.17: - Add inspect commands to README, move to jenkins build and push.

  • 28.05.17: - Add unrar package as per requests, for subzero plugin.

  • 11.01.17: - Use Plex environment variables from pms docker, change abc home folder to /app to alleviate usermod chowning library

  • 03.01.17: - Use case insensitive version variable matching rather than export and make lowercase.

  • 17.10.16: - Allow use of uppercase version variable

  • 01.10.16: - Add TZ info to README.

  • 09.09.16: - Add layer badges to README.

  • 27.08.16: - Add badges to README.

  • 22.08.16: - Rebased to xenial and s6 overlay

  • 07.04.16: - removed /transcode volume support (upstream Plex change) and modified PlexPass download method to prevent unauthorised usage of paid PMS

  • 24.09.15: - added optional support for volume transcoding (/transcode), and various typo fixes.

  • 17.09.15: - Changed to run chmod only once

  • 19.09.15: - Plex updated their download servers from http to https

  • 28.08.15: - Removed plexpass from routine, and now uses VERSION as a combination fix.

  • 18.07.15: - Moved autoupdate to be hosted by linuxserver.io and implemented bugfix thanks to ljm42.

  • 09.07.15: - Now with ability to pick static version number.

  • 08.07.15: - Now with autoupdates. (Hosted by fanart.tv)

  • 03.07.15: - Fixed a mistake that allowed plex to run as user plex rather than abc (99:100). Thanks to double16 for spotting this.