Configuration

User-defined variables (files/cfg/config.yaml)

Before first run of the container:

• Copy files/cfg/config.yaml.template and rename it to files/cfg/config.yaml
• Read through this document and change the configuration to your liking
• Use YAML formatting (Can be easily validated with any yaml validation tool)

Schedule

• run_schedule: This allows for executing the script at a regular interval without user intervention. Schedule should use cron format. Sites like crontab guru can help generate a schedule.
  • 0 4,8,12,16,20 * * *: Default schedule runs every 4 hours

Paths

• use_out_path:
  • false will convert files in-place (in the directory in which they already exist)
  • true will output converted files to the directory mapped to /outpath in the container and retain original files in /media.

Conversion

• include_file_types: List of extensions to be converted in the format *.ext1, *.ext2.
  • '*.mkv, *.avi, *.mp4': Will convert files with the extensions of .mkv, .avi, and .mp4
• use_set_metadata_title: Uses best-effort to alter a file's metadata to reflect information scraped from the file name.
  • true: Will set file metadata to match the file title
  • false: Feature is disabled
• failover_threshold:
• .60: Will trigger failover to Handbrake if the converted file is less than 60% of the size of the original

Audio

• force_stereo_clone: Feature that will create a stereo clone of any non-stereo audio channel, while retaining the original audio channel.
  • false: Feature is disabled
  • true: Feature is enabled

Subtitle

• keep: Whether to keep existing subtitles or delete them
  • false discards subtitles from converted files.
  • true keeps existing subtitle tracks

Logging

• rotate: Allows user to specify log retention period in days
  • 7: Will keep logs for 7 days before deleting them
• use_ignore_list: The ignore list feature will keep track of which files have already been processed successfully, and skip them on subsequent runs.
  • true: enables the ignore list feature, reducing script execution times and making logs easier to parse
  • false will disable the ignore list and scan (and log) every file in /media on every execution.

Plex configuration

• enable: If enabled, Plex libraries will be refreshed after every successful conversion
  • true: to enable feature
  • false to disable feature
• ip: the IP address and port (generally 32400) of your Plex server
• token: your Plex server's token
  • NOTE: Plex server token - See https://support.plex.tv/hc/en-us/articles/204059436-Finding-your-account-token-X-Plex-Token.

Cleanup

• enable: When enabled, this feature will delete files with user-defined extensions in /media
  • true: enables feature
  • false disables feature
• include_file_types: filetype extensions you want cleaned up the format "*.ext1", "*.ext2".
  • '*.nfo, *.idx: Will delete .nfo and .idx files found during execution

Notifications

• check_for_updates: When enabled, shows update notifications in the logs and webUI
  • true: enables feature
  • false disables feature