diff --git a/docs/Collections.md b/docs/Collections.md index 5977a3bd4..f4526ac33 100644 --- a/docs/Collections.md +++ b/docs/Collections.md @@ -25,6 +25,8 @@ A collection will be reflected in your media server when it contains media. When If the `Show on home` option was checked, the collection will be shown on all users' home screens. This allows you to create, for instance, a 'Leaving soon' list. +The `Keep in Maintainerr only` option on a rule group turns this off for that one collection. Maintainerr then creates nothing on your media server and syncs nothing to it, so there is no collection there to browse or to add media to by hand. The collection still works everywhere else in Maintainerr: rules pick up media, the deletion countdown runs, and actions, overlays, and \*arr tags all apply. See [Creating rules](./Rules.mdx#general). + ## Collection items sort When Plex is your configured media server, the rule group or collection form can also save a `Collection items sort` value for Maintainerr-managed collections. diff --git a/docs/Rules.mdx b/docs/Rules.mdx index 6603d75a4..02fdd52b7 100644 --- a/docs/Rules.mdx +++ b/docs/Rules.mdx @@ -96,6 +96,7 @@ General info about the rule. Some of the information specified here will be show | 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. | | Custom collection | Use a manually created collection. Maintainerr will never automatically add or remove this collection from your media server. | | Custom collection name | The name of the existing manually managed collection to use | +| Keep in Maintainerr only | Keep this collection inside Maintainerr and create nothing on your media server. Rules, actions, overlays, and \*arr tags all keep working. Off by default, set per collection, and hidden while `Custom collection` is on. | Maintainerr only shows `Force reset Seerr record` for movie, show, and season rules. Episode rules always rely on Seerr's normal availability sync because Seerr tracks requests at the season level, not per episode. If an older episode rule still has this option saved, re-saving the rule clears it. @@ -103,6 +104,8 @@ When you choose `Change quality profile and search` for Radarr or Sonarr, Mainta The `Tag this content` option keeps a Radarr/Sonarr tag named after the rule group on each matching item for as long as it stays in the collection, and removes it when the item leaves. Because Sonarr tags apply to the whole series, the option is offered for movie collections (Radarr) and whole-show collections (Sonarr) only - not season or episode collections. The tag is created on the \*arr instance if missing, the rule group's name is normalized to the tag character set Radarr/Sonarr accept (lowercase letters, numbers, and hyphens), and tagging is best-effort, so it never blocks a rule run. Renaming a rule group applies the new tag on the next membership change but leaves the previous tag in place until you remove it. +`Keep in Maintainerr only` is for collections that exist to hold media for review, tag it in the \*arrs, or count down to an action, rather than to be browsed on the media server. Membership, the countdown, actions, overlays, and tags all read Maintainerr's own records, so they behave exactly as they would otherwise. Turning it on tears down a collection Maintainerr already created on the media server; turning it off lets the next rule run recreate it. It cannot be combined with `Custom collection`, which by definition points at a collection that already exists on the server. + For Sonarr season rules, additional actions are available to also clean up the parent show when it becomes empty after season processing. Never-downloaded later seasons do not block those parent-show cleanup actions. Maintainerr only treats a monitored season as still keeping the show active when Sonarr reports episode files for that season. diff --git a/static/openapi-spec/maintainerr_api_specs.yaml b/static/openapi-spec/maintainerr_api_specs.yaml index 4e8d32dda..6e51271dd 100644 --- a/static/openapi-spec/maintainerr_api_specs.yaml +++ b/static/openapi-spec/maintainerr_api_specs.yaml @@ -292,6 +292,54 @@ paths: description: Updates the primary metadata provider. tags: - /settings + /api/settings/telemetry/preview: + get: + operationId: SettingsController_previewTelemetry + parameters: [] + responses: + '200': + description: >- + Returns the exact report this server would send, detail block + included, so it can be reviewed before anything is sent. + tags: + - /settings + /api/settings/telemetry/status: + get: + operationId: SettingsController_telemetryStatus + parameters: [] + responses: + '200': + description: >- + Returns forcedOff, set when TELEMETRY=off is in the environment, + with the ISO timestamps of the next weekly report and of the next + one that also carries the detail block. Both timestamps are null + when nothing is being sent. + tags: + - /settings + /api/settings/telemetry: + post: + operationId: SettingsController_updateTelemetrySetting + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + enabled: + type: boolean + description: Whether the weekly usage report is sent. + required: + - enabled + responses: + '201': + description: >- + Stores the telemetry choice. Answers status NOK when TELEMETRY=off + is set in the environment, since a stored value would change + nothing. + tags: + - /settings /api/settings/metadata/refresh/{provider}: post: operationId: SettingsController_refreshMetadataCache