Skip to content

Commit 122a12e

Browse files
committed
docs: address 3.8.0 → HEAD drift (#42)
- Glossary: rename sw_allEpisodesSeenBy / sw_watchers entries to match the new humanNames in rules.constants.ts (Plex, Jellyfin, Tautulli) - Notifications: add ntfy agent (URL, Topic, Token) - Collections: add Custom Poster section (one-shot writer, 500 KB cap, survives collection recreation) - Overlays: add "Coexisting with other artwork tools" section noting Kometa/Posterizarr behaviour — per-item overlays reconcile on every cron tick, collection posters are last-writer-wins
1 parent 606ff94 commit 122a12e

4 files changed

Lines changed: 54 additions & 12 deletions

File tree

docs/Collections.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,22 @@ Collections now power additional Maintainerr views beyond cleanup.
2828

2929
In the rule or collection form, you can enable overlays per collection and optionally choose a specific overlay template. Movies, shows, and seasons use poster templates. Episode collections use title card templates.
3030

31+
## Custom Poster
32+
33+
Maintainerr can store one custom poster per Maintainerr-managed collection and push it to the current media server. The stored file survives normal collection recreation, so you don't need to re-upload artwork after Plex or Jellyfin drops a collection and Maintainerr creates it again.
34+
35+
The poster picker is available in the rule group's edit modal once the collection exists in Maintainerr.
36+
37+
- Uploads accept JPEG, PNG, or WebP up to 500 KB. The image is normalized to JPEG before being stored.
38+
- The poster is pushed to the media server immediately on upload when the collection has a live media-server id. If the live push fails or the collection has no live id yet, the local file is still kept and pushed automatically when Maintainerr next recreates the collection.
39+
- Clearing a poster removes Maintainerr's stored file and sends a best-effort metadata refresh request to the media server. Whether the server replaces the artwork depends on its configured metadata/image agents.
40+
- Deleting a Maintainerr collection also removes its stored poster file.
41+
42+
:::note One-shot writer
43+
Maintainerr writes the poster on upload and on collection recreation, then stops. It does not poll or reapply on a schedule, so it won't fight other artwork tools (e.g. Kometa, Posterizarr) or manual changes made directly in Plex or Jellyfin after the upload.
44+
45+
:::
46+
3147
## Manual actions
3248

3349
### Adding

docs/Glossary.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -161,10 +161,10 @@ List of genres associated with the Plex item.
161161
- Availability: movies, shows, seasons, episodes
162162
- Type: text[]
163163

164-
#### Users that saw all available episodes
164+
#### Users that watched every episode
165165

166166
:::info
167-
List of users who have seen all available episodes of the Plex item. This rule is only available for shows.
167+
List of users who have watched every available episode of the Plex item. This rule is only available for shows.
168168

169169
:::
170170

@@ -249,10 +249,10 @@ The total number of views for the Plex item. This rule is only available for sho
249249
- Availability: shows, seasons, episodes
250250
- Type: number
251251

252-
#### Users that watch the show/season/episode
252+
#### Users that watched at least one episode
253253

254254
:::info
255-
List of users who watch the Plex item. This rule is only available for shows.
255+
List of users who have watched at least one episode of the Plex item. This rule is only available for shows.
256256

257257
:::
258258

@@ -691,10 +691,10 @@ List of genres associated with the Jellyfin item.
691691
- Availability: movies, shows, seasons, episodes
692692
- Type: text[]
693693

694-
#### Users that saw all available episodes
694+
#### Users that watched every episode
695695

696696
:::info
697-
List of users who have seen all available episodes of the Jellyfin item.
697+
List of users who have watched every available episode of the Jellyfin item.
698698

699699
:::
700700

@@ -779,10 +779,10 @@ The total number of views for the Jellyfin item. This rule is only available for
779779
- Availability: shows, seasons, episodes
780780
- Type: number
781781

782-
#### Users that watch the show/season/episode
782+
#### Users that watched at least one episode
783783

784784
:::info
785-
List of users who watch the Jellyfin item. This rule is only available for shows.
785+
List of users who have watched at least one episode of the Jellyfin item. This rule is only available for shows.
786786

787787
:::
788788

@@ -1741,21 +1741,21 @@ List of Plex usernames who have viewed (according to Tautulli) the Plex item. Th
17411741
- Availability: movies
17421742
- Type: text[]
17431743

1744-
#### Users that saw all available episodes
1744+
#### Users that watched every episode
17451745

17461746
:::info
1747-
List of users who have seen (according to Tautulli) all available episodes of the Plex item. The percentage for an episode to be considered as viewed is configured in the Tautulli settings.
1747+
List of users who have watched (according to Tautulli) every available episode of the Plex item. The percentage for an episode to be considered as viewed is configured in the Tautulli settings.
17481748

17491749
:::
17501750

17511751
- Key: Tautulli.sw_allEpisodesSeenBy
17521752
- Availability: shows, seasons
17531753
- Type: text[]
17541754

1755-
#### Users that watch the show/season/episode
1755+
#### Users that watched at least one episode
17561756

17571757
:::info
1758-
List of users who watch (according to Tautulli) the Plex item. The percentage for an episode to be considered as viewed is configured in the Tautulli settings. This rule is only available for shows.
1758+
List of users who have watched (according to Tautulli) at least one episode of the Plex item. The percentage for an episode to be considered as viewed is configured in the Tautulli settings. This rule is only available for shows.
17591759

17601760
:::
17611761

docs/Notifications.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,20 @@ You'll need the LunaSea mobile app installed and configured. The webhook setup d
112112
| Webhook URL | Yes | LunaSea webhook URL |
113113
| Profile Name | No | Specific profile name (if not using default) |
114114

115+
### ntfy
116+
117+
Send notifications to an [ntfy](https://ntfy.sh) server.
118+
119+
:::note Setup Required
120+
You can use the public [ntfy.sh](https://ntfy.sh) server or a self-hosted instance. Pick a topic name (any string) and, if your server requires authentication, generate an access token. See the [ntfy docs](https://docs.ntfy.sh/) for setup details.
121+
122+
:::
123+
| Parameter | Required | Description |
124+
| --------- | -------- | ----------- |
125+
| URL | Yes | Base URL of the ntfy server (e.g. `https://ntfy.sh`) |
126+
| Topic | Yes | Topic name to publish notifications to |
127+
| Token | No | Bearer access token for protected topics |
128+
115129
### Pushbullet
116130

117131
Send notifications via Pushbullet.

docs/Overlays.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,18 @@ Overlay processing only applies when all of these are true:
9393

9494
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.
9595

96+
## Coexisting with other artwork tools
97+
98+
Maintainerr is one writer among several. Tools like [Kometa](https://kometa.wiki) and [Posterizarr](https://github.com/fscorrupt/Posterizarr), or manual uploads in Plex/Jellyfin, may replace Maintainerr's overlaid artwork between runs.
99+
100+
Per-item overlays carry day-counter state, so they're re-applied on every cron tick (and on demand via `Run Now`). That means:
101+
102+
- If Kometa restores its own artwork after Maintainerr writes an overlay, Maintainerr will reapply the overlay on the next run.
103+
- The cron interval determines how quickly that reconciliation happens — set it to match how often Kometa or other tools touch artwork.
104+
- After `Reset All Overlays`, Maintainerr restores its saved originals and stops re-writing. Other tools may still overwrite the artwork afterwards; that's expected.
105+
106+
Collection posters (see [Collections — Custom Poster](./Collections.md#custom-poster)) behave differently: they're a one-shot write with no schedule, so other artwork tools can win against them permanently until you re-upload.
107+
96108
## Upgrade notes
97109

98110
Recent Maintainerr releases add overlay tables and new collection fields to the database. On first startup after upgrading, allow database migration to finish before opening the Overlays pages.

0 commit comments

Comments
 (0)