On this page
Tdarr: For developers
How Tdarr 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
starboard-plugin.jsoninstall.pylogo.svgtests/test_app_plugins.py, the checks it shares with the other app plug-ins
How it works
- It has no code of its own: Starboard runs the app's own image, pinned by digest, with the limits in
resources. - Its container is on the
lannetwork withpublishset.network:portlets Starboard open its page on the home network.host_portis the port Starboard tries first. When it is in use, Starboard takes the next free one and shows it on the tab. - It has no
settings,cards,actionsorhealthin its manifest, so Starboard waits for its container to start after an update. Its Settings section is Starboard's own Tdarr settings (APP_SETTINGSin Starboard'splugins.js), which Starboard writes into Tdarr through Tdarr's own API. - It runs read only, as a user that is not root, with no extra rights. What it writes goes in its own folder,
data/plugins/tdarr. - It runs as
media, the owner of your media folder (plug-in API 1.12), so it can replace a file with its smaller copy and the new file is yours. It can write tomedia/movies,media/tvandmedia/tdarr-cache, and nothing else in the media folder. - Its environment runs Tdarr's server with an internal node called
starboard(internalNode), with its web page on 8265 and the server on 8266.data/node-pluginsgives the node a folder it may write to for Tdarr's own plug-ins, and/runis atmpfs. adoptlets Starboard copy the Tdarr from the main install (the container calledtdarr) into theservercontainer's folders:/app/server,/app/configsand/app/logs.stopis true, so Starboard stops the old Tdarr first, to copy its files whole. It copies, and never moves or deletes the old folders.
Containers
| Container | Network | Folders | Runs as | Starts | Limits |
|---|---|---|---|---|---|
server |
lan |
data/server:/app/server, data/configs:/app/configs, data/logs:/app/logs, data/cache:/temp, data/node-plugins:/app/Tdarr_Node/assets/app/plugins, media/tdarr-cache, media/movies, media/tv |
media |
always |
2048 MB, 2 cores, 512 processes |
Each image is pinned by digest in the manifest:
server:ghcr.io/haveagitgat/tdarr@sha256:84743e5ae433a5b49cb463b2dff2679eb02f0cac24fb88c830f49bf8aa9f1c04
Find out more
This page on GitHub, where the help is written.