ImageMaid

ImageMaid

Docker app from Sohjiro's Repository

Overview

ImageMaid is a script developed by the Kometa team. This tool is designed to help manage and clean up Plex directories by removing unused overlays, custom artwork, and clearing the PhotoTranscoder Directory. It also automates Plex maintenance tasks like emptying trash, cleaning bundles, and optimizing the database.

Runtime arguments

Network
bridge
Shell
sh
Privileged
false

Template configuration

Config DirectoryPathrw
Target
/config
Value
/mnt/user/appdata/Overlay-Reset/
Plex Config DirectoryPathrw

Plex Config Directory containing the servers Metadata including Cache, Metadata, and Plug-in Support folders.

Target
/plex
Plex Config Directory (--plex)Variable

Can set the Plex Config Directory if its not mapped to /plex.

Target
PLEX_PATH
Mode (--mode)Variable

How ImageMaid runs depends on the Mode Option that's currently set for that run.

Target
MODE
Default
report|move|restore|clear|remove|nothing
Plex URL (--url)Variable

Plex URL for downloading the Database from the Plex API.

Target
PLEX_URL
Plex Token (--token)Variable

Plex Token for downloading the Database from the Plex API.

Target
PLEX_TOKEN
Use Local Database (--local)Variable

Use the local /plex directory to grab the database.

Target
LOCAL_DB
Default
False|True
Ignore Runnng (--ignore)Variable

Allows a run while the database is currently in use.

Target
IGNORE_RUNNING
Default
False|True
Use Existing (--existing)Variable

Use previously downloaded or copied database can be used if it's less than 2 hours old.

Target
USE_EXISTING
Default
False|True
Photo Transcoder (--photo-transcoder)Variable

Also clean then PhotoTranscoder Directory.

Target
PHOTO_TRANSCODER
Default
False|True
Empty Trash (--empty-trash)Variable

Also run the Empty Trash Plex Operation.

Target
EMPTY_TRASH
Default
False|True
Clean Bundles (--clean-bundles)Variable

Also run the Clean Bundles Plex Operation.

Target
CLEAN_BUNDLES
Default
False|True
Optimize DB (--optimize-db)Variable

Also run the Optimize DB Plex Operation.

Target
OPTIMIZE_DB
Default
False|True
Overlays Only (--overlays-only)Variable

Will only remove Kometa Overlay Images and other images will be ignored.

Target
OVERLAYS_ONLY
Default
False|True
Discord URL (--discord)Variable

Discord Webhook URL to send notifications to.

Target
DISCORD
Timeout (--timeout)Variable

Connection Timeout in seconds that's greater than 0.

Target
TIMEOUT
Default
600
No Verify SSL (--no-verify-ssl)Variable

Turn SSL Verification off.

Target
NO_VERIFY_SSL
Default
False|True
Sleep (--sleep)Variable

Sleep Timer between Empty Trash, Clean Bundles, and Optimize DB in seconds that's greater than 0.

Target
SLEEP
Default
60
Trace (--trace)Variable

Run with extra trace logs.

Target
TRACE
Default
False|True
Log Requests (--log-requests)Variable

Run with every request and file action logged.

Target
LOG_REQUESTS
Default
False|True
Continuous Schedule (--schedule)Variable

See https://kometa.wiki/en/latest/kometa/scripts/imagemaid/#continuous-schedule for how to schedule.

Target
SCHEDULE

Download Statistics

409,630
Total Downloads
35,325
This Month
31,413
Avg / Month

Total Downloads Over Time

Loading chart...

Details

Repository
kometateam/imagemaid
Last Updated2026-05-02
First Seen2025-01-05

Run ImageMaid on Unraid.

ImageMaid is listed in Community Apps for Unraid OS. Explore Unraid to build a flexible home server, NAS, or homelab.