• Stars
    star
    992
  • Rank 44,373 (Top 1.0 %)
  • Language
    Dockerfile
  • License
    GNU General Publi...
  • Created almost 9 years ago
  • Updated 7 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

linuxserver.io

Blog Discord Discourse Fleet GitHub Open Collective

The LinuxServer.io team brings you another container release featuring:

  • regular and timely application updates
  • easy user mappings (PGID, PUID)
  • custom base image with s6 overlay
  • weekly base OS updates with common layers across the entire LinuxServer.io ecosystem to minimise space usage, down time and bandwidth
  • regular security updates

Find us at:

  • Blog - all the things you can do with our containers including How-To guides, opinions and much more!
  • Discord - realtime support / chat with the community and the team.
  • Discourse - post on our community forum.
  • Fleet - an online web interface which displays all of our maintained images.
  • GitHub - view the source for all of our repositories.
  • Open Collective - please consider helping us by either donating or contributing to our budget

linuxserver/plex

Scarf.io pulls GitHub Stars GitHub Release GitHub Package Repository GitLab Container Registry Quay.io Docker Pulls Docker Stars Jenkins Build LSIO CI

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.

plex

Supported Architectures

We utilise the docker manifest for multi-platform awareness. More information is available from docker here and our announcement here.

Simply pulling lscr.io/linuxserver/plex:latest 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 Available Tag
x86-64 amd64-<version tag>
arm64 arm64v8-<version tag>
armhf

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

Intel

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.

Nvidia

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.

Usage

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

docker-compose (recommended, click here for more info)

---
version: "2.1"
services:
  plex:
    image: lscr.io/linuxserver/plex:latest
    container_name: plex
    network_mode: host
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=Etc/UTC
      - VERSION=docker
      - PLEX_CLAIM= #optional
    volumes:
      - /path/to/library:/config
      - /path/to/tvseries:/tv
      - /path/to/movies:/movies
    restart: unless-stopped

docker cli (click here for more info)

docker run -d \
  --name=plex \
  --net=host \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=Etc/UTC \
  -e VERSION=docker \
  -e PLEX_CLAIM= `#optional` \
  -v /path/to/library:/config \
  -v /path/to/tvseries:/tv \
  -v /path/to/movies:/movies \
  --restart unless-stopped \
  lscr.io/linuxserver/plex:latest

Parameters

Container 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.

Parameter Function
--net=host Use Host Networking
-e PUID=1000 for UserID - see below for explanation
-e PGID=1000 for GroupID - see below for explanation
-e TZ=Etc/UTC specify a timezone to use, see this list.
-e VERSION=docker Set whether to update plex or not - see Application Setup section.
-e PLEX_CLAIM= Optionally you can obtain a claim token from https://plex.tv/claim and input here. Keep in mind that the claim tokens expire within 4 minutes.
-v /config Plex library location. This can grow very large, 50gb+ is likely for a large collection.
-v /tv Media goes here. Add as many as needed e.g. /movies, /tv, etc.
-v /movies Media goes here. Add as many as needed e.g. /movies, /tv, etc.

Environment variables from files (Docker secrets)

You can set any environment variable from a file by using a special prepend FILE__.

As an example:

-e FILE__PASSWORD=/run/secrets/mysecretpassword

Will set the environment variable PASSWORD based on the contents of the /run/secrets/mysecretpassword file.

Umask for running applications

For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional -e UMASK=022 setting. Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up here before asking for support.

Optional Parameters

If you want to run the container in bridge network mode (instead of the recommended host network mode) you will need to specify ports. The official documentation for ports lists 32400 as the only required port. The rest of the ports are optionally used for specific purposes listed in the documentation. If you have not already claimed your server (first time setup) you need to set PLEX_CLAIM to claim a server set up with bridge networking.

  -p 32400:32400 \
  -p 1900:1900/udp \
  -p 5353:5353/udp \
  -p 8324:8324 \
  -p 32410:32410/udp \
  -p 32412:32412/udp \
  -p 32413:32413/udp \
  -p 32414:32414/udp \
  -p 32469:32469

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

Parameter Function
--device=/dev/dri:/dev/dri Add this option to your run command if you plan on using Quicksync hardware acceleration - see Application Setup section.
--device=/dev/dvb:/dev/dvb Add this option to your run command if you plan on using dvb devices.

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)

Docker Mods

Docker Mods Docker Universal Mods

We publish various Docker Mods to enable additional functionality within the containers. The list of Mods available for this image (if any) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above.

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" }}' lscr.io/linuxserver/plex:latest

Updating Info

Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (ie. nextcloud, plex), we do not recommend or support updating apps inside the container. Please consult the Application Setup section above to see if it is recommended for the image.

Below are the instructions for updating containers:

Via Docker Compose

  • Update all images: docker-compose pull
    • or update a single image: docker-compose pull plex
  • Let compose update all containers as necessary: docker-compose up -d
    • or update a single container: docker-compose up -d plex
  • You can also remove the old dangling images: docker image prune

Via Docker Run

  • Update the image: docker pull lscr.io/linuxserver/plex:latest
  • Stop the running container: docker stop plex
  • Delete the container: docker rm plex
  • Recreate a new container with the same docker run parameters as instructed above (if mapped correctly to a host folder, your /config folder and settings will be preserved)
  • You can also remove the old dangling images: docker image prune

Via Watchtower auto-updater (only use if you don't remember the original parameters)

  • Pull the latest image at its tag and replace it with the same env variables in one run:

    docker run --rm \
    -v /var/run/docker.sock:/var/run/docker.sock \
    containrrr/watchtower \
    --run-once plex
  • You can also remove the old dangling images: docker image prune

Note: We do not endorse the use of Watchtower as a solution to automated updates of existing Docker containers. In fact we generally discourage automated updates. However, this is a useful tool for one-time manual updates of containers where you have forgotten the original parameters. In the long term, we highly recommend using Docker Compose.

Image Update Notifications - Diun (Docker Image Update Notifier)

  • We recommend Diun for update notifications. Other tools that automatically update containers unattended are not recommended or supported.

Building locally

If you want to make local modifications to these images for development purposes or just to customize the logic:

git clone https://github.com/linuxserver/docker-plex.git
cd docker-plex
docker build \
  --no-cache \
  --pull \
  -t lscr.io/linuxserver/plex:latest .

The ARM variants can be built on x86_64 hardware using multiarch/qemu-user-static

docker run --rm --privileged multiarch/qemu-user-static:register --reset

Once registered you can define the dockerfile to use with -f Dockerfile.aarch64.

Versions

  • 16.08.23: - Install unrar from linuxserver repo.
  • 03.07.23: - Deprecate armhf. As announced here
  • 16.10.22: - Rebase to jammy. Update to s6v3. Remove opencl packages (bundled with plex).
  • 18.07.22: - Pin all opencl related driver packages.
  • 16.05.22: - Pin opencl version.
  • 04.03.22: - Increase verbosity of video device permissions fix, attempt to fix missing group rw.
  • 25.12.21: - Install Intel drivers from the official repo.
  • 20.01.21: - Deprecate UMASK_SET in favor of UMASK in baseimage, see above for more information.
  • 10.12.20: - Add latest Intel Compute packages from github repo for opencl support on latest gen igpu.
  • 23.11.20: - Add Bionic branch make Focal default.
  • 03.05.20: - Update exposed ports and example docs for bridge mode.
  • 23.03.20: - Remove udev hack (no longer needed), suppress uuid error in log during first start.
  • 04.12.19: - Add variable for setting PLEX_CLAIM. Remove /transcode volume mapping as it is now set via plex gui and defaults to a location under /config.
  • 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.

More Repositories

1

Heimdall

An Application dashboard and launcher
PHP
7,126
star
2

docker-wireguard

Dockerfile
2,471
star
3

docker-swag

Nginx webserver and reverse proxy with php support and a built-in Certbot (Let's Encrypt) client. It also contains fail2ban for intrusion prevention.
Dockerfile
2,461
star
4

docker-code-server

Dockerfile
1,415
star
5

docker-webtop

Ubuntu, Alpine, Arch, and Fedora based Webtop images, Linux in a web browser supporting popular desktop environments.
Dockerfile
1,275
star
6

reverse-proxy-confs

These confs are pulled into our SWAG image: https://github.com/linuxserver/docker-swag
1,229
star
7

docker-unifi-controller

Dockerfile
844
star
8

docker-mods

Documentation and Examples of base container modifications
Dockerfile
808
star
9

docker-letsencrypt

DEPRECATED: Please use linuxserver/swag instead
Dockerfile
727
star
10

docker-sonarr

Dockerfile
672
star
11

docker-calibre-web

Dockerfile
663
star
12

budge

JavaScript
579
star
13

docker-nextcloud

Dockerfile
571
star
14

docker-jellyfin

Dockerfile
563
star
15

docker-bookstack

A Docker container for the BookStack documentation wiki
Dockerfile
556
star
16

docker-qbittorrent

Dockerfile
554
star
17

docker-radarr

Dockerfile
501
star
18

docker-transmission

Dockerfile
486
star
19

docker-openssh-server

Dockerfile
473
star
20

docker-emulatorjs

Web based retro emulation frontend with rom scanning and automated art ingestion.
Dockerfile
439
star
21

docker-unifi-network-application

Dockerfile
419
star
22

docker-jackett

Dockerfile
346
star
23

emulatorjs

Self hosted web based retro emulation front end with rom and art management.
JavaScript
331
star
24

docker-calibre

Dockerfile
291
star
25

docker-smokeping

Shell
287
star
26

Heimdall-Apps

Apps for Heimdall
PHP
283
star
27

docker-heimdall

Dockerfile
282
star
28

docker-grocy

A container for grocy - the ERP application for your kitchen https://grocy.info
Dockerfile
256
star
29

docker-prowlarr

Docker image for Prowlarr/Prowlarr
Dockerfile
249
star
30

docker-syncthing

Dockerfile
235
star
31

docker-deluge

Dockerfile
223
star
32

docker-netbootxyz

Dockerfile
222
star
33

docker-kasm

Kasm Workspaces platform provides enterprise-class orchestration, data loss prevention, and web streaming technology to enable the delivery of containerized workloads to your browser.
Shell
218
star
34

docker-sabnzbd

Dockerfile
210
star
35

docker-duplicati

Dockerfile
207
star
36

docker-bazarr

Dockerfile
200
star
37

docker-rdesktop

Dockerfile
191
star
38

docker-tautulli

Dockerfile
184
star
39

docker-duckdns

Shell
183
star
40

docker-mariadb

Dockerfile
181
star
41

docker-homeassistant

Dockerfile
170
star
42

docker-lidarr

Dockerfile
169
star
43

docker-healthchecks

Dockerfile
163
star
44

docker-baseimage-kasmvnc

Base Images for remote web based Linux desktops using KasmVNC for many popular distros.
Shell
159
star
45

docker-couchpotato

Dockerfile
153
star
46

davos

Web-based FTP automation for Linux servers.
Java
151
star
47

docker-rutorrent

DEPRECATED
PHP
151
star
48

docker-ombi

Dockerfile
147
star
49

docker-nzbget

Dockerfile
140
star
50

docker-tvheadend

Dockerfile
134
star
51

docker-freshrss

HTML
124
star
52

docker-baseimage-alpine

Dockerfile
124
star
53

docker-docker-compose

Shell
123
star
54

docker-nginx

Dockerfile
122
star
55

docker-kodi-headless

Dockerfile
122
star
56

Clarkson

Web-based fuel logging dashboard
TypeScript
120
star
57

docker-firefox

Dockerfile
113
star
58

fleet

Status and image fleet metadata management application for Docker images
Java
110
star
59

docker-ffmpeg

Dockerfile
109
star
60

docker-ddclient

Dockerfile
106
star
61

docker-piwigo

Dockerfile
104
star
62

docker-resilio-sync

Dockerfile
102
star
63

docker-snipe-it

Alpine/Nginx container for the Asset Management software Snipe-IT
Dockerfile
101
star
64

docker-baseimage-guacgui

Dockerfile
98
star
65

docker-beets

Dockerfile
97
star
66

docker-baseimage-ubuntu

Dockerfile
97
star
67

docker-daapd

Dockerfile
96
star
68

docker-readarr

Container for readarr.com
94
star
69

docker-wireshark

Dockerfile
87
star
70

docker-openvscode-server

Dockerfile
83
star
71

docker-dokuwiki

Dockerfile
82
star
72

docker-ubooquity

Dockerfile
82
star
73

docker-emby

Dockerfile
80
star
74

docker-overseerr

Dockerfile
77
star
75

docker-lazylibrarian

Dockerfile
77
star
76

heimdalljs

JavaScript
77
star
77

docker-baseimage-rdesktop-web

Custom all in one container for running GUI apps from a web browser
Dockerfile
73
star
78

docker-netbox

Python
72
star
79

docker-pyload-ng

Dockerfile
72
star
80

docker-mastodon

Dockerfile
71
star
81

gclient

NodeJS application replacement for the default Guacamole Client
JavaScript
66
star
82

docker-ldap-auth

Python
66
star
83

docker-librespeed

HTML
66
star
84

docker-steamos

Vanilla Arch modified into SteamOS with web based Desktop access, useful for remote play and lower end games
Dockerfile
66
star
85

docker-tt-rss

Dockerfile
65
star
86

docker-libreoffice

Dockerfile
64
star
87

docker-wikijs

Dockerfile
64
star
88

docker-diskover

A Docker container for the Diskover space mapping application
Dockerfile
64
star
89

docker-nzbhydra2

Dockerfile
61
star
90

docker-organizr

DEPRECATED
Dockerfile
61
star
91

docker-budge

Dockerfile
56
star
92

docker-remmina

Dockerfile
56
star
93

docker-projectsend

Dockerfile
55
star
94

docker-scrutiny

Dockerfile
54
star
95

docker-endlessh

Dockerfile
53
star
96

docker-snapdrop

HTML
52
star
97

docker-chromium

Web accessible Chromium inside an Alpine Container
Dockerfile
52
star
98

docker-paperless-ngx

Dockerfile
48
star
99

docker-headphones

Dockerfile
48
star
100

docker-papermerge

Dockerfile
47
star