On this page

How-to

Change what Starboard can access

Starboard lists everything it can reach, says whether each is active, and how to change it. Some are switches in Starboard. Others you change by running the installer again, which keeps your settings and password.

Before you begin

Check what Starboard can access now

  1. Go to Settings, then Updates.
  2. Select the What Starboard can access tab.

Each row names one kind of access, says what it is for and what it costs your server, and shows whether it is active. Each row also shows how to change it: a switch, a button such as Change it, or a command to run on the server.

Change a switch in Starboard

These apply at once:

  • Your home network: go to Settings, then Security, and activate or deactivate Phones and other computers on your home network. Read Choose who can open Starboard.
  • Your apps: add, change or remove apps and their API keys in Settings, Apps, Manage apps. The row's Manage apps button goes there. Read Change or remove an app.
  • The dashboard-icons collection, for app icons and Posters on Coming up: use the switch in the row.
  • GitHub, for new Starboard versions: use Check GitHub for new releases, under Updates on the same page.
  • Pausing and resuming downloads, Watching in the background and alerts, and the Jellyfin and Audiobookshelf extras: select Change it in the row to go to the page with the switch.

Change access with the installer

These need a change on the server: Docker for app updates, per-app processor and memory use, Jellyfin's Live TV folder, your folders for free space, and Disk health reports.

  1. On the server, go to the Starboard folder:
cd ~/starboard
  1. Run the installer again:
./install.sh
  1. Answer the questions. Each one shows your last answer as the default, so press Enter to keep it. Read What the installer asks for what each question means.
  2. Wait for "Starboard is running". Starboard restarts with the new access. Your settings and password stay.

On What Starboard can access, each row that needs the installer also shows the exact command, such as ./install.sh --no-docker, with a copy button. Running that command changes that one answer straight away and asks the other questions as usual.

If you used the ready-made image

The ready-made image has no installer. Instead, you change the Compose file.

  1. On the server, go to the folder that holds compose.image.yaml:
cd ~/starboard
  1. Open the Compose file in the text editor nano:
nano compose.image.yaml
  1. To activate an extra, remove the # and the space after it at the start of its line. To deactivate it, put the # back. Each extra has a comment that explains it.
  2. Save with Ctrl and O, then Enter. Leave nano with Ctrl and X.
  3. Start Starboard again with the new file:
docker compose -f compose.image.yaml up -d

The set-up helper

The installer also starts a small background service, the set-up helper, so nothing needs setting up outside Starboard. When the set-up in the browser starts your apps, or you select Make the change now at its end, the helper runs the installer on the server for you, and the browser shows how it goes.

  • It runs as your user, never as root, and runs only the installer with the set-up's own answers.
  • It cannot use sudo. When a change needs the server's password, such as disk health, the browser shows the one command to run.
  • To stop it, run ./install.sh --no-starter in the Starboard folder. It then stays off, updates included, until you run ./install.sh --starter.
  • A server set up before Starboard 0.16.0 gets it with its next update.

Things to note

  • Every kind of access is optional. If you say no, only that part of Starboard is missing, and its page says what it needs.
  • Docker access gives Starboard full control of Docker, which is the same as full control of the computer. Activate it only if you want Starboard to update your other apps.
  • If you deactivate Disk health, the job on the server stays installed. The installer prints the command that removes it: sudo deploy/install-smart.sh --remove.
  • Folders and disks you set up by hand in compose.override.yaml are left alone by the installer.
  • A backup job on the server is set up by hand. The README in Starboard's folder explains how.

Find out more

This page on GitHub, where the help is written.