Skip to main content

​
Licensing

To utilize any of the plugins within this bundle, you must first obtain a license key. You can acquire a license key by purchasing the Spotify Plugins for Backstage either directly through our sales team or through AWS Marketplace.

​
License Key Setup

Add the following code to your app-config.yaml for your Backstage instance, replacing <your_license_key_here> with your actual license key:

​
License Key Validation

To enable online license key validation, verify that your Backstage instance can access backstage-api.spotify.com. You can use a tool like NetCat to check the connection:

​
Plugins Setup

With your license key in place, you can continue on to the individual plugin guides. Please refer to the specific documentation for the plugin you wish to install:

​
Upgrading Backstage

Each plugin release corresponds to a specific Backstage open-source version. We encourage all customers to upgrade their Backstage instance to the latest version alongside their Spotify Plugins for Backstage upgrades. Check the release notes to find the compatible Backstage version for each release. If your Backstage version is behind, you can use the Backstage Upgrade Helper to ensure you’ve incorporated all required changes during the upgrade process.

​
Upgrading the Plugins

Just like with Backstage itself, we highly recommend you stay on the latest version of the plugins. Thankfully this follows the same process, you can simply run the version:bump command like this:
This will bump all the related plugin packages for you. As you are doing this, you’ll also want to check the release notes to see if there are any manual changes needed.

​
Feedback and Support

We’re constantly improving this documentation to make your experience even better. If you have questions, feedback, or encounter any issues, please feel free to reach out to us. Thank you for choosing Spotify Plugins for Backstage. We hope this resource helps you make the most of Backstage’s capabilities and elevate your developer experience. Happy exploring!