Proberaum for Backstage

Config viewer

Lets admins read the (full) frontend and, optionally, the backend configuration of their Backstage instance.

Feature completeFeature complete, permission support might follow

Overview

A small Backstage plugin that allows admins read their (full) frontend, and optional backend configuration.

Screenshot of the Config viewer plugin

Packages

@proberaum/backstage-plugin-config-viewer-backend

Backend pluginnpm v0.13.0source

Installation

Terminal
# From your Backstage root directory
yarn --cwd packages/backend add @proberaum/backstage-plugin-config-viewer-backend
packages/backend/src/index.ts
const backend = createBackend();
// ...
backend.add(import('@proberaum/backstage-plugin-config-viewer-backend'));
README

This plugin backend was templated using the Backstage CLI. You should replace this text with a description of your plugin backend.

Installation

This plugin is installed via the @proberaum/backstage-plugin-config-viewer-backend package. To install it to your backend package, run the following command:

Terminal window
# From your root directory
yarn --cwd packages/backend add @proberaum/backstage-plugin-config-viewer-backend

Then add the plugin to your backend in packages/backend/src/index.ts:

const backend = createBackend();
// ...
backend.add(import('@proberaum/backstage-plugin-config-viewer-backend'));

Development

This plugin backend can be started in a standalone mode from directly in this package with yarn start. It is a limited setup that is most convenient when developing the plugin backend itself.

If you want to run the entire project, including the frontend, run yarn start from the root directory.