ImageMaid
ImageMaid is a script used to mass-delete images in Plex. It can clean the PhotoTranscoder Directory and run Plex operations such as Empty Trash, Clean Bundles, and Optimize DB.
Make sure to configure the application properly to avoid breaking our Fair Usage Policy. For detailed instructions on how to configure the application, follow this link.
Prerequisites
- Python version 3.11 or above. See here.
- Plex server installed on service.
Installation
- Connect to your Ultra.cc service via SSH.
- Execute the following command:
bash <(wget -qO- https://scripts.ultra.cc/comm-v1/ImageMaid/main.sh)- Type
1and pressENTERto proceed with the installation. - Wait until installation has finished.
Usage
Configuration
As ImageMaid is not a GUI application, all configuration must be done by editing the .env file. Luckily, Kometa offers great documentation on their wiki. By default, the unofficial installer script will configure the .env file with the bare necessities needed for ImageMaid to work. This includes your Plex server URL, token and mode.
- Config file:
~/scripts/imagemaid/config/.env - Config template:
~/scripts/imagemaid/config/example.env
By default the script will make the mode to be report. Following schedules are added in configurations:
- Daily 7 AM - Report
- Weekly (Sunday) 9 AM - Move
- Weekly (Sunday) 11 AM - Clear
You can read more about the different modes here, and you can read more about the schedules on the wiki.
Log file
- Log file:
~/scripts/imagemaid/logs/error.log
Stop/Restart Kometa
- To stop the service:
systemctl --user stop imagemaid.service- To start/restart the service:
systemctl --user restart imagemaid.serviceUninstallation
- Connect to your Ultra.cc service via SSH.
- Execute the following command:
bash <(wget -qO- https://scripts.ultra.cc/comm-v1/ImageMaid/main.sh)- Type
2and pressENTERto proceed with the uninstallation.
If you require further assistance, you can open a support ticket here!
Feedback and suggestions regarding this article are welcome on our Discord server