On this page

How-to

Install Starboard with the installer

The installer asks what Starboard may access on your computer, then builds and starts it. At the end it shows the addresses to open Starboard and a one-time setup code for choosing your password. It takes about 10 minutes.

Most people use the Run first script instead. It installs Docker and everything else, then runs this installer for you. Use this page to do it by hand.

Before you begin

Steps

  1. Install git, the tool that downloads Starboard and later updates it. It asks for your password:
sudo apt install git
  1. Go to your home folder:
cd ~
  1. Download Starboard. This makes a folder called starboard in your home folder:
git clone https://github.com/TheMightyTRex/starboard.git
  1. Go into the new folder:
cd starboard
  1. Start the installer:
./install.sh

It says what it is going to do, checks that Docker is installed, then asks its questions one at a time. 6. Answer each question: enter the number of your answer and press Enter. Press Enter on its own to take the recommended answer. When you run the installer again, your last answer is the default instead. 7. Wait while the installer builds and starts Starboard. The first time, this can take several minutes. 8. When it finishes, the installer shows the addresses and the setup code. Keep the terminal open, or write the code down. 9. Open the first address in a browser on this computer and choose your password. Read Create your password and sign in.

The questions, in plain words

Every question is optional. If you are unsure, answer no: only that part of Starboard is missing, and you can change your answer later. On a new install it asks only about your home network, Docker access and, when the computer has more than one extra disk, Disk pools. When you run it again, it also asks about each app's use, a Live TV folder, folders to show and disk health.

What the installer asks, and what each answer means explains every question. Your dashboard's name, media folder, apps and alerts come next, in Starboard's own set-up, in the browser or the terminal.

What it prints at the end

When Starboard is running, the installer shows Open Starboard with these lines:

  • On this computer: the address to use in a browser on the server itself, such as http://localhost:8095.
  • On other devices: the address for every other device at home, such as http://192.168.1.20:8095. It appears only if you let your home network open Starboard.
  • Setup code: the one-time code you enter before choosing a password. If you lose it, read Find the setup code.
  • Ask again and Update: the commands to change your answers and to update Starboard.

Things to note

  • Your answers are saved in two files in the Starboard folder: .env and compose.access.yaml. Your settings and password are kept in the data folder. None of them leave your computer.
  • To change your answers later, run ./install.sh again in the Starboard folder. Your settings and password stay. Read Change what Starboard can access.
  • No browser to finish in? Run ./install.sh --terminal. Read Set up Starboard in the terminal, with no browser.
  • Without Docker, the installer can run Starboard with the computer's own Python: ./install.sh --native. This needs Python 3.10 or newer. At the end, it shows one more command to run so Starboard keeps running after you sign out.

If it does not work

Each time the installer stops, it shows an error number, such as "Error IN-07". Find it in Run first and installer error numbers. The most common are:

  • IN-05, IN-07 or IN-08: git, Docker or Docker Compose is missing. Read IN-07.
  • IN-04: you put sudo in front of the installer. Run ./install.sh on its own.
  • IN-22: you have not signed out and back in since installing Docker. Read IN-22.
  • IN-24: Starboard did not start. Read Starboard does not open.

Find out more

This page on GitHub, where the help is written.