rapejim/pms-plexdrive-docker repository overview

⁠Plex Media Server and Plexdrive 🐳

Combine the power of Plex Media Server (hereinafter PMS) with the media files of your Google Drive account (or a Team Drive) mounted it by Plexdrive.

Based on official PMS image for Docker⁠ and installed inside Plexdrive v.5.1.0⁠
Forked from original https://bitbucket.org/sh1ny/docker-pms-plexdrive⁠ repository.
IMPORTANT: All options are inherited from the official PMS container. Refer to PMS documentation for more info⁠.

⁠Prerequisites

You must have your own Client ID & Client Secret to configure plexdrive. If you don't have it, you can follow any internet guide, for example:

• English⁠
• Spanish⁠

Or you can use the configuration files from a previous plexdrive installation (the config.json and token.json files, preferably not reusing the cache.bolt, it is better that this installation generates a new one).

⁠Example run commands

⁠Minimal example run command (host network):

docker run --name Plex -d \
    --net=host \
    -e TZ="Europe/Madrid" \
    -e PLEX_UID=${UID} \
    -e PLEX_GID=$(id -g) \
    -v /docker/pms-plexdrive/config:/config \
    -v /docker/pms-plexdrive/transcode:/transcode \
    --privileged \
    --cap-add MKNOD \
    --cap-add SYS_ADMIN \
    --device /dev/fuse \
    --restart=unless-stopped \
    rapejim/pms-plexdrive-docker

NOTE: You must replace Europe/Madrid for your time zone and /docker/pms-plexdrive/... for your own path (if not use this folder structure). If you have config files (config.json and token.json) from previous installation of plexdrive, place it on /docker/pms-plexdrive/config/.plexdrive folder.

⁠Advanced example run command (bridge network):

docker run --name Plex -h Plex -d \
    -p 32400:32400/tcp \
    -p 3005:3005/tcp \ # Optional
    -p 8324:8324/tcp \ # Optional
    -p 32469:32469/tcp \ # Optional
    -p 1900:1900/udp \ # Optional
    -p 32410:32410/udp \ # Optional
    -p 32412:32412/udp \ # Optional
    -p 32413:32413/udp \ # Optional
    -p 32414:32414/udp \ # Optional
    -e TZ="Europe/Madrid" \
    -e PLEX_UID=${UID} \
    -e PLEX_GID=$(id -g) \
    -v /docker/pms-plexdrive/config:/config \
    -v /docker/pms-plexdrive/transcode:/transcode \
    --privileged \
    --cap-add MKNOD \
    --cap-add SYS_ADMIN \
    --device /dev/fuse \
    --restart=unless-stopped \
    rapejim/pms-plexdrive-docker

NOTE: You must replace Europe/Madrid for your time zone and /docker/pms-plexdrive/... for your own path (if not use this folder structure). If you have config files (config.json and token.json) from previous installation of plexdrive, place it on /docker/pms-plexdrive/config/.plexdrive folder.

⁠First usage and initial config

On the first run of container (without config files of previous installation) you must enter inside container console, copy-paste and run this command:

plexdrive mount -c ${HOME}/${PLEXDRIVE_CONFIG_DIR} --cache-file=${HOME}/${PLEXDRIVE_CONFIG_DIR}/cache.bolt -o allow_other ${PLEXDRIVE_MOUNT_POINT} {EXTRA_PARAMS}

This command start a config wizzard:

• It asks you for your Client ID and Client Secret
• Shows you a link to log in using your Google Drive account (which you used to get that Client ID and Client Secret).
• The web show you a token that you must copy it and paste on terminal.
• When you complete it, Plexdrive start caching your Google Drive account files on second plane, no need to wait for Plexdrive to complete its initial cache building process on this console, now you have the config.json and token.json created and can exit from terminal (Cntrl + C and exit).

NOTE: If you are creating this container on a remote computer (outside your local network) it is recommended to use the environment variable PLEX_CLAIM of original PMS docker image⁠ to link this new server to your own account on first run.

⁠Parameters

Those are not required unless you want to preserve your current folder structure or maintain special file permissions.

• PLEXDRIVE_CONFIG_DIR Sets the name of Plexdrive config folder found within PMS config folder. Default is .plexdrive.
• PLEXDRIVE_MOUNT_POINT Sets the name of internal Plexdrive mount point. Default is /home/Plex.
• CHANGE_PLEXDRIVE_CONFIG_DIR_OWNERSHIP Defines if the container should attempt to correct permissions of existing Plexdrive config files.
• PLEX_UID and PLEX_GID Sets user ID and group ID for Plex user. Useful if you want them to match those of your own user on the host.
• EXTRA_PARAMS Add more advanced parameters for plexdrive to mount initial command. You can use, for example:
  • --drive-id=ABC123qwerty987 for Team Drive with id ABC123qwerty987
  • --root-node-id=DCBAqwerty987654321_ASDF123456789 for a mount only the sub directory with id DCBAqwerty987654321_ASDF123456789
  • ... plexdrive documentation for more info ...⁠
  • IMPORTANT: Not allowed "-v --verbosity", "-c --config", "--cache-file" or "-o --fuse-options" parameters, because are already used.
    

REMEMBER: All options from the official PMS container are inherited. Refer to PMS documentation for more info⁠.

⁠Host folder structure example

Docker Data Folder
├── pms-plexdrive
│   ├── config
│   │   ├── .plexdrive
│   │   │   └── ...
│   │   └── Library
│   │       └── ...
│   └── transcode
└── ...

⁠Tags

Tags correspond to those of the official PMS Docker container:

• public — Public release of PMS.
• beta — Beta release of PMS, (Plex Pass required).
• latest — currently the same as public.
• develop — currently the same as beta.