Direct play: Install
Add Direct play 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, Direct play 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. Direct play tells Jellyfin when a file changed. Reelix is told too, when you have it.
- Your films in a movies folder and your series in a tv folder, in your media folder. Direct play works only there.
- To know which devices everyone in your home watches on.
- 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 |
Use Reelix's API key, kept by Starboard (reelix: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/direct-play), themoviesfolder in your media folder, to read and change, thetvfolder in your media folder, to read and change.
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: 512 MB of memory and one processor core at most. ffmpeg runs only while a file is fixed, at the lowest processor and disk priority, with two threads at most.
These figures are the most it may use.
Add it
- Go to Settings, then Plug-ins, then Catalogue.
- Under Jellyfin, find Direct play 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 Direct play. To stop, select Cancel: nothing is installed.
- Direct play's own tab opens under Settings, then Plug-ins. Select Finish setting up.
- In Devices, activate each kind of device anyone in your home watches on, and deactivate any you do not have.
- In When it works, choose when it may convert files. At weekends is chosen when you add it.
- Select Activate. Its state changes to Active.
- Add its cards to your dashboard. Read Dashboard card.
It starts by checking your library, then fixes one file at a time in the hours you chose.
Tip: Direct play is marked Recommended in the catalogue.
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/direct-play/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 Direct play.
- Under Remove, select Remove Direct play.
- 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. Files it already changed in your media folder stay as they are.
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.