Skip to content
TheMightyTRexPublic

About

An accessible, lightweight dashboard for a home media server: Starboard and Reelix with Jellyfin, downloads, plug-ins and more.

Topics

Resources

Security policy

Stars

2 stars

Watchers

0 watching

Forks

Latest commit

 

History

828 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Starboard

A complete media server, set up from one place, light enough for an old laptop or a Raspberry Pi.

Starboard installs and runs a whole home media server: the apps that find, download and sort your films, series, music, books and audiobooks, the apps that play them, and the server underneath, from one accessible dashboard. Everything is explained in plain steps in the help centre, which has a search.

Quick start

Starboard runs on four Linux systems, in the version named or any later one:

System Minimum Recommended Step by step
Linux Mint 22.3 (recommended) 2 cores, 4 GB of memory, 40 GB disk 4 cores, 8 GB, 120 GB SSD Start Starboard on Linux Mint
Debian 13 2 cores, 2 GB, 20 GB 4 cores, 4 GB or more, 64 GB SSD Start Starboard on Debian
Ubuntu Server 26.04 LTS 2 cores, 3 GB, 20 GB 4 cores, 8 GB, 64 GB SSD Start Starboard on Ubuntu Server
Raspberry Pi OS (64-bit), Trixie Raspberry Pi 4 with 4 GB Raspberry Pi 5 with 8 GB, on an SSD Start Starboard on Raspberry Pi OS

The figures are for a whole media server. Keep your media on a separate drive. More in What you need to run Starboard.

Start with the Run first script. On one of these systems, with or without a desktop, open a terminal and run:

curl -fsSL https://raw.githubusercontent.com/TheMightyTRex/starboard/main/run-first.sh | bash

If it says "Command 'curl' not found" (a new Debian does not include curl), use wget, which every system here includes. Do not use the sudo snap install curl Ubuntu suggests: the snap version cannot save the files the script needs.

wget -qO- https://raw.githubusercontent.com/TheMightyTRex/starboard/main/run-first.sh | bash

Entering it by hand? Enter it exactly: everything after TheMightyTRex/starboard/ is case-sensitive, so main/run-first.sh must be in small letters with a hyphen, or GitHub answers 404 (not found). The | (vertical bar) is in different places on different keyboards: on a UK keyboard it is Shift and the \ key next to the left Shift, not the ¦ key. The help has where each symbol is on US, UK, German, French and Spanish keyboards. Or use these two commands, which have no |:

curl -fsSL -o run-first.sh https://raw.githubusercontent.com/TheMightyTRex/starboard/main/run-first.sh
bash run-first.sh

It checks the computer, installs Docker and anything else missing after you say yes, downloads Starboard and starts its installer. Enter a at its first question for accessible mode, which carries on through the whole installation.

With a desktop: set up in the browser. When the installer finishes, the set-up page opens in your browser by itself, with the setup code filled in.

With no desktop: set up in the terminal. On the server, or connected to it over SSH, the script finds there is no desktop and asks every set-up question in the terminal instead: your password, your apps and your download hours. To choose the terminal yourself:

curl -fsSL https://raw.githubusercontent.com/TheMightyTRex/starboard/main/run-first.sh | bash -s -- --terminal

The Run first script's welcome page in a terminal, offering to finish setting up in a browser or in the terminal

Starting from a bare computer? Follow the step-by-step guide, Get Starboard up and running, from a bare computer. It starts with installing Linux, then takes you through either path step by step. Check what you need to run Starboard first. Already have Docker and git? git clone https://github.com/TheMightyTRex/starboard.git && cd starboard && ./install.sh (add --terminal for the terminal set-up).

In the help centre: Quick start guide · From a bare computer · What you need · The Run first script · Set up in the terminal

What Starboard does

  • One set-up, complete. It asks what you want (films, series, music, books, audiobooks, live TV), picks the apps, folders and settings, checks every step, starts the apps and connects them to each other, in a browser or entirely in the terminal.
  • One dashboard. Every app's status, your library from Reelix, one search that checks your library first, downloads, what is coming up, requests, storage, disk health, alerts and backups.
  • Lightweight first. Starboard idles in about 16 MB of memory and almost no processor time, and every piece of background work can be paused or slowed.
  • Accessible to everyone. Built to WCAG 2.2 AA: keyboard first, screen readers, text up to 175%, high contrast, and a plain terminal mode for software that reads text aloud.
  • Works with what you have. It finds the media apps already on your server and adds them, and runs on 64-bit Intel, AMD and ARM, such as a Raspberry Pi 4 or 5.
Apps, in the Health first design: each app with its status System, Storage: the pool by type, with free space
Apps, with problems first Storage, by type
Install apps, What to set up: Basics (recommended), Full install or Everything The terminal set-up at 80 by 24, step 2 of 10, How to start
Install apps in the browser The terminal set-up

In the help centre: Everything Starboard does · What Starboard is · Set up your dashboard · Display and accessibility

Your library

The Library shows everything Reelix holds: TV, films, music, radio, books and audiobooks, each as a wall of covers with an A to Z list, filters and its own page for each title, with episodes, albums or reading order. Search checks your library first as you enter words, then lists what Reelix can add, with Add, or Follow for radio. Starboard keeps a small list of each kind and reads Reelix again only while you use the Library, so it stays light on small servers.

The Films wall with example data: covers A to Z, the letter row, filters, sort and cover size A series page with example data: its name, progress, and the episodes with their status
The Library, A to Z A series, with its episodes
Search with example data: In your library first, then Not in your library with Add The Books wall on a phone, in the dark theme, with example data
Search, your library first On a phone, dark theme

In the help centre: Browse your library · Search for and add films, series, music and books · Follow radio shows and podcasts

The three installs

Install apps sets up a complete media server in one of three installs, or the apps you choose yourself. Every install sends downloads through a VPN, and apps that need another app bring it with them.

Basics Full install Everything
For Most homes: complete and light Statistics, logs and smaller files Every app Starboard offers
Reelix Reelix Lite With YouTube and Spotify downloads With YouTube and Spotify downloads
Apps Reelix, Jellyfin, Audiobookshelf, Bazarr, qBittorrent, NZBGet, Gluetun Basics, plus Jellystat, Dozzle, FlareSolverr, Tdarr and disk health (Wizarr and Dispatcharr are add-ons); SABnzbd in place of NZBGet if you choose Full install, plus Kapowarr
Memory when idle about 0.6 to 1.6 GB about 1.1 to 2.6 GB about 1.9 to 3.4 GB
Recommended computer 4 cores, 4 GB, or a Raspberry Pi 5 4 cores, 8 GB 4 or more cores, 8 GB or more

Change it later, either way, in Settings, Apps, Your install.

In the help centre: What each install has · Install apps with Starboard · Change your install

Reelix

Reelix is one app that finds, downloads and sorts films, series, music and books, and takes requests: the work of Radarr, Sonarr, Lidarr, Readarr, Prowlarr and Seerr, in under 40 MB of memory. Starboard installs it, sets it up through its own API (admin account, a key for Starboard, library folders and download apps) and shows it like any other app. Basics uses Reelix Lite; Full install and Everything use Reelix with YouTube and Spotify downloads, and you can switch either way. Reelix is a separate project with its own licence (GPL-3.0); Starboard talks to it through its API only.

In the help centre: What Reelix is · Switch between the two versions · Move from Radarr, Sonarr and the others

Install

Three ways, with the fewest steps first:

  1. The Run first script (in Quick start): checks the computer, installs what is missing, downloads Starboard and starts the set-up.

  2. The installer, if you already have Docker with the Compose plugin and git:

    git clone https://github.com/TheMightyTRex/starboard.git
    cd starboard
    ./install.sh

    It explains each step and asks before giving Starboard any access to your computer. Every kind of access is optional. Add --terminal for the terminal set-up, or --native to run without Docker.

  3. The ready-made image, for amd64, arm64 and 32-bit arm: download compose.image.yaml, then mkdir -p data && docker compose -f compose.image.yaml up -d, and open http://<your server>:8095.

Update with ./update.sh: it backs up your settings, installs the newest release, and goes back to the version you had if the new one does not start.

In the help centre: Install with the installer · What the installer asks · The ready-made image · Update Starboard · Remove Starboard

Security

  • One password, stored only as a hash, with the installer's one-time setup code for the first one. Five wrong attempts lock an address out for 15 minutes, and changes to the computer ask for the password again.
  • Your keys stay on the server, readable by your user only, and are never sent to the browser.
  • Only the access you allow. Starboard runs as your user in a read-only container with no extra privileges. Docker access, folders, disk health and drive pools are each optional and asked for by the installer.
  • Apps from its own list only. Install apps starts only the apps it offers, with checked folders, and the set-up file is checked again before anything starts.
  • Home network by default, never the open internet. Use a VPN or a reverse proxy with HTTPS to reach it from away.

Report a problem privately as the security policy explains. How it was reviewed and tested: Security: how Starboard protects you, and how it was tested.

In the help centre: How Starboard keeps your server safe · Choose who can open Starboard · Use Starboard away from home

Develop, credits and licence

How to run it from a checkout, test it and keep your details out of the repository: Develop Starboard. The help centre is built from docs/help by the design system's help centre builder, with the settings in help-centre.json.

Pillow, Lucide, Atkinson Hyperlegible Next and the data sources Starboard uses are listed, with their licences, in THIRD-PARTY.md. Starboard is MIT licensed, by TheMightyTRexUK and contributors. Atkinson Hyperlegible Next is under the SIL Open Font Licence (web/fonts/LICENSE-OFL.txt); icons are from Lucide, under the ISC licence (tools/LICENSE-lucide.txt).


Download only what you have the right to. Use the download apps only for files you have the right to download, such as open-source software, works in the public domain and your own backups. Downloading films, series, music or books without the copyright holder's permission is against the law in the UK and most other countries. Starboard does not host or provide any files, and you are responsible for what you download.

About

An accessible, lightweight dashboard for a home media server: Starboard and Reelix with Jellyfin, downloads, plug-ins and more.

Topics

Resources

Security policy

Stars

2 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages