On this page

How-to

Search for apps already on your server

Search for new apps finds apps running on the same computer as Starboard and adds the ones you tick. You do not need to enter each address, and with Docker access Starboard can fill in API keys too.

Before you begin

  • The apps are running on the same computer as Starboard. Apps on other computers are not found: add those with Add an app.
  • Optional: Docker access lets Starboard find apps on unusual ports and read their API keys. Read Change access with the installer.

Steps

  1. Go to Settings, then Apps, then Manage apps.
  2. Select Search for new apps. A side panel opens, and Starboard searches for apps.
  3. Read the list. Each app shows its address and whether it needs an API key. Every app starts ticked.
  4. Untick any app you do not want on your dashboard.
  5. If Fill in API keys for me is shown, leave it ticked to have Starboard read each key from the app's own settings file.
  6. Select Add the ticked apps. Starboard adds them to Manage apps and closes the panel.
  7. If Starboard says some apps still need their API keys, select Edit for each one and paste its key. Read Find an app's API key.

Things to note

  • Starboard searches only when you select Search for new apps. Nothing runs in the background.
  • It tries the usual port of each app it knows, such as 8096 for Jellyfin. With Docker access it also tries every port a container makes available.
  • Apps already in Manage apps are left out. If everything is there, Starboard shows Nothing new found.
  • Fill in API keys for me works for Sonarr, Radarr, Lidarr, Readarr, Prowlarr, SABnzbd and Seerr. The keys stay on the server.
  • Without Docker access, the panel says what Docker access would add.
  • Apps are saved with 127.0.0.1 and their port. They still open from a phone, because Starboard swaps in the address you opened Starboard with.
  • Each app is put in a category for you. Read Organise apps into categories to move it.

If it does not work

  • An app is missing from the list: it may run on a port Starboard does not expect. Add it with Add an app, or give Starboard Docker access and search again.
  • Could not check this computer for apps: Starboard could not finish the search. Reload the page and try again. If it happens again, read Report a problem.

Find out more

This page on GitHub, where the help is written.