How it works

Basic Idea¶

Some people come to Maintainerr because they heard it was the solution to whatever problem they were having. Not everyone understands completly, what Maintainerr even is and how to use it.

Quick Rundown¶

Maintainerr looks through your Plex media, to find items that match against the given ruleset. Rulesets can be as easy or as complex as you want.

Plex- Date added before 90 days
AND
Plex- Viewed by username contains Overseerr- requested by username

Once the rule is setup and the rule handler has ran (every 8 hours by default), Maintainerr will add all of this rules matches to a Collection. This collection, once it has matched items inside of it, will get synced to Plex. There are various options as to where you want this collection displayed on your Plex server, but at the very least they will be inside of your library on the Collections tab.

Take action after days¶

Within the rule creation page there is a setting called Take action after days along with a setting called Sonarr/Radarr/Plex action. Which actions that are available depends on the Library and if you chose a configured Sonarr or Radarr server. An in-depth look at the rule creation settings can be found here → Walkthrough S01E01

Take action after days is how long media will be in this collection before action is taken against it. The action is setup by you when creating the rule. Options include delete, unmonitor and delete, unmonitor and keep, delete season, unmonitor season and keep files, etc.

Maintainerr will periodically run its Collection handler task (every 12 hours by default), and anything in a collection that meets the Take action after days deadline, action will be taken against it.

TLDR;¶

Maintainerr creates collections, synced with Plex, of items that match your ruleset. These items sit in the collection, displayed in various places on your Plex server, and once a set amount of time has passed, the items are removed/unmonitored. If you setup a rule to catch unwatched items, something got added to a collection, and then the item was watched...Maintainerr will remove it from the collection as it no longer meets the rule criteria (i.e. it is no longer queued for removal).

Requirements/Limitations¶

• Maintainerr uses Plex as its source of media. Everything has to be in your Plex server for Maintainerr to do anything with it.
• Setting Take action after days to 0 will not trigger anything based on a schedule. However, it does let you manually take action with the Handle Collections button. 1 is the minimum.
• You do not have to have Radarr or Sonarr setup in Maintainerr. However, you do have to if you want to use those rules.
• Maintainerr does have multiple *arr instance capability. We do not currently support mixed HD and UHD Plex libraries from within the same rule.
• Certain rules are only available based off the Library and Media type (show/season/episode).
• The data location within the container is /opt/data. This is where your log files live as well as the sqlite file that holds all of your settings.
• If you do not have a persistent host volume tied to this location, when you update Maintainerr, it will all be gone. Installation.
• The rule handler runs rules from top to bottom. Pay special attention to the order of your rules, to acheive the desired outcome.
• Maintainerr does not have authentication. Authentication Suggestion and Feature Request

Helpful links¶