Skip to main content

Air-Gapped Plugin Installation

In air-gapped or network-restricted environments, your Backstage may not be able to reach the public npm registry to install SKE plugins directly. If so, you will need to install the plugins in two steps:

  1. Publish the plugins to an internal registry that your Backstage instance can reach.
  2. Follow the standard installation and configuration steps.

Spotify Portal for Backstage​

When using Spotify Portal for Backstage, publish the plugins to your Portal instance.

Custom plugin publishing

Spotify is moving Spotify Portal instances to a new plugin model, in which you publish custom plugins from your own Backstage workspace with portal-cli. The steps below are for Spotify's previous plugin installer. If your instance shows a Custom Plugins tab under Admin → Plugin Settings, they do not apply: contact Syntasso support for how to install the SKE plugins.

Before you start, contact Spotify to request a token that lets you publish plugins to your Portal instance.

Download the frontend plugin:

npm pack @syntasso/plugin-ske-frontend@0.22.0

This downloads the specified version of the plugin as a .tgz file in the current directory.

Repeat for the backend plugin:

npm pack @syntasso/plugin-ske-backend@0.24.0

Set the token you received from Spotify in your environment:

export PORTAL_PUBLISHING_TOKEN=<PORTAL_PUBLISHING_TOKEN>

Configure npm to authenticate against your Portal registry:

npm config set //<COMPANY>.spotifyportal.com/api/plugin-installer/registry/:_authToken=$PORTAL_PUBLISHING_TOKEN

Publish each plugin to your Portal instance, replacing <VERSION> with the version printed by npm pack:

npm publish syntasso-plugin-ske-frontend-<VERSION>.tgz --registry https://<COMPANY>.spotifyportal.com/api/plugin-installer/registry/npm
npm publish syntasso-plugin-ske-backend-<VERSION>.tgz --registry https://<COMPANY>.spotifyportal.com/api/plugin-installer/registry/npm

The --registry flag makes npm publish to your Portal instance, even if the plugin's package.json names a different registry.