Edit

Configuring App with plugins

Adding existing plugins to your app

The following steps assume that you have created a new Backstage app and want to add an existing plugin to it. We are using the CircleCI plugin in this example.

1. Add the plugin's npm package to the repo:

yarn add @backstage/plugin-circleci

2. Add the plugin itself:

// packages/app/src/plugins.ts
export { plugin as Circleci } from '@backstage/plugin-circleci';

3. Register the plugin router:

// packages/app/src/components/catalog/EntityPage.tsx

import { Router as CircleCIRouter } from '@backstage/plugin-circleci';

// Then somewhere inside <EntityPageLayout>
<EntityPageLayout.Content
  path="/ci-cd/*"
  title="CI/CD"
  element={<CircleCIRouter />}
/>;

Note that stand-alone plugins that are not "attached" to the Software Catalog would be added outside the EntityPage.

4. [Optional] Add proxy config:

// app-config.yaml
proxy:
  '/circleci/api':
    target: https://circleci.com/api/v1.1
    headers:
      Circle-Token:
        $env: CIRCLECI_AUTH_TOKEN

Adding a plugin page to the Sidebar

In a standard Backstage app created with @backstage/create-app, the sidebar is managed inside packages/app/src/sidebar.tsx. The file exports the entire Sidebar element of your app, which you can extend with additional entries by adding new SidebarItem elements.

For example, if you install the api-docs plugin, a matching SidebarItem could be something like this:

// Import icon from MUI
import ExtensionIcon from '@material-ui/icons/Extension';

// ... inside the AppSidebar component
<SidebarItem icon={ExtensionIcon} to="api-docs" text="APIs" />;

You can also use your own SVGs directly as icon components. Just make sure they are sized according to the Material UI's SvgIcon default of 24x24px, and set the extension to .icon.svg. For example:

import InternalToolIcon from './internal-tool.icon.svg';