linuxserver-labs / docker-plextraktsync

GNU General Public License v3.0
45 stars 1 forks source link

linuxserver.io

Blog Discord Discourse Fleet GitHub Open Collective

WARNING: Linuxserver Labs images are not production ready and we do not provide support for them. They are experimental and could change/break at any time. Please do not deploy them anywhere important

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

Find us at:

linuxserver-labs/plextraktsync

Scarf.io pulls GitHub Stars GitHub Release GitHub Package Repository

PlexTraktSync is a self-hosted application that adds a two-way-sync between trakt.tv and Plex Media Server. It requires a trakt.tv account but no Plex premium and no Trakt VIP subscriptions, unlike the Plex app provided by Trakt.

plextraktsync

Supported Architectures

Our images support multiple architectures such as x86-64 and arm64. 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-labs/plextraktsync: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 latest
arm64 latest

Application Setup

After creation and first start of the container, config.yml file will be created in the config folder. However, since Plex and Trakt.tv credentials will be missing, scrobbling and auto-sync will be disabled. Edit the config.yml file as necessary and manually run the first sync via docker exec -it plextraktsync plextraktsync. The wizard will ask for the necessary credentials and then run the first sync. Once that's completed, you can restart the container and scrobbling and auto sync should be active.

By default, sync will run every two hours. The schedule is customizable via the crontab file /config/crontabs/abc. Make sure to restart the container after making changes to it.

Other supported PlexTraktSync commands can be issued via docker exec -it plextraktsync plextraktsync <command> in a runnning container.

Usage

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

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

---
services:
  plextraktsync:
    image: lscr.io/linuxserver-labs/plextraktsync:latest
    container_name: plextraktsync
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=Europe/London
    volumes:
      - /path/to/appdata:/config
    restart: unless-stopped

docker cli (click here for more info)

docker run -d \
  --name=plextraktsync \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=Europe/London \
  -v /path/to/appdata:/config \
  --restart unless-stopped \
  lscr.io/linuxserver-labs/plextraktsync: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
-e PUID=1000 for UserID - see below for explanation
-e PGID=1000 for GroupID - see below for explanation
-e TZ=Europe/London Specify a timezone to use EG Europe/London.
-v /config The folder on host you'd like the app data to reside in.

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

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

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

Via Docker Run

Image Update Notifications - Diun (Docker Image Update Notifier)

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-labs/docker-plextraktsync.git
cd docker-plextraktsync
docker build \
  --no-cache \
  --pull \
  -t lscr.io/linuxserver-labs/plextraktsync: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