On this page

Guide

Add your first plug-in

For anyone who has Starboard running and wants to add something from the collection. At the end, the plug-in is active and its card is on your dashboard. It takes about five minutes.

Before you begin

  • Starboard 0.18.0 or later, with plug-in API 1.14. An older Starboard is offered each plug-in's version before. Library clean-up needs Starboard 0.19.0 or later, with plug-in API 1.15.
  • Your Starboard password.
  • For a plug-in that works with Jellyfin, Jellyfin added in Settings, then Apps.

The steps at a glance

  1. Choose a plug-in.
  2. Read what it may do.
  3. Install it.
  4. Set it up and activate it.
  5. Add its card to your dashboard.
Add your first plug-in
Flow chart: Choose a plug-in. The same chart is written out in words after it.YesNoYesNoChoose a plug-inIn the catalogue or thishelpRead what it may doIts permissions andmemoryHappy with what it maydo?Install itEnter your StarboardpasswordDoes its tab say Needssetting up?Fill in its settingsActivate itAdd its card to yourdashboardLeave it outNothing is installed
The chart in words

Start: Choose a plug-in (In the catalogue or this help)

  • Then: Read what it may do (Its permissions and memory)
    • Then: Happy with what it may do?
      • Yes: Install it (Enter your Starboard password)
        • Then: Does its tab say Needs setting up?
          • Yes: Fill in its settings
            • Then: Activate it
              • Then: Add its card to your dashboard
          • No: go to Activate it
      • No: Leave it out (Nothing is installed)

Step 1: Choose a plug-in

Read Choose the plug-ins for your server, or go to Settings, then Plug-ins, then Catalogue in Starboard. A first plug-in that asks for little is Disk forecast: it only reads your disks.

Step 2: Read what it may do

Each plug-in's Install page lists what it may do and the most memory it may use, such as Disk forecast's. Starboard shows the same list before you add it.

Step 3: Install it

In the Catalogue, select Install… next to the plug-in, read the slide-out, enter your Starboard password and select Install and its name. Its own tab opens. You know it worked when the tab shows its state.

Step 4: Set it up and activate it

If the tab says Needs setting up, select Finish setting up and fill in what it asks for. Then select Activate. You know it worked when its state says Active.

Step 5: Add its card to your dashboard

Select Edit dashboard, choose its card in Add a card, then select Save. Not every plug-in has a card: each plug-in's Dashboard card page says.

What next

This page on GitHub, where the help is written.