Outside services

Version 1.1.3 · plug-in API >=1.14 <2.0

PublishedHow to add it
On this page

Outside services: Install

Add Outside services from Starboard's Catalogue, where it is listed under Network. Starboard shows what it may do and tests it before anything is added. At the end, Outside services is active and its card is ready for your dashboard.

Before you begin

  • Starboard with plug-in API 1.14 or later. An older Starboard is offered an earlier version: read Updates.
  • Your Starboard password. Adding and removing a plug-in ask for it.

What it may do

Starboard lists these before you add it, each with its risk.

Permission Risk
Reach other computers on your home network, and the internet (network:lan) Medium

What it runs:

  • main: reaches your home network and the internet, and this computer as host.docker.internal. It can use its own folder in Starboard's data (data/plugins/outside-services).

Like every plug-in, it runs read only, as a user that is not root, with no extra rights. Its image is pinned by digest, so what you approved is what runs.

Memory and processor

  • main: 48 MB of memory and 0.1 of a processor core at most.

These figures are the most it may use.

Add it

  1. Go to Settings, then Plug-ins, then Catalogue.
  2. Under Network, find Outside services and select Install….
  3. A slide-out opens with what it can read, change and reach. Read it all.
  4. Enter your Starboard password and select Install Outside services. To stop, select Cancel: nothing is installed.
  5. Outside services' own tab opens under Settings, then Plug-ins. Select Activate. Its state changes to Active.

Add it by its address

On the Catalogue page, under Add one from elsewhere, paste this into The plug-in's manifest address, then select What it does and carry on from step 3:

https://raw.githubusercontent.com/TheMightyTRex/starboard-plugins/main/outside-services/starboard-plugin.json

Or run its installer, install.py in its folder, on any computer with Python, and give your Starboard's address.

Set it up

  1. Go to Settings, then Plug-ins, then Outside services.
  2. In Addresses to check, enter each address to check, one each, with a name first if you like, such as Router http://192.0.2.1.
  3. Select Save.
  4. In Check every, enter how many minutes between checks, from 1 to 60. The default is 5.
  5. Select Deactivate, then Activate, if you changed Check every.
  6. Add its cards to your dashboard. Read Dashboard card.

Remove it

  1. Go to Settings, then Plug-ins, then Outside services.
  2. Under Remove, select Remove Outside services.
  3. Choose where its folder goes: Keep it with Starboard's data (in data/plugins/.removed) or Move it to the holding folder, listed in System, Clean up, where you can put it back or delete it for good.
  4. Enter your Starboard password and select Remove.

Its containers stop and go, and its API key stops working. Nothing is deleted.

To stop it for a while instead, select Deactivate on its tab: its settings and folder are kept.

Find out more

This page on GitHub, where the help is written.