PreviewMaid

PreviewMaid

Docker app from Selfhosters

Overview

Preview maid is a tool to help you find missing thumbnail previews in your plex library. By default it will run on a schedule at 00:00. Optionally you can have it run once and output before exiting.

Preview Maid

Build Status Docker Pulls GitHub License

Preview Maid is a tool that scans your Plex library for missing preview thumbnails, voice activity analysis data, and marker data. It can run as a daily scheduled job at a configurable time or as a one-off job.

Supported Architectures

Architecture Available Tag
x86-64 latest
arm64 latest

Images

Registry Image
GHCR ghcr.io/fletchto99/preview-maid
Docker Hub fletchto99/preview-maid

Quick Start

Docker Compose (recommended)

services:
  preview-maid:
    image: ghcr.io/fletchto99/preview-maid:latest
    container_name: preview-maid
    environment:
      - PLEX_URL=http://your-plex-server:32400
      - PLEX_TOKEN=your-plex-token
      - RUN_TIME=02:00
    volumes:
      - /path/to/logs:/app/logs  # optional
    restart: unless-stopped

Docker CLI

docker run -d \
  --name preview-maid \
  -e PLEX_URL=http://your-plex-server:32400 \
  -e PLEX_TOKEN=your-plex-token \
  -e RUN_TIME=02:00 \
  -v /path/to/logs:/app/logs \
  --restart unless-stopped \
  ghcr.io/fletchto99/preview-maid:latest

Configuration

Environment Variables

Variable Description Default
PLEX_URL The URL to your Plex instance required
PLEX_TOKEN Your Plex API token required
FIND_MISSING_THUMBNAIL_PREVIEWS Find missing thumbnail previews true
FIND_MISSING_VOICE_ACTIVITY Find missing voice activity analysis data false
FIND_MISSING_INTRO_MARKERS Find missing skip intro markers (slow on large libraries) false
FIND_MISSING_CREDITS_MARKERS Find missing skip credit markers (slow on large libraries) false
FIND_MISSING_AD_MARKERS Find missing ad markers (slow on large libraries) false
RUN_ONCE Run once and exit instead of scheduling false
RUN_TIME Time to run the daily job (HH:MM format) 00:00
SKIP_LIBRARY_TYPES Comma-separated library types to skip (movie, show, photo) ""
SKIP_LIBRARY_NAMES Comma-separated library names to skip ""
DEBUG Enable debug logging false

Optional Volume Mounts

Mount Description
/app/logs Log file output with rotation (last 5 runs). When mounted, console output shows statistics only.

Building Missing Previews, Audio Analysis & Markers

You can force the creation of missing data using the Analyze option on the library or individual media items in Plex.

If preview thumbnail generation fails, try setting GenerateBIFKeyframesOnly to 0 in the Plex advanced settings. Note: This increases generation time and CPU load significantly.

Building Locally

git clone https://github.com/fletchto99/preview-maid.git
cd preview-maid
docker build -t preview-maid .

Install PreviewMaid on Unraid in a few clicks.

Find PreviewMaid in Community Apps on your Unraid server, review the template, and click Install. Unraid handles the Docker app or plugin setup from the published template.

Open the Apps tab on your Unraid server Search Community Apps for PreviewMaid Review the template variables and paths Click Install

Download Statistics

14,041
Total Downloads
398
This Month
398
Avg / Month

Total Downloads Over Time

Loading chart...

Related apps

Explore more like this

Explore all

Details

Repository
fletchto99/preview-maid
Last Updated2026-06-17
First Seen2024-12-30

Runtime arguments

Network
bridge
Shell
sh
Privileged
false

Template configuration

PLEX_URLVariable

The URL to your Plex instance

PLEX_TOKENVariable

Your plex token

FIND_MISSING_THUMBNAIL_PREVIEWSVariable

Set to true to find missing thumbnail previews.

Default
True|False
FIND_MISSING_VOICE_ACTIVITYVariable

Set to true to find missing voice activity analysis data.

Default
False|True
FIND_MISSING_INTRO_MARKERSVariable

Set to true to find missing skip intro markers (note this is slow on large libraries)

Default
False|True
FIND_MISSING_CREDITS_MARKERSVariable

Set to true to find missing skip credits markers (note this is slow on large libraries)

Default
False|True
FIND_MISSING_AD_MARKERSVariable

Set to true to find missing skip ad markers (note this is slow on large libraries)

Default
False|True
RUN_ONCEVariable

Set to true if you wish for only on run after which the container will terminate.

Default
False|True
RUN_TIMEVariable

The daily time to run the job in the format HH:MM.

Default
00:00
SKIP_LIBRARY_TYPESVariable

A comma separated list of library types to skip. Options are tv,movie,photo

SKIP_LIBRARY_NAMESVariable

A comma separated list of library names to skip

DEBUGVariable

Set to true if you wish to enable debug logging.

Default
False|True
Config LocationPathrw

Application log directory

Target
/app/logs
Default
/mnt/user/appdata/previewmaid/logs
Value
/mnt/user/appdata/previewmaid/logs