On this page

Reference

What the installer asks, and what each answer means

./install.sh explains each step before it runs it, and asks before giving Starboard any access to your computer. Every kind of access is optional: say no, and only that part of Starboard is missing. Run ./install.sh again at any time to change your answers. Your settings and password stay.

What the installer does, in order

  1. Checks what is installed: Docker and Docker Compose, or Python and systemd with --native. It changes nothing.
  2. Asks what Starboard may access (the table in the next section).
  3. Saves your answers in .env (only your user can read it) and compose.access.yaml. Git ignores both.
  4. Builds and starts Starboard with docker compose up -d --build, or as a systemd service for your user with --native. Neither needs sudo.

The access it asks for

A new install asks only the first two questions, plus Set up Disk pools? when the computer has more than one extra disk. The others come when you run the installer again, with your last answers as the defaults. The set-up in the browser or the terminal asks about folders, Live TV and disk health for a new install.

Question What it is for What it means for your computer Recommended when new Change it
Can phones and other computers on your home network open Starboard? Phones and computers at home can open Starboard, with your password Starboard listens on your network, behind your password Yes Settings, Security, or --local-only on a new install
Give Starboard access to Docker for app updates? System, Apps, Updates, and starting the apps that Install apps sets up Docker's socket is shared with Starboard: full control of Docker, so of the computer No --docker, --no-docker
Show each app's processor and memory use? System, Monitor: each app's processor and memory /sys/fs/cgroup is shared read-only; two small files for each app are read while Monitor is open No --app-use, --no-app-use
Give Starboard a Live TV folder? Free Live TV channels and guides for Jellyfin Jellyfin's Live TV folder is shared; Starboard writes playlists, guides and logos there while Live TV is active None --livetv-folder /path, --no-livetv
Choose folders to show? System, Storage: free space. Enter one folder per line, such as Media=/mnt/media, then press Enter on an empty line Each folder is shared read-only; Starboard reads sizes, not files None --disk Name=/path, --no-disks
Set up Disk health reports? System, Disk health: each disk's health report Runs deploy/install-smart.sh with sudo: a timer reads each disk every 30 minutes as root and saves the reports in ./smart No --disk-health, --no-disk-health
Set up Disk pools? System, Pool: join disks into one folder Installs a small helper with sudo that changes disks only from a fixed list of actions, after a check No Answer Set up Disk pools? again

Docker access is what lets Starboard start and update your media apps for you. Answer yes if you want that, and keep your Starboard password safe: anyone who can sign in could then control Docker.

--yes answers without asking: the options you give, then your last answers, then No. To remove the Disk health timer: sudo deploy/install-smart.sh --remove.

Access that is a setting instead

Some access needs nothing from the installer, so it is a setting in Starboard:

  • Your apps (Settings, Apps, Manage apps): Starboard reads status, queues and calendars with the API keys you give it, and adds films, series and books only when you choose Add.
  • Download hours (Settings, Downloads, Download hours): pauses the download apps outside the hours you choose.
  • Updates (Settings, Updates, What Starboard can access): checks for new Starboard releases, at most every 6 hours, and downloads app icons and posters.

Change what Starboard can access shows where Starboard lists all of these, with the setting or command that changes each one.

Your own folders: compose.override.yaml

Keep anything else particular to your server in compose.override.yaml, next to compose.yaml. Git ignores it, and ./install.sh and ./update.sh leave it alone. The installer finds folders added this way and keeps them.

Find out more

This page on GitHub, where the help is written.