10 KiB

Executable File

Czysty Wina Historia

title
plex-meta-manager

linuxserver/plex-meta-manager

Plex-meta-manager is a Python 3 script that can be continuously run using YAML configuration files to update on a schedule the metadata of the movies, shows, and collections in your libraries as well as automatically build collections based on various methods all detailed in the wiki.

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-meta-manager: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	✅	arm32v7-<version tag>

Version Tags

This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.

Tag	Available	Description
latest	✅	Stable releases.
develop	✅	Latest commits from the develop branch

Application Setup

There is a walkthrough available to help get you up and running.

This image supports all of the environment variables listed here and all commandline arguments.

To perform a one-time run use docker run (or docker-compose run) with the --rm and -e PMM_RUN=True arguments. This will cause the container to process your config immediately instead of waiting for the scheduled time, and delete the old container after completion.

For more information see the official wiki.

Usage

To help you get started creating a container from this image you can either use docker-compose or the docker cli.

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

---
version: "2.1"
services:
  plex-meta-manager:
    image: lscr.io/linuxserver/plex-meta-manager:latest
    container_name: plex-meta-manager
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=Europe/London
      - PMM_CONFIG=/config/config.yml #optional
      - PMM_TIME=03:00 #optional
      - PMM_RUN=False #optional
      - PMM_TEST=False #optional
      - PMM_NO_MISSING=False #optional
    volumes:
      - /path/to/appdata/config:/config
    restart: unless-stopped

docker cli (click here for more info)

docker run -d \
  --name=plex-meta-manager \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=Europe/London \
  -e PMM_CONFIG=/config/config.yml `#optional` \
  -e PMM_TIME=03:00 `#optional` \
  -e PMM_RUN=False `#optional` \
  -e PMM_TEST=False `#optional` \
  -e PMM_NO_MISSING=False `#optional` \
  -v /path/to/appdata/config:/config \
  --restart unless-stopped \
  lscr.io/linuxserver/plex-meta-manager:latest

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

Environment Variables (`-e`)

Env	Function
`PUID=1000`	for UserID - see below for explanation
`PGID=1000`	for GroupID - see below for explanation
`TZ=Europe/London`	Specify a timezone to use EG Europe/London.
`PMM_CONFIG=/config/config.yml`	Specify a custom config file to use.
`PMM_TIME=03:00`	Comma-separated list of times to update each day. Format: `HH:MM`.
`PMM_RUN=False`	Set to `True` to run without the scheduler.
`PMM_TEST=False`	Set to `True` to run in debug mode with only collections that have `test: true`.
`PMM_NO_MISSING=False`	Set to `True` to run without any of the missing movie/show functions.

Volume Mappings (`-v`)

Volume	Function
`/config`	Local path for plex-meta-manager config files.

Miscellaneous Options

Parameter	Function

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.

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

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-meta-manager /bin/bash
To monitor the logs of the container in realtime:
- docker logs -f plex-meta-manager
Container version number
- docker inspect -f '{{ index .Config.Labels "build_version" }}' plex-meta-manager
Image version number
- docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/plex-meta-manager:latest

Versions

11.12.22: - Rebase master to Alpine 3.17.
08.11.22: - Add develop branch.
25.10.22: - Support commandline args and relative paths.
03.10.22: - Rebase to Alpine 3.16, migrate to s6v3.
30.01.22: - Initial Release.

10 KiB Executable File Czysty Wina Historia