On this page
How-to
Remove Starboard
Stop Starboard and take it off your server with one command. Your media apps are not affected. Keep the Starboard folder, or move it somewhere safe, so you can bring your settings back if you change your mind.
Before you begin
- A terminal open on the server. Read The terminal: entering commands.
- If you might want your settings again, download a copy first. Read Back up and restore Starboard's settings.
Steps if you used the installer
- Go to the Starboard folder:
cd ~/starboard
- Stop Starboard and remove its container:
docker compose down
Starboard stops and no longer starts when the computer starts.
Steps if you installed with --native
- Stop Starboard and stop it starting with the computer:
systemctl --user disable --now starboard
Steps if you used the ready-made image
- Go to the folder that holds
compose.image.yaml:
cd ~/starboard
- Stop Starboard and remove its container:
docker compose -f compose.image.yaml down
If you activated Disk health
The installer set up a small job that checks your disks every 30 minutes. It keeps running after Starboard is gone, so remove it too.
- Go to the Starboard folder:
cd ~/starboard
- Remove the job. It asks for your password:
sudo deploy/install-smart.sh --remove
It says "Removed the Disk health timer". The reports it already saved stay in the smart folder.
If you set up Disk pools, remove the pool helper in the same way, with sudo deploy/install-pool.sh --remove.
Your pool and the files on its disks stay as they are.
Your settings and the Starboard folder
The Starboard folder still holds your settings, API keys and backups, in the data and backups folders and the
.env file. None of the steps in this article removes them.
- If you might use Starboard again: keep the folder as it is. To start Starboard again later, run
docker compose up -din it, ordocker compose -f compose.image.yaml up -dfor the ready-made image. - If you want it out of the way: move the whole folder somewhere else, such as an external disk or a folder for old things. It holds your API keys, so keep it somewhere private.
- Only when you are sure you will never want the settings again, delete the folder. This cannot be undone.
Things to note
- Removing Starboard does not touch your media apps, your films and series, or anything Starboard installed for you with Install apps. Those keep running.
- Docker keeps a copy of Starboard's image, which takes some disk space. Removing it is optional. For the installer it
is called
starboard:local; for the ready-made image,ghcr.io/themightytrex/starboard. Remove it withdocker image rmand the name.
Find out more
This page on GitHub, where the help is written.