Plex Auto Languages

Plex Auto Languages enhances your Plex experience by automatically updating the audio and subtitle settings of TV shows based on your preferences. Similar to Netflix, it remembers your language settings for each TV show without interfering with your global settings or other users' preferences.

Table of Contents

• Plex Auto Languages
  • Table of Contents
  • Features
  • Getting Started
    • Requirements
    • Installation Options
      • Docker Installation
      • Python Installation
  • Configuration
    • Key Parameters
      • Plex Configuration
      • Update Settings
      • Notifications (Optional)
      • Advanced Options
    • Environment Variable Summary
  • License

Features

• Seamless Language Selection: Watch Squid Game in Korean with English subtitles? Set it once for the first episode and enjoy the rest of the series hassle-free. 👌

• Per-Show Customization: Want The Mandalorian in English and Game of Thrones in French? Preferences are tracked separately for each show. ✔️

• Multi-User Support: Perfect for households with diverse preferences. Each user gets their tracks automatically and independently selected. ✔️

Getting Started

Requirements

To use Plex Auto Languages, you'll need:

1. Plex Token: Learn how to retrieve yours from the official Plex guide.

2. Python 3.8+ or Docker: The application can run natively via Python or as a Docker container.

---

Installation Options

Docker Installation

Running Plex Auto Languages with Docker is the recommended approach.

Docker Image Tags:

• main (Development): Tracks the latest commit on the main branch. Includes the newest features but may be unstable.

  Recommended for: Developers and testers.

  Note: Updates with every commit; may include breaking changes.

• latest (Stable Release): Points to the most recent stable release. Ideal for production environments.

  Recommended for: General use.

• A.B.C.D (Versioned Releases): Specific version tags for consistency and reliability.

  Recommended for: Environments requiring strict version control.

Docker Registries:

The Docker image can be pulled from either of the following registries:

• ghcr.io/journeydocker/plex-auto-languages:<tagname>
• journeyover/plex-auto-languages:<tagname>

Docker Compose Configuration:

Here's an example of a minimal docker-compose.yml setup:

services:
  plexautolanguages:
    image: journeyover/plex-auto-languages:main
    environment:
      - PLEX_URL=http://plex:32400
      - PLEX_TOKEN=MY_PLEX_TOKEN
      - TZ=Europe/Paris
    volumes:
      - ./config:/config

Run with Docker CLI:

Alternatively, you can run the container directly:

docker run -d \
  -e PLEX_URL=http://plex:32400 \
  -e PLEX_TOKEN=MY_PLEX_TOKEN \
  -e TZ=Europe/Paris \
  -v ./config:/config \
  journeyover/plex-auto-languages:main

---

Python Installation

Follow these steps for a native Python setup:

1. Clone the Repository:

   git clone [email protected]:JourneyDocker/Plex-Auto-Languages.git

2. Install Dependencies:

   cd Plex-Auto-Languages
   python3 -m pip install -r requirements.txt

3. Create Configuration File:

   Use the template in the default configuration file to create your own config.yaml. Only plex.url and plex.token are required.

4. Run the Application:

   python3 main.py -c ./config.yaml

Configuration

The application can be configured using either:

• Environment Variables
• YAML File (mounted at /config/config.yaml; see config.example.yaml for example config)

Key Parameters

Plex Configuration

plex:
  url: "http://plex:32400"  # Required: Plex server URL
  token: "MY_PLEX_TOKEN"    # Required: Plex Token

Update Settings

plexautolanguages:
  update_level: "show"          # Options: "show" (default), "season"
  update_strategy: "all"        # Options: "all" (default), "next"
  trigger_on_play: true         # Update language when playing an episode
  trigger_on_scan: true         # Update language when new files are scanned
  trigger_on_activity: false    # Update language when navigating Plex (experimental)
  refresh_library_on_scan: true # Refresh cached library on Plex scans
  ignore_labels:                # Ignore shows with these Plex labels
    - PAL_IGNORE

Notifications (Optional)

Configure notifications with Apprise:

notifications:
  enable: true
  apprise_configs:
    - "discord://webhook_id/webhook_token"

Advanced Options

scheduler:
  enable: true
  schedule_time: "04:30"
data_path: ""  # Path for system/cache files
debug: false   # Enable debug logs

Environment Variable Summary

Environment Variable	Default Value	Description
PLEX_URL	(none)	URL to your Plex server. Replace IP_ADDRESS with your actual Plex server address.
PLEX_TOKEN	(none)	Plex authentication token.
UPDATE_LEVEL	show	Determines whether the update applies to the entire show or just the current season. Accepted values: show, season.
UPDATE_STRATEGY	next	Chooses whether to update all episodes or only the next one. Accepted values: all, next.
TRIGGER_ON_PLAY	true	If set to true, playing an episode triggers a language update.
TRIGGER_ON_SCAN	true	If set to true, scanning for new files triggers a language update.
TRIGGER_ON_ACTIVITY	false	If set to true, browsing the Plex library triggers a language update.
REFRESH_LIBRARY_ON_SCAN	true	Refreshes the cached library when the Plex server scans its library.
IGNORE_LABELS	PAL_IGNORE	Comma-separated list of Plex labels. Shows with these labels will be ignored.
SCHEDULER_ENABLE	true	Enables or disables the scheduler feature.
SCHEDULER_SCHEDULE_TIME	02:00	Time (in HH:MM format) when the scheduler starts its task.
DEBUG	false	Enables debug mode for verbose logging.

Note

The Plex Token can also be provided as a Docker secret, the filepath of the secret must then be specified in the environment variable PLEX_TOKEN_FILE which defaults to /run/secrets/plex_token.

License

This project is licensed under the MIT License.