Library health

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

PublishedHow to add it
On this page

Library health: For developers

How Library health is built, for anyone who wants to change it or make one like it. It is MIT, by TheMightyTRexUK, and works with plug-in API >=1.14 <2.0.

Its files

Containers

Container Network Folders Runs as Starts Limits
main lan data 10001:10001 always 96 MB, 0.25 core

Each image is pinned by digest in the manifest:

  • main: ghcr.io/themightytrex/starboard-plugin-examples@sha256:83b980f1828cdee537bcdf03702ddf6458710cba53f9009938225df430d34d9e

What Starboard calls

Path What it is
GET /health Health: 200 while it can work
GET /count The Library health card (stat)
GET /card The To fix in Jellyfin card (list)
POST /check The Check now button
POST /update/before The update's before step, 60 seconds at most
POST /update/after The update's after step, 10 seconds at most

How it works

  • app.py checks every 6 hours with every() from sbplugin.py, and when Check now sends POST /check. It asks Jellyfin for every film and series with its description, year and poster, in one request.
  • A title with no poster, no description or no year is kept in /data/result.json, with how many titles there were. Both cards read that file, so they never wait on Jellyfin.
  • The cards' status comes from band(): waiting before the first check, problem when the first check failed, warning with titles to fix and ok with none.

Find out more

This page on GitHub, where the help is written.