Skip to main content

Documentation Index

Fetch the complete documentation index at: https://backstage.spotify.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

The Explore tab on the Plugin Settings page features a curated collection of community and partner plugins that Portal recommends to enhance your experience. Browse the available plugins and click Install on any plugin card to begin the installation.
The Explore tab showing a curated collection of community and partner plugins

​
Install by Package Name

  1. From the Plugin Settings page, click Add plugin in the top right
The Add plugin button on the Plugin Settings page
  1. In the install dialog, enter the npm package name of the plugin you want to install. If your plugin has multiple packages (for example, a frontend and a backend package), add each package name on a separate line
If this is your first time installing a plugin, you will be asked to accept a consent disclaimer acknowledging that installed packages have access to Portal data and configuration. This prompt only appears once.
Install dialog with package name inputs
You can paste multiple package names at once — Portal will automatically split them into separate entries.To install a specific version, append @ followed by the version number to the package name (e.g., @backstage/plugin-example@1.2.3). If no version is specified, the latest stable version will be installed. See Plugin Versioning for more details on supported version formats.
  1. Click Install to begin the installation
  2. Portal will start a build process. You can monitor progress in the build dialog — see Build Progress for details
  3. Once the build completes successfully, click Finish to return to Plugin Settings
Installation complete with Finish button
A plugin may install successfully but is not guaranteed to work as expected. We recommend manually testing your plugin after installation. Many plugins rely on entity annotations to pull content — if this applies, update your catalog-info.yaml files to include the required annotations.