On this page

How Starboard keeps your server safe

Starboard runs a server that other devices in your home can reach, so it is built to be safe by default. Here is what protects you, what Starboard can and cannot do on your computer, and the few choices that are yours.

Your password

  • Starboard has one password, at least 10 characters long. It is stored only as a hash (PBKDF2-SHA256 with 600,000 rounds), so the password itself is never kept.
  • Choosing the first password needs the one-time setup code the installer prints, so nobody else on your network can claim a new server before you.
  • Five wrong attempts lock that address out for 15 minutes.
  • Without Remember me, you are signed out when the browser closes, or after a day.
  • Changes that affect the computer itself, such as starting apps, changing your install or erasing a disk, ask for the password again. So does Sign out everywhere.

Your keys and settings

  • API keys stay on the server, in data/config.json, which only your user can read. They are never sent to the browser.
  • Passwords Starboard makes up for your apps (databases, NZBGet, SABnzbd) stay in data/stack/.env, which only your user can read.
  • Starboard's own API keys only read. Each is shown once, kept only as a hash and accepted only in a header. No key can change network access, the sign-in cookie, how long sign-ins last or where alerts go. Read Make an API key and use Starboard's API.
  • Starboard never sends your settings anywhere.

What Starboard can do on your computer

  • Starboard runs as your user, in a read-only container with every Linux capability dropped. It never runs as root.
  • Each kind of access is optional and asked for by the installer: your home network, Docker (for app updates and starting apps), each app's memory use, folders for the Storage page, and Disk health. Say no and only that part is missing. What the installer asks explains each one.
  • Docker access is as powerful as the root account, so it is inactive unless you say yes.
  • Install apps starts only the apps on its own list, with folders it has checked (never a system folder or a whole home folder). Before the apps start, the Run first window and the installer check the set-up file again with the same rules, so a changed file cannot start anything else.
  • Disks are changed only by a small helper you install yourself, which accepts a fixed list of actions, checks every change first and asks for the last characters of a disk's serial number before erasing it.

In the browser

  • Sign-in cookies cannot be read by scripts and are sent only by Starboard's own pages. Every change also needs a header that only Starboard's pages send, from Starboard's own address.
  • A strict content security policy: no scripts from anywhere else, and nothing loaded from other sites except cover pictures.

The choices that are yours

  • Who can open Starboard. Other devices on your home network can open it unless you choose this computer only. Read Choose who can open Starboard.
  • Away from home. Never forward Starboard's port straight to the internet. Use a VPN or a reverse proxy with HTTPS. Read Use Starboard away from home safely.
  • Downloads through a VPN. Every install sends torrents and Usenet through a VPN, Gluetun, so your internet provider can tell only that you use a VPN. You can choose to go without one, after a warning: read Download without a VPN.

How it is tested

Every release is checked with six free security scanners and a review of the code, and the results are published with the release. Read Security: how Starboard protects you, and how it was tested, or report a problem privately as SECURITY.md explains.

Find out more

This page on GitHub, where the help is written.