On this page

How-to

Install Starboard from the ready-made image

With the ready-made image, Docker downloads Starboard already built, so there is nothing to build and no questions to answer. At the end, Starboard is running and you have the setup code for choosing your password.

Before you begin

Steps

  1. Make a folder for Starboard in your home folder:
mkdir ~/starboard
  1. Go into it:
cd ~/starboard
  1. Download Starboard's Compose file, the list that tells Docker how to run it:
curl -fsSLO https://raw.githubusercontent.com/TheMightyTRex/starboard/main/compose.image.yaml
  1. Make the data folder, where Starboard keeps its settings. Making it yourself, before Starboard starts, means the folder belongs to you:
mkdir -p data
  1. Check your user number. This command prints it, usually 1000:
id -u
  1. Check your group number, also usually 1000:
id -g
  1. If both are 1000, go to Step 8. If not, or if you want to set your time zone, change the Compose file. Open it in the text editor nano:
nano compose.image.yaml
  • On the line user: "1000:1000", put your user number, a colon, then your group number.
  • On the line - TZ=Europe/London, put your own time zone, such as Europe/Dublin or America/New_York. Download hours follow it.
  • To save, press Ctrl and O, then Enter. To leave nano, press Ctrl and X.
  1. Start Starboard. Docker downloads the image, which takes a minute or two the first time:
docker compose -f compose.image.yaml up -d

When the prompt comes back, Starboard is running.

  1. Show Starboard's log, which holds the setup code:
docker logs starboard

Find the line "No password yet. Open the dashboard and enter this setup code:". The code is at the end of it.

  1. In a browser on this computer, open http://localhost:8095. Enter the setup code and choose your password. Read Create your password and sign in.

Optional extras

The Compose file has some extra lines that start with #, which means they are inactive. Each has a comment that explains it. To activate one, follow If you used the ready-made image.

  • Folders for System, Storage: shows how full your disks are. You need two lines: the STARBOARD_DISKS line, and one line for each folder under volumes, such as /mnt/media:/disks/media:ro. The :ro means read-only.
  • The Docker socket: lets System, Apps, Updates update your other apps, and lets Starboard find their API keys. This gives Starboard full control of Docker, which is the same as full control of the computer. Leave it out if you are unsure. It needs three lines: the docker.sock line, and the group_add: line with the number under it. Put your own number there. This command prints it:
stat -c %g /var/run/docker.sock

Things to note

  • The ready-made image asks no questions. Phones and other computers on your home network can open Starboard straight away, with your password. To change that, read Choose who can open Starboard.
  • Every command for this kind of install includes -f compose.image.yaml, and runs in the folder that holds that file. Without it, Docker does not know which Compose file you mean.
  • Your settings, sessions and API keys stay in the data folder. Keep it when you update or remove Starboard.

If it does not work

  • "permission denied" when you run a docker command: you have not signed out and back in since installing Docker. Sign out, sign in and try again.
  • "no configuration file provided" or "no such file": you are not in the Starboard folder. Run cd ~/starboard first.
  • Starboard stops straight after it starts, or the log says it cannot write to /data: the data folder belongs to another user, or the numbers on the user: line are not yours. Check Steps 4 to 7.
  • No setup code in the log: a password has already been chosen. If you have forgotten it, read Reset a forgotten password.

Find out more

This page on GitHub, where the help is written.