Checkrr

Version 1.0.0 · plug-in API >=1.14 <2.0

PublishedHow to add it
On this page

Checkrr: Settings

Checkrr's settings are on its own tab: go to Settings, then Plug-ins, then Checkrr. Starboard draws them.

Settings

Setting What it does Default
Files that failed the check A page of its own: each file Checkrr could not read as a film or episode in its last check, grouped into Films and Series, with Checkrr's reason and when it found it. You can read it, but not change it. None

Buttons

These are on Checkrr's tab.

  • Check now starts a check straight away, after you confirm, rather than waiting for Sunday night. It reads each file and changes nothing.

What it checks

  • Which files: everything in your movies and tv folders, except pictures, subtitles and text files such as .nfo, .srt and .jpg, and folders whose names start with a dot.
  • How: the start of each file must be a known film, episode or sound file, and FFprobe must read it. A film or episode with no sound track also fails.
  • What it finds: files whose start is damaged, files that are not media at all, and videos with no sound. A file cut short part way through can pass, because the deeper check that plays each file through FFmpeg is not used here: it would take far more of the processor every week.
  • When: each Sunday at 03:30, in the server's time zone, and when you select Check now. A file that passed is remembered, so the next check skips it unless it changed.

Things to note

  • It only reports. It never deletes, moves, renames or replaces a file, and it cannot: your folders are read only to it, and it is given no Reelix, Radarr, Sonarr or Lidarr.
  • Its settings file is data/plugins/checkrr/data/app/checkrr.yaml in Starboard's data. Starboard writes it once, when Checkrr first starts, and never over a change you make. Change it only if you know Checkrr well, then deactivate and activate the plug-in.
  • Its own page lists the same files and its figures. Anyone on your home network can open it and start a check or clear its list: clearing the list does not touch the files.
  • Its list and figures are kept when you update or deactivate it, and when you remove it they stay in its folder.

Find out more

This page on GitHub, where the help is written.