Skip to content

docs: bound the deletion window and cover the background overlay run #156

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
enoch85 merged 1 commit into from
Aug 20, 2026
Merged

docs: bound the deletion window and cover the background overlay run #156

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions docs/Overlays.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,9 @@ The `Settings` tab contains the global controls for overlay processing. Overlay

- `Enable overlays` is the master switch.
- `Run Now` starts an overlay run immediately, instead of waiting for the next scheduled one. It also redraws overlays that are already up to date, which a scheduled run leaves alone. Use it after another artwork tool or a manual edit has replaced an overlay.
- `Reset All Overlays` puts the original artwork back on every item Maintainerr has drawn on. Use it carefully. It is unavailable while an overlay run is going on.
- `Reset All Overlays` puts the original artwork back on every item Maintainerr has drawn on, including any item it saved an original for but has no record of drawing on. Use it carefully. It is unavailable while an overlay run is going on.

`Run Now` and `Reset All Overlays` hand the work to the server and answer straight away. The page follows the run from there, so a slow run cannot time out in the browser, and closing the page does not stop it.

## Templates

Expand All @@ -52,6 +54,8 @@ The editor lets you design overlay elements on top of a preview image.
- Image elements can use uploaded `.png`, `.jpg`/`.jpeg`, or `.webp` assets up to `500 KB`.
- Template previews are rendered server-side against real media artwork.

Maintainerr draws the template onto the largest centered area of the artwork that has the same shape as the template canvas, and leaves the rest of the image alone. Media servers crop artwork to that shape when they draw a card, so this keeps your layout where you placed it on artwork of another shape, such as a 4:3 or 21:9 still under a 16:9 title card template.

Uploaded image assets are stored by filename and appear in the image-element picker after upload. Maintainerr validates both the filename and the file contents, so renamed or unsupported files are rejected instead of being served back later with the wrong content type.

## How template selection works
Expand Down Expand Up @@ -86,7 +90,7 @@ A countdown says the media leaves the library on that date, so a collection whos

Maintainerr re-renders overlays when the visible days-left value changes, and it can revert overlay artwork for a single collection or for all collections.

Deleting a collection restores its overlays first, so its items keep their original artwork.
Deleting a collection restores its overlays first, so its items keep their original artwork. If a run is going on at the time, that restore waits for the run to finish instead of being skipped.

## Media that gets deleted along with a collection

Expand Down
2 changes: 1 addition & 1 deletion docs/Rules.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ General info about the rule. Some of the information specified here will be show
| Show on home | Show the rule's collection on the home screen |
| Add list exclusions | Prevent \*arr import lists from re-adding media that has been removed by Maintainerr |
| Tag this content | Tag matching movies (Radarr) or shows (Sonarr) with a tag named after this rule group while they are in the collection, removed when they leave. Only shown for movie collections with a Radarr server selected, or whole-show collections with a Sonarr server selected. |
| Media deleted after days | Amount of days media will live in the collection before deletion |
| Media deleted after days | Amount of days media will live in the collection before deletion. A whole number from 0 to 36500. |
| Clean up leftover folders | (BETA) When enabled, Maintainerr removes the folder the \*arr leaves behind after deleting files one at a time, along with its sidecars (subtitles, .nfo, artwork). Off by default. Only shown when the selected action strands a folder. Requires the media library mounted into Maintainerr at the same path as the \*arr. See [Leftover folder cleanup](./Collections.md#leftover-folder-cleanup). |
| Use rules | Disable the rule engine, for when you want to add media to the collection manually |
| Force reset Seerr record | Force resets the Seerr record by deleting any requests instead of relying on availability-sync. 'Enable CSRF Protection' needs to be disabled in Seerr's settings for this to work. <InlineTooltip label="+" tooltip="An alternative way of telling Overseerr that something has been removed. By default Maintainerr asks Overseerr to run an Availability Sync through its API, which happens automatically at the end of the collection handler job. This option is not available for Jellyseerr." /> |
Expand Down
8 changes: 4 additions & 4 deletions static/openapi-spec/maintainerr_api_specs.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1705,8 +1705,8 @@ paths:
type: boolean
description: Force a reapply pass even when overlay state already matches the current day count.
responses:
'201':
description: Runs overlay processing for all eligible collections and returns processed, reverted, skipped, and error counts.
'202':
description: Starts overlay processing for all eligible collections. The run continues in the background; follow it on GET /api/overlays/status.
'409':
description: Returned when another overlay-processing run is already active.
tags:
Expand Down Expand Up @@ -1744,8 +1744,8 @@ paths:
operationId: OverlaysController_resetAll
parameters: []
responses:
'200':
description: Reverts all overlays.
'202':
description: Starts reverting all overlays. The reset continues in the background; follow it on GET /api/overlays/status.
'409':
description: Returned when another overlay-processing run is already active.
tags:
Expand Down