Watch statistics: Install
Add Watch statistics from Starboard's Catalogue, where it is listed under Jellyfin. Starboard shows what it may do and tests it before anything is added. At the end, Watch statistics is active and its card is ready for your dashboard.
Before you begin
- Starboard with plug-in API 1.14 or later. An older Starboard is offered an earlier version: read Updates.
- Jellyfin added to Starboard, in Settings, then Apps. Watch statistics uses the key Starboard keeps for it.
- Playback Reporting in Jellyfin, for the full figures. Without it, Watch statistics shows only each person's last play of each title.
- Your Starboard password. Adding and removing a plug-in ask for it.
What it may do
Starboard lists these before you add it, each with its risk.
| Permission | Risk |
|---|---|
Use Jellyfin's API key, kept by Starboard (jellyfin:key) |
High |
Reach other computers on your home network, and the internet (network:lan) |
Medium |
What it runs:
- main: reaches your home network and the internet, and this computer as
host.docker.internal. It can use its own folder in Starboard's data (data/plugins/watch-stats). It rests after 5 minutes with nothing to do, and Starboard wakes it when it is needed.
Like every plug-in, it runs read only, as a user that is not root, with no extra rights. Its image is pinned by digest, so what you approved is what runs.
Memory and processor
- main: 64 MB of memory and 0.25 of a processor core at most.
Measured:
- About 14 MB for a few seconds when a card or table asks; it rests the rest of the time.
Add it
- Go to Settings, then Plug-ins, then Catalogue.
- Under Jellyfin, find Watch statistics and select Install….
- A slide-out opens with what it can read, change and reach. Read it all.
- Enter your Starboard password and select Install Watch statistics. To stop, select Cancel: nothing is installed.
- Watch statistics's own tab opens under Settings, then Plug-ins. Select Activate. Its state changes to Active.
- Check its Watch statistics source card or its tables. If they say "Playback Reporting is not installed in Jellyfin", go on to the next step. Otherwise, you are done.
- Add Playback Reporting in Starboard's Settings, then Jellyfin, or in Jellyfin's Dashboard, then Plugins, then Catalogue.
- Restart Jellyfin. Playback Reporting counts from then on, so the figures grow from that day.
Add it by its address
On the Catalogue page, under Add one from elsewhere, paste this into The plug-in's manifest address, then select What it does and carry on from step 3:
https://raw.githubusercontent.com/TheMightyTRex/starboard-plugins/main/watch-stats/starboard-plugin.json
Or run its installer, install.py in its folder, on any computer with Python, and give your Starboard's address.
Remove it
- Go to Settings, then Plug-ins, then Watch statistics.
- Under Remove, select Remove Watch statistics.
- Choose where its folder goes: Keep it with Starboard's data (in
data/plugins/.removed) or Move it to the holding folder, listed in System, Clean up, where you can put it back or delete it for good. - Enter your Starboard password and select Remove.
Its containers stop and go, and its API key stops working. Nothing is deleted.
To stop it for a while instead, select Deactivate on its tab: its settings and folder are kept.
Find out more
This page on GitHub, where the help is written.