On this page
How-to
Take over the apps you already run
If you set up your media server by hand, with your own Compose file, Starboard can take it over. It moves Radarr, Sonarr, Lidarr, Readarr (or Bookshelf), Prowlarr and Seerr into Reelix. It then runs your other apps, such as Jellyfin, Audiobookshelf and qBittorrent, from its own set-up, so Settings, Apps, Your install can change them later. Each app keeps its settings, its ports and what it relies on, and you can go back.
Before you begin
- Starboard has Docker access. Without it, Starboard cannot stop or start your apps.
- Your apps are running and were started from a Compose file (
docker compose up). Apps that are stopped, or that were started another way, are left as they are. - There is room on the disk for a copy of your apps' settings. Starboard checks before it copies, and stops if there is not.
- You know your Starboard password, and your qBittorrent password if you want Reelix to use qBittorrent.
Steps
The steps on the page are numbered, and the numbers change with what your server needs.
- Go to Settings, then Apps, then Your install, and find Apps you already run. Starboard lists the apps it takes over, the ones Reelix or NZBGet replaces, the ones it installs new and the ones it leaves as they are.
- If the page has an 'install Reelix' step, select Install apps and choose Full install. Apps that already run are left as they are, so it adds only what your server does not have yet, such as Reelix and NZBGet. Then come back to Your install.
- If the page has a 'finish setting up Reelix' step, select Finish setting up Reelix. On Settings, Reelix, enter Your password and select Finish setting up Reelix. Reelix's admin account gets the same password as Starboard.
- In the 'move them into Reelix' step, enter Your password, and qBittorrent's password if you want Reelix to use qBittorrent. Select Show what moves to list what Reelix adds from each app.
- Select Move them into Reelix. Films and series move in a minute or two. Reelix then finds their files, which takes about an hour for a big library. Leave Hold the sites to search selected, so only your old apps search until the next step.
- In the 'Starboard runs your apps' step, check the Settings folder. The copies of your apps' settings go there. It must not be inside the folder your apps use now.
- Enter Your password, then select Take over my apps. Your apps stop for a few minutes while their settings are copied, then start again from Starboard's set-up.
- Go to Settings, then Apps, then Reelix. Under 'Sites to search', for each site select More, then Change, activate Active and select Save. Read Choose the sites Reelix searches.
What Starboard does
- Before anything stops, it saves the way back. It tags each app's image as
starboard-rollback/<app>:<date>, so the exact version stays on the server. It copies your Compose file and its.env, and Starboard's own set-up files, intodata/stack/takeover. - It stops the apps it takes over and the ones being replaced.
- It copies each app's settings into the settings folder. It never moves them, and never writes in your old folders. A folder that already has files is never copied over: Starboard stops and starts your apps again.
- It removes the old containers. Their settings folders and images stay.
- It starts the apps from its own set-up. SABnzbd's news servers move into NZBGet, and Reelix is given NZBGet and qBittorrent by their names on Starboard's set-up.
If anything goes wrong before the old containers are removed, Starboard starts your apps again as they were and changes nothing else.
What each app keeps
- Its ports. Jellyfin stays on 8096, Audiobookshelf on 13378, and every other app on the port it had. A port the app did not use before, such as qBittorrent's 6881 when your VPN forwards a port, stays closed.
- The folders it uses as they are, such as Jellyfin's
/media, so your libraries and watch history stay. - Devices, such as
/dev/drifor hardware transcoding. - Its own settings in the Compose file, such as Jellyfin's published address or Gluetun's port forwarding.
Passwords and keys go in
data/stack/.env, which only you can read. - Its version, when you chose one, such as a pinned qBittorrent.
- Whether it runs through the VPN.
Starboard keeps all this in data/stack/kept.json, so later changes in Your install keep it too.
Roll back
Until you choose Keep it, Apps you already run shows Roll back.
- Enter Your password, then select Roll back.
- Starboard stops the apps it took over, puts its own set-up back as it was, and starts your old apps from your own Compose file, on the versions they ran.
Anything that changed since the takeover, such as new downloads in the new qBittorrent or new watch history in Jellyfin, is not in your old apps: they carry on from the moment they stopped.
Keep it
Once everything works, select Keep it. The way back is moved aside to data/stack/takeover-kept-<date>, and
nothing is deleted. Your old settings folders and the starboard-rollback images stay until you remove them.
Things to note
- Your own Compose file still lists the old apps. Do not start it with
docker compose upwhile Starboard runs them: the container names are taken, so it fails for those apps. - Jellyfin's pictures and details move after the takeover, out of its settings folder into the jellyfin-metadata folder beside it, so Jellyfin watches far fewer folders. Jellyfin stops for a few minutes while they move, and a link stays at the old address so every picture still shows. Nothing is deleted. To follow it, go to Settings, then Jellyfin, then Pictures and details.
- Apps the install does not have, such as Kapowarr, and apps that are stopped, are left as they are in your own Compose file.
- What does not move into Reelix is listed in Move from Radarr, Sonarr and the others to Reelix.
If it does not work
- "Choose a settings folder outside ...": the settings folder is inside, or holds, a folder your apps use now.
Choose another one, such as
/srv/media-stack/config. - "Already has files, so nothing was copied over it": the settings folder has files from before. Choose an empty one. Your apps run again as they were.
- "Not enough space": free some space on the disk with the settings folder, or choose a settings folder on another disk.
- "Move ... into Reelix first": do the 'move them into Reelix' step first, or tick Stop ... without moving them into Reelix.
- "qBittorrent did not accept that password": enter the password you use to sign in to qBittorrent, or leave it empty and add qBittorrent later in Settings, Apps, Reelix, under 'Download apps'.
Find out more
This page on GitHub, where the help is written.